Reminix TypeScript SDK - v0.7.1
    Preparing search index...

    Interface paths

    This file was auto-generated by openapi-typescript. Do not make direct changes to the file.

    interface paths {
        "/agents/{name}/chat": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { name: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/json": {
                            context?: {
                                conversation_id?: string;
                                custom?: { [key: string]: unknown };
                                user_id?: string;
                            };
                            messages: {
                                content: | string
                                | { [key: string]: unknown }
                                | { image_url?: ...; text?: ...; type: ... }[];
                                name?: string;
                                role: "assistant" | "system" | "user" | "tool";
                                tool_call_id?: string;
                            }[];
                            stream: boolean;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                message: {
                                    content: unknown;
                                    role: "assistant";
                                    tool_calls?: {
                                        function: { arguments: ...; name: ... };
                                        id: string;
                                        type: "function";
                                    }[];
                                };
                            };
                            "text/event-stream": { chunk: string };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: { "application/json": { error: string } };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: { "application/json": { error: string } };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { error: string } };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { error: string } };
                        headers: { [name: string]: unknown };
                    };
                    "502": {
                        content: { "application/json": { error: string } };
                        headers: { [name: string]: unknown };
                    };
                    "504": {
                        content: { "application/json": { error: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/agents/{name}/invoke": {
            delete?: undefined;
            get?: undefined;
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { name: string };
                    query?: undefined;
                };
                requestBody?: {
                    content: {
                        "application/json": {
                            context?: {
                                conversation_id?: string;
                                custom?: { [key: string]: unknown };
                                user_id?: string;
                            };
                            input: { [key: string]: unknown };
                            stream: boolean;
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": { output?: unknown };
                            "text/event-stream": { chunk: string };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "400": {
                        content: { "application/json": { error: string } };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: { "application/json": { error: string } };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { error: string } };
                        headers: { [name: string]: unknown };
                    };
                    "500": {
                        content: { "application/json": { error: string } };
                        headers: { [name: string]: unknown };
                    };
                    "502": {
                        content: { "application/json": { error: string } };
                        headers: { [name: string]: unknown };
                    };
                    "504": {
                        content: { "application/json": { error: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/project": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                createdAt: string;
                                id: string;
                                name: string;
                                organizationId: string;
                                slug: string;
                                updatedAt: string;
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "401": {
                        content: { "application/json": { error: string } };
                        headers: { [name: string]: unknown };
                    };
                    "404": {
                        content: { "application/json": { error: string } };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
    }
    Index

    Properties

    /agents/{name}/chat /agents/{name}/invoke /project

    Properties

    "/agents/{name}/chat": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { name: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/json": {
                        context?: {
                            conversation_id?: string;
                            custom?: { [key: string]: unknown };
                            user_id?: string;
                        };
                        messages: {
                            content: | string
                            | { [key: string]: unknown }
                            | { image_url?: ...; text?: ...; type: ... }[];
                            name?: string;
                            role: "assistant" | "system" | "user" | "tool";
                            tool_call_id?: string;
                        }[];
                        stream: boolean;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            message: {
                                content: unknown;
                                role: "assistant";
                                tool_calls?: {
                                    function: { arguments: ...; name: ... };
                                    id: string;
                                    type: "function";
                                }[];
                            };
                        };
                        "text/event-stream": { chunk: string };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { error: string } };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { error: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { error: string } };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { error: string } };
                    headers: { [name: string]: unknown };
                };
                "502": {
                    content: { "application/json": { error: string } };
                    headers: { [name: string]: unknown };
                };
                "504": {
                    content: { "application/json": { error: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { name: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/json": {
                      context?: {
                          conversation_id?: string;
                          custom?: { [key: string]: unknown };
                          user_id?: string;
                      };
                      messages: {
                          content: | string
                          | { [key: string]: unknown }
                          | { image_url?: ...; text?: ...; type: ... }[];
                          name?: string;
                          role: "assistant" | "system" | "user" | "tool";
                          tool_call_id?: string;
                      }[];
                      stream: boolean;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          message: {
                              content: unknown;
                              role: "assistant";
                              tool_calls?: {
                                  function: { arguments: ...; name: ... };
                                  id: string;
                                  type: "function";
                              }[];
                          };
                      };
                      "text/event-stream": { chunk: string };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: { "application/json": { error: string } };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: { "application/json": { error: string } };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { error: string } };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { error: string } };
                  headers: { [name: string]: unknown };
              };
              "502": {
                  content: { "application/json": { error: string } };
                  headers: { [name: string]: unknown };
              };
              "504": {
                  content: { "application/json": { error: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Chat with an agent

      Have a conversational interaction with an agent. This endpoint maintains conversation context through the messages array, allowing for multi-turn conversations.

      **Use cases:**
- Customer support chatbots
- AI assistants with memory
- Multi-step question answering
- Conversational agents that need context

**Message format:** Follows OpenAI-compliant message structure with support for:
- `system`, `user`, `assistant`, and `tool` roles
- Multimodal content (text + images)
- Tool/function calling

**Streaming:** Set `stream: true` in the request body to receive Server-Sent Events (SSE)
stream with incremental chunks. Perfect for ChatGPT-like real-time chat interfaces.
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { name: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { name: string }
          • name: string

            Unique, URL-safe agent name within the project

        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/json": {
                    context?: {
                        conversation_id?: string;
                        custom?: { [key: string]: unknown };
                        user_id?: string;
                    };
                    messages: {
                        content: | string
                        | { [key: string]: unknown }
                        | { image_url?: ...; text?: ...; type: ... }[];
                        name?: string;
                        role: "assistant" | "system" | "user" | "tool";
                        tool_call_id?: string;
                    }[];
                    stream: boolean;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        message: {
                            content: unknown;
                            role: "assistant";
                            tool_calls?: {
                                function: { arguments: ...; name: ... };
                                id: string;
                                type: "function";
                            }[];
                        };
                    };
                    "text/event-stream": { chunk: string };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { error: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { error: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { error: string } };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { error: string } };
                headers: { [name: string]: unknown };
            };
            "502": {
                content: { "application/json": { error: string } };
                headers: { [name: string]: unknown };
            };
            "504": {
                content: { "application/json": { error: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      message: {
                          content: unknown;
                          role: "assistant";
                          tool_calls?: {
                              function: { arguments: ...; name: ... };
                              id: string;
                              type: "function";
                          }[];
                      };
                  };
                  "text/event-stream": { chunk: string };
              };
              headers: { [name: string]: unknown };
          }

          Chat response successful

        • 400: {
              content: { "application/json": { error: string } };
              headers: { [name: string]: unknown };
          }

          Bad Request - Invalid request body

        • 401: {
              content: { "application/json": { error: string } };
              headers: { [name: string]: unknown };
          }

          Unauthorized - Invalid or missing API key

        • 404: {
              content: { "application/json": { error: string } };
              headers: { [name: string]: unknown };
          }

          Agent or deployment not found

        • 500: {
              content: { "application/json": { error: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

        • 502: {
              content: { "application/json": { error: string } };
              headers: { [name: string]: unknown };
          }

          Bad Gateway - Unable to reach agent machine

        • 504: {
              content: { "application/json": { error: string } };
              headers: { [name: string]: unknown };
          }

          Gateway Timeout - Agent took too long to respond

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/agents/{name}/invoke": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { name: string };
                query?: undefined;
            };
            requestBody?: {
                content: {
                    "application/json": {
                        context?: {
                            conversation_id?: string;
                            custom?: { [key: string]: unknown };
                            user_id?: string;
                        };
                        input: { [key: string]: unknown };
                        stream: boolean;
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": { output?: unknown };
                        "text/event-stream": { chunk: string };
                    };
                    headers: { [name: string]: unknown };
                };
                "400": {
                    content: { "application/json": { error: string } };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { error: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { error: string } };
                    headers: { [name: string]: unknown };
                };
                "500": {
                    content: { "application/json": { error: string } };
                    headers: { [name: string]: unknown };
                };
                "502": {
                    content: { "application/json": { error: string } };
                    headers: { [name: string]: unknown };
                };
                "504": {
                    content: { "application/json": { error: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • Optionalget?: undefined
    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { name: string };
              query?: undefined;
          };
          requestBody?: {
              content: {
                  "application/json": {
                      context?: {
                          conversation_id?: string;
                          custom?: { [key: string]: unknown };
                          user_id?: string;
                      };
                      input: { [key: string]: unknown };
                      stream: boolean;
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": { output?: unknown };
                      "text/event-stream": { chunk: string };
                  };
                  headers: { [name: string]: unknown };
              };
              "400": {
                  content: { "application/json": { error: string } };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: { "application/json": { error: string } };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { error: string } };
                  headers: { [name: string]: unknown };
              };
              "500": {
                  content: { "application/json": { error: string } };
                  headers: { [name: string]: unknown };
              };
              "502": {
                  content: { "application/json": { error: string } };
                  headers: { [name: string]: unknown };
              };
              "504": {
                  content: { "application/json": { error: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Invoke an agent

      Execute a one-shot task with an agent. This endpoint is designed for task-oriented operations where you provide input and receive a complete output.

      **Use cases:**
- Data analysis and processing
- Content generation (with streaming for long outputs)
- One-time operations that don't require conversation history
- API-like operations

**Streaming:** Set `stream: true` in the request body to receive Server-Sent Events (SSE)
stream with incremental chunks. Useful for long-running tasks or real-time progress updates.
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { name: string };
            query?: undefined;
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { name: string }
          • name: string

            Unique, URL-safe agent name within the project

        • Optionalquery?: undefined
      • OptionalrequestBody?: {
            content: {
                "application/json": {
                    context?: {
                        conversation_id?: string;
                        custom?: { [key: string]: unknown };
                        user_id?: string;
                    };
                    input: { [key: string]: unknown };
                    stream: boolean;
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": { output?: unknown };
                    "text/event-stream": { chunk: string };
                };
                headers: { [name: string]: unknown };
            };
            "400": {
                content: { "application/json": { error: string } };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { error: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { error: string } };
                headers: { [name: string]: unknown };
            };
            "500": {
                content: { "application/json": { error: string } };
                headers: { [name: string]: unknown };
            };
            "502": {
                content: { "application/json": { error: string } };
                headers: { [name: string]: unknown };
            };
            "504": {
                content: { "application/json": { error: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": { output?: unknown };
                  "text/event-stream": { chunk: string };
              };
              headers: { [name: string]: unknown };
          }

          Agent invocation successful

        • 400: {
              content: { "application/json": { error: string } };
              headers: { [name: string]: unknown };
          }

          Bad Request - Invalid request body

        • 401: {
              content: { "application/json": { error: string } };
              headers: { [name: string]: unknown };
          }

          Unauthorized - Invalid or missing API key

        • 404: {
              content: { "application/json": { error: string } };
              headers: { [name: string]: unknown };
          }

          Agent or deployment not found

        • 500: {
              content: { "application/json": { error: string } };
              headers: { [name: string]: unknown };
          }

          Internal Server Error

        • 502: {
              content: { "application/json": { error: string } };
              headers: { [name: string]: unknown };
          }

          Bad Gateway - Unable to reach agent machine

        • 504: {
              content: { "application/json": { error: string } };
              headers: { [name: string]: unknown };
          }

          Gateway Timeout - Agent took too long to respond

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/project": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            createdAt: string;
                            id: string;
                            name: string;
                            organizationId: string;
                            slug: string;
                            updatedAt: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "401": {
                    content: { "application/json": { error: string } };
                    headers: { [name: string]: unknown };
                };
                "404": {
                    content: { "application/json": { error: string } };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          createdAt: string;
                          id: string;
                          name: string;
                          organizationId: string;
                          slug: string;
                          updatedAt: string;
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "401": {
                  content: { "application/json": { error: string } };
                  headers: { [name: string]: unknown };
              };
              "404": {
                  content: { "application/json": { error: string } };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get current project

      Returns the project associated with the API key used for authentication.

      The project contains metadata about your organization's configuration, including:
- Project ID and organization ID
- Project name and slug
- Creation and update timestamps

This endpoint is useful for verifying your API key is valid and retrieving project details.
      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        createdAt: string;
                        id: string;
                        name: string;
                        organizationId: string;
                        slug: string;
                        updatedAt: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "401": {
                content: { "application/json": { error: string } };
                headers: { [name: string]: unknown };
            };
            "404": {
                content: { "application/json": { error: string } };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      createdAt: string;
                      id: string;
                      name: string;
                      organizationId: string;
                      slug: string;
                      updatedAt: string;
                  };
              };
              headers: { [name: string]: unknown };
          }

          Project found

        • 401: {
              content: { "application/json": { error: string } };
              headers: { [name: string]: unknown };
          }

          Unauthorized - Invalid or missing API key

        • 404: {
              content: { "application/json": { error: string } };
              headers: { [name: string]: unknown };
          }

          Project not found

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined

    Settings

    Member Visibility

    On This Page

    Properties