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

    Interface components

    interface components {
        headers: never;
        parameters: never;
        pathItems: never;
        requestBodies: never;
        responses: never;
        schemas: {
            AssistantMessage: {
                content: unknown;
                role: "assistant";
                tool_calls?: {
                    function: { arguments: string; name: string };
                    id: string;
                    type: "function";
                }[];
            };
            AssistantRole: "assistant";
            ChatMessage: {
                content: | string
                | { [key: string]: unknown }
                | {
                    image_url?: { url: string };
                    text?: string;
                    type: "text" | "image_url";
                }[];
                name?: string;
                role: "assistant"
                | "system"
                | "user"
                | "tool";
                tool_call_id?: string;
            };
            ChatMessageRole: "assistant"
            | "system"
            | "user"
            | "tool";
            ChatRequest: {
                context?: {
                    conversation_id?: string;
                    custom?: { [key: string]: unknown };
                    user_id?: string;
                };
                messages: {
                    content: | string
                    | { [key: string]: unknown }
                    | {
                        image_url?: { url: string };
                        text?: string;
                        type: "text" | "image_url";
                    }[];
                    name?: string;
                    role: "assistant"
                    | "system"
                    | "user"
                    | "tool";
                    tool_call_id?: string;
                }[];
                stream: boolean;
            };
            ChatResponse: {
                message: {
                    content: unknown;
                    role: "assistant";
                    tool_calls?: {
                        function: { arguments: string; name: string };
                        id: string;
                        type: "function";
                    }[];
                };
            };
            ContentItem: {
                image_url?: { url: string };
                text?: string;
                type: "text" | "image_url";
            };
            ContentItemType: "text"
            | "image_url";
            Context: {
                conversation_id?: string;
                custom?: { [key: string]: unknown };
                user_id?: string;
            };
            ErrorResponse: { error: string };
            ImageUrl: { url: string };
            InvokeRequest: {
                context?: {
                    conversation_id?: string;
                    custom?: { [key: string]: unknown };
                    user_id?: string;
                };
                input: { [key: string]: unknown };
                stream: boolean;
            };
            InvokeResponse: { output?: unknown };
            Project: {
                createdAt: string;
                id: string;
                name: string;
                organizationId: string;
                slug: string;
                updatedAt: string;
            };
            StreamChunk: { chunk: string };
            ToolCall: {
                function: { arguments: string; name: string };
                id: string;
                type: "function";
            };
            ToolCallFunction: { arguments: string; name: string };
            ToolCallType: "function";
        };
    }
    Index

    Properties

    headers parameters pathItems requestBodies responses schemas

    Properties

    headers: never
    parameters: never
    pathItems: never
    requestBodies: never
    responses: never
    schemas: {
        AssistantMessage: {
            content: unknown;
            role: "assistant";
            tool_calls?: {
                function: { arguments: string; name: string };
                id: string;
                type: "function";
            }[];
        };
        AssistantRole: "assistant";
        ChatMessage: {
            content: | string
            | { [key: string]: unknown }
            | {
                image_url?: { url: string };
                text?: string;
                type: "text" | "image_url";
            }[];
            name?: string;
            role: "assistant"
            | "system"
            | "user"
            | "tool";
            tool_call_id?: string;
        };
        ChatMessageRole: "assistant"
        | "system"
        | "user"
        | "tool";
        ChatRequest: {
            context?: {
                conversation_id?: string;
                custom?: { [key: string]: unknown };
                user_id?: string;
            };
            messages: {
                content: | string
                | { [key: string]: unknown }
                | {
                    image_url?: { url: string };
                    text?: string;
                    type: "text" | "image_url";
                }[];
                name?: string;
                role: "assistant"
                | "system"
                | "user"
                | "tool";
                tool_call_id?: string;
            }[];
            stream: boolean;
        };
        ChatResponse: {
            message: {
                content: unknown;
                role: "assistant";
                tool_calls?: {
                    function: { arguments: string; name: string };
                    id: string;
                    type: "function";
                }[];
            };
        };
        ContentItem: {
            image_url?: { url: string };
            text?: string;
            type: "text" | "image_url";
        };
        ContentItemType: "text"
        | "image_url";
        Context: {
            conversation_id?: string;
            custom?: { [key: string]: unknown };
            user_id?: string;
        };
        ErrorResponse: { error: string };
        ImageUrl: { url: string };
        InvokeRequest: {
            context?: {
                conversation_id?: string;
                custom?: { [key: string]: unknown };
                user_id?: string;
            };
            input: { [key: string]: unknown };
            stream: boolean;
        };
        InvokeResponse: { output?: unknown };
        Project: {
            createdAt: string;
            id: string;
            name: string;
            organizationId: string;
            slug: string;
            updatedAt: string;
        };
        StreamChunk: { chunk: string };
        ToolCall: {
            function: { arguments: string; name: string };
            id: string;
            type: "function";
        };
        ToolCallFunction: { arguments: string; name: string };
        ToolCallType: "function";
    }

    Type Declaration

    • AssistantMessage: {
          content: unknown;
          role: "assistant";
          tool_calls?: {
              function: { arguments: string; name: string };
              id: string;
              type: "function";
          }[];
      }

      Assistant message response

    • AssistantRole: "assistant"
    • ChatMessage: {
          content:
              | string
              | { [key: string]: unknown }
              | {
                  image_url?: { url: string };
                  text?: string;
                  type: "text" | "image_url";
              }[];
          name?: string;
          role: "assistant"
          | "system"
          | "user"
          | "tool";
          tool_call_id?: string;
      }
      • content:
            | string
            | { [key: string]: unknown }
            | {
                image_url?: { url: string };
                text?: string;
                type: "text" | "image_url";
            }[]

        Message content. Can be string, array (multimodal), or object (tool).

      • Optionalname?: string

        Tool name (required when role is "tool")

      • role: "assistant" | "system" | "user" | "tool"
      • Optionaltool_call_id?: string

        Tool call ID (for tool role)

    • ChatMessageRole: "assistant" | "system" | "user" | "tool"

      Message role

    • ChatRequest: {
          context?: {
              conversation_id?: string;
              custom?: { [key: string]: unknown };
              user_id?: string;
          };
          messages: {
              content: | string
              | { [key: string]: unknown }
              | {
                  image_url?: { url: string };
                  text?: string;
                  type: "text" | "image_url";
              }[];
              name?: string;
              role: "assistant"
              | "system"
              | "user"
              | "tool";
              tool_call_id?: string;
          }[];
          stream: boolean;
      }
      • Optionalcontext?: {
            conversation_id?: string;
            custom?: { [key: string]: unknown };
            user_id?: string;
        }
        • Optionalconversation_id?: string

          ID to track multi-turn conversations

        • Optionalcustom?: { [key: string]: unknown }

          Additional custom context fields

        • Optionaluser_id?: string

          ID of the user making the request

      • messages: {
            content:
                | string
                | { [key: string]: unknown }
                | {
                    image_url?: { url: string };
                    text?: string;
                    type: "text" | "image_url";
                }[];
            name?: string;
            role: "assistant"
            | "system"
            | "user"
            | "tool";
            tool_call_id?: string;
        }[]

        Conversation history. Must include at least one message.

      • stream: boolean

        Whether to stream the response as SSE.

        false
    • ChatResponse: {
          message: {
              content: unknown;
              role: "assistant";
              tool_calls?: {
                  function: { arguments: string; name: string };
                  id: string;
                  type: "function";
              }[];
          };
      }
    • ContentItem: { image_url?: { url: string }; text?: string; type: "text" | "image_url" }
    • ContentItemType: "text" | "image_url"
    • Context: {
          conversation_id?: string;
          custom?: { [key: string]: unknown };
          user_id?: string;
      }

      Optional request context passed to the agent handler.

      • Optionalconversation_id?: string

        ID to track multi-turn conversations

      • Optionalcustom?: { [key: string]: unknown }

        Additional custom context fields

      • Optionaluser_id?: string

        ID of the user making the request

    • ErrorResponse: { error: string }
      {
               *       "error": "Invalid request"
               *     }
      • error: string

        Error message describing what went wrong

    • ImageUrl: { url: string }
    • InvokeRequest: {
          context?: {
              conversation_id?: string;
              custom?: { [key: string]: unknown };
              user_id?: string;
          };
          input: { [key: string]: unknown };
          stream: boolean;
      }
      • Optionalcontext?: {
            conversation_id?: string;
            custom?: { [key: string]: unknown };
            user_id?: string;
        }
        • Optionalconversation_id?: string

          ID to track multi-turn conversations

        • Optionalcustom?: { [key: string]: unknown }

          Additional custom context fields

        • Optionaluser_id?: string

          ID of the user making the request

      • input: { [key: string]: unknown }

        Input data for the agent. Structure depends on agent implementation.

      • stream: boolean

        Whether to stream the response as SSE.

        false
    • InvokeResponse: { output?: unknown }
      • Optionaloutput?: unknown

        Output from the agent. Structure depends on agent implementation.

    • Project: {
          createdAt: string;
          id: string;
          name: string;
          organizationId: string;
          slug: string;
          updatedAt: string;
      }
      • createdAt: string

        Format: date-time

        ISO 8601 timestamp when the project was created

      • id: string

        Unique identifier for the project

      • name: string

        Human-readable name of the project

      • organizationId: string

        ID of the organization that owns this project

      • slug: string

        URL-friendly identifier for the project

      • updatedAt: string

        Format: date-time

        ISO 8601 timestamp when the project was last updated

    • StreamChunk: { chunk: string }
      • chunk: string

        Text chunk from the stream

    • ToolCall: { function: { arguments: string; name: string }; id: string; type: "function" }
    • ToolCallFunction: { arguments: string; name: string }
    • ToolCallType: "function"

    Settings

    Member Visibility

    On This Page

    Properties