/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { "/graphql": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Execute a GraphQL query */ post: operations["graphql"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/discord/{discordIntegrationId}/initiate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Initiates conversation with the discord integration */ post: operations["initiateDiscord"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/email/{emailIntegrationId}/initiate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Initiates conversation with the email integration */ post: operations["initiateEmail"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/googlechat/{googlechatIntegrationId}/initiate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Initiates conversation with the googlechat integration */ post: operations["initiateGooglechat"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/instagram/{instagramIntegrationId}/initiate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Initiates conversation with the instagram integration */ post: operations["initiateInstagram"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/messenger/{messengerIntegrationId}/initiate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Initiates conversation with the messenger integration */ post: operations["initiateMessenger"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/microsoftteams/{microsoftteamsIntegrationId}/initiate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Initiate a conversation with a Microsoft Teams integration */ post: operations["initiateTeams"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/recall/{recallIntegrationId}/initiate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Initiates a meeting session with the recall integration */ post: operations["initiateRecall"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/slack/{slackIntegrationId}/initiate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Initiates conversation with the slack integration */ post: operations["initiateSlack"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/telegram/{telegramIntegrationId}/initiate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Initiates conversation with the telegram integration */ post: operations["initiateTelegram"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/twilio/{twilioIntegrationId}/initiate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Initiates conversation with the twilio integration */ post: operations["initiateTwilio"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/whatsapp/{whatsappIntegrationId}/initiate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Initiates conversation with the whatsapp integration */ post: operations["initiateWhatsapp"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/openai/chat/completions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create a chat completion (OpenAI-compatible) * @description An OpenAI Chat Completions compatible endpoint. Point any OpenAI client at this base URL and set `model` to a selector such as `model/name=...` or `bot/id=...`. Supports streaming and tool calling. */ post: operations["createChatCompletion"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/report/{reportId}/generate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Generate a specific report * @description Generates a report based on the specified report ID and input * parameters. * */ post: operations["generatePlatformReport"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/report/generate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Generate multiple reports * @description Generates multiple reports in a single request. Input is a map where * each key is a report ID and each value contains the input parameters * for that report. Returns a map with the same keys containing the * corresponding report outputs. * */ post: operations["generatePlatformReports"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/report/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of available reports */ get: operations["listPlatformReports"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/task/{taskId}/subscribe": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Subscribe to task workflow events * @description Subscribe to real-time task workflow events. The stream currently * includes operation begin, operation end, and error events emitted by * the task's conversation engine while a task execution is running. The * response uses the same streaming envelope shape as conversation * completion endpoints: each line is an event with a `type`, `createdAt`, * and `data`. * */ post: operations["subscribeTaskWorkflowEvents"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/blueprint/{blueprintId}/bulletin/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Post a bulletin to a blueprint's shared board */ post: operations["createBlueprintBulletin"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/blueprint/{blueprintId}/bulletin/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List the bulletins on a blueprint's shared board */ get: operations["listBlueprintBulletins"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/blueprint/{blueprintId}/clone": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Clone a blueprint */ post: operations["cloneBlueprint"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/blueprint/{blueprintId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete a blueprint */ post: operations["deleteBlueprint"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/blueprint/{blueprintId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a blueprint */ get: operations["fetchBlueprint"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/blueprint/{blueprintId}/resource/export": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Export blueprint resources * @description Export a blueprint and all its resources. The default format is JSON. * Set the Accept header to `application/terraform+hcl` to export as * Terraform HCL code. * */ get: operations["exportBlueprintResources"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/blueprint/{blueprintId}/resource/import": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Import resources into an existing blueprint * @description Reconciles resources by alias. A resource whose alias already exists in the blueprint is updated in place (credentials are preserved); otherwise it is created. Resources without an alias are always created. Caller-provided ids are used only to wire up references within the payload. */ post: operations["importBlueprintResources"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/blueprint/{blueprintId}/resource/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List the resources of a blueprint */ get: operations["listBlueprintResources"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/blueprint/{blueprintId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update blueprint */ post: operations["updateBlueprint"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/blueprint/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create blueprint */ post: operations["createBlueprint"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/blueprint/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of blueprints */ get: operations["listBlueprints"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/bot/{botId}/clone": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Clone bot */ post: operations["cloneBot"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/bot/{botId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete a bot */ post: operations["deleteBot"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/bot/{botId}/downvote": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Downvote a bot */ post: operations["downvoteBot"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/bot/{botId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a bot */ get: operations["fetchBot"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/bot/{botId}/memory/search": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Search memories for a specific bot */ post: operations["searchBotMemory"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/bot/{botId}/session/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create bot session */ post: operations["createBotSession"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/bot/{botId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update bot */ post: operations["updateBot"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/bot/{botId}/upvote": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Upvote a bot */ post: operations["upvoteBot"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/bot/{botId}/usage/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Fetch bot usage statistics * @description Retrieve usage statistics for a specific bot, including total tokens * (BASE type only), total conversations, and total messages. Optionally * filter by date range. * */ get: operations["fetchBotUsage"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/bot/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create bot */ post: operations["createBot"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/bot/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of bots */ get: operations["listBots"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/channel/{channelId}/publish": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Publish a message to a channel * @description Publish a message to a specific channel. The message will be broadcast * to all subscribers currently listening to this channel via the * subscribe endpoint. * */ post: operations["publishChannelMessage"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/channel/{channelId}/subscribe": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Subscribe to channel messages * @description Subscribe to a channel to receive real-time messages published to it. * This endpoint returns a streaming response that will continuously send * message events as they are published to the channel via the publish * endpoint. The connection remains open until the client closes it or * an error occurs. * */ post: operations["subscribeChannelMessages"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contact/{contactId}/conversation/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List contact conversations */ get: operations["listContactConversations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contact/{contactId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete contact */ post: operations["deleteContact"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contact/{contactId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch contact */ get: operations["fetchContact"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contact/{contactId}/memory/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List contact memories */ get: operations["listContactMemories"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contact/{contactId}/memory/search": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Search memories for a specific contact */ post: operations["searchContactMemory"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contact/{contactId}/rating/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List contact ratings */ get: operations["listContactRatings"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contact/{contactId}/secret/{secretId}/authenticate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Authenticate contact secret */ post: operations["authenticateContactSecret"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contact/{contactId}/secret/{secretId}/revoke": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Revoke contact secret */ post: operations["revokeContactSecret"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contact/{contactId}/secret/{secretId}/verify": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Verify contact secret */ post: operations["verifyContactSecret"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contact/{contactId}/secret/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List contact secrets */ get: operations["listContactSecrets"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contact/{contactId}/space/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List contact spaces */ get: operations["listContactSpaces"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contact/{contactId}/task/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List contact tasks */ get: operations["listContactTasks"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contact/{contactId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update contact */ post: operations["updateContact"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contact/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create a new contact * @description Create a new contact with the given parameters. * */ post: operations["createContact"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contact/ensure": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Ensure a contact exists or create a new one * @description Ensure a contact with the given parameters exists or create a new one. * */ post: operations["ensureContact"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contact/export": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Export contacts */ get: operations["exportContacts"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/contact/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List contacts */ get: operations["listContacts"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/attachment/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List conversation attachments */ get: operations["listConversationAttachments"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/attachment/upload": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Upload a file as a conversation attachment * @description Upload the specified file to the conversation. The file can be * specified either as a HTTP URL, a data URL, a multipart/form-data, or * as a raw file stream. There is currently a limit of 4.5MB for files * uploaded via all available methods except for direct-to-source uploads * when using application/json request body with a file object. * */ post: operations["uploadConversationAttachment"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/compact": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Compact a conversation into a checkpoint */ post: operations["compactConversation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/complete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Send and receive a conversation response */ post: operations["completeConversationMessage"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/contact/upsert": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Upsert contact */ post: operations["upsertConversationContact"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete conversation */ post: operations["deleteConversation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/dispatch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Dispatch a stateful conversation completion to run in the background * @description Dispatch a stateful conversation completion to run asynchronously in the * background. This endpoint accepts the same parameters as the complete * endpoint but instead of streaming the response directly, it returns a * channel ID that can be used to subscribe to the completion progress. * * The completion will be processed in the background and events will be * published to the channel as the completion progresses. This is useful * for long-running completions that may take several minutes to complete. * * To monitor the progress, subscribe to the channel using: * `POST /api/v1/channel/{channelId}/subscribe` * */ post: operations["dispatchStatefulConversation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/downvote": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Downvote conversation */ post: operations["downvoteConversation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch conversation */ get: operations["fetchConversation"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/message/{messageId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete a message */ post: operations["deleteConversationMessage"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/message/{messageId}/downvote": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Downvote conversation message */ post: operations["downvoteConversationMessage"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/message/{messageId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch conversation message */ get: operations["fetchConversationMessage"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/message/{messageId}/synthesize": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Synthesize conversation message */ post: operations["synthesizeConversationMessage"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/message/{messageId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update conversation message */ post: operations["updateConversationMessage"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/message/{messageId}/upvote": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Upvote conversation message */ post: operations["upvoteConversationMessage"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/message/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create message */ post: operations["createConversationMessage"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/message/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List conversation messages */ get: operations["listConversationMessages"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/receive": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Receive a conversation response */ post: operations["receiveConversationMessage"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/send": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Send a message to a conversation */ post: operations["sendConversationMessage"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/session/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create conversation session * @description Conversation tokens allow client-side applications to create a unique, * authenticated credential for each conversation. This token can be used * to interact with the conversation/{conversationId}/send, * conversation/{conversationId}/receive, and * conversation/{conversationId}/message/create routes. By creating an * individual token for each conversation, a client-side application is * able to directly access and manipulate the conversation through these * routes. Without conversation tokens, a client-side application would * need to authenticate and access conversation routes through a * server-side application, which can be more complex and require * additional infrastructure. By providing a way for client-side * applications to authenticate and access the conversation routes * directly, the token route simplifies the process of integrating with * the API and makes it more convenient for developers to build AI * applications. * */ post: operations["createConversationSession"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update conversation */ post: operations["updateConversation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/upvote": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Upvote conversation */ post: operations["upvoteConversation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/{conversationId}/usage/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Fetch conversation usage statistics * @description Retrieve usage statistics for a specific conversation, including total tokens * (BASE type only) and total messages. Optionally filter by date range. * */ get: operations["fetchConversationUsage"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/compact": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Compact an array of messages into a single summary */ post: operations["compactConversationStateless"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/complete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Complete the next message in a conversation */ post: operations["completeConversation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create a new conversation * @description Create a new conversation with the given parameters and optional * messages. The conversation will be initialized with the the backstory, * model, dataset, skillset and other configuration options of the bot. * Alternatively the conversation can be initialized directly with the * backstory, model, dataset, skillset and other configuration options. * * An array of messages can be included in the request body to add to the * conversation. * */ post: operations["createConversation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/dispatch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Dispatch a conversation completion to run in the background * @description Dispatch a conversation completion to run asynchronously in the * background. This endpoint accepts the same parameters as the complete * endpoint but instead of streaming the response directly, it returns a * channel ID that can be used to subscribe to the completion progress. * * The completion will be processed in the background and events will be * published to the channel as the completion progresses. This is useful * for long-running completions that may take several minutes to complete. * * To monitor the progress, subscribe to the channel using: * `POST /api/v1/channel/{channelId}/subscribe` * */ post: operations["dispatchConversation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/export": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Export conversations */ get: operations["exportConversations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/conversation/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List conversations */ get: operations["listConversations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dataset/{datasetId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete a dataset */ post: operations["deleteDataset"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dataset/{datasetId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a dataset */ get: operations["fetchDataset"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dataset/{datasetId}/file/{fileId}/attach": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Attach dataset file */ post: operations["attachDatasetFile"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dataset/{datasetId}/file/{fileId}/detach": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Detach dataset file */ post: operations["detachDatasetFile"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dataset/{datasetId}/file/{fileId}/sync": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Sync dataset file */ post: operations["syncDatasetFile"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dataset/{datasetId}/file/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of dataset files */ get: operations["listDatasetFiles"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dataset/{datasetId}/record/{recordId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete a record from a dataset */ post: operations["deleteDatasetRecord"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dataset/{datasetId}/record/{recordId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a record from a dataset */ get: operations["fetchDatasetRecord"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dataset/{datasetId}/record/{recordId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a dataset record */ post: operations["updateDatasetRecord"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dataset/{datasetId}/record/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create record */ post: operations["createDatasetRecord"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dataset/{datasetId}/record/export": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Export dataset records */ get: operations["exportDatasetRecords"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dataset/{datasetId}/record/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of dataset records */ get: operations["listDatasetRecords"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dataset/{datasetId}/search": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Search a dataset for records matching a given search query */ post: operations["searchDataset"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dataset/{datasetId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update dataset */ post: operations["updateDataset"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dataset/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create dataset */ post: operations["createDataset"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/dataset/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of datasets */ get: operations["listDatasets"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/event/log/export": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Export event logs */ get: operations["exportEventLogs"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/event/log/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List event logs */ get: operations["listEventLogs"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/event/log/subscribe": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Subscribe to live event logs * @description Subscribe to receive real-time event logs as they are generated. This * endpoint returns a streaming response that continuously delivers events * as they occur in your account. The connection remains open until the * client closes it or an error occurs. * * This is useful for: * - Real-time monitoring dashboards * - Live debugging and troubleshooting * - Building reactive integrations * - Streaming event data to external systems * * For historical event data, use the `/event/log/list` endpoint instead. * */ post: operations["subscribeEventLogs"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/file/{fileId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete a file */ post: operations["deleteFile"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/file/{fileId}/download": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Download a file * @description Download a file. If the file is not public, the user must be * authenticated. * */ get: operations["downloadFile"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/file/{fileId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a file */ get: operations["fetchFile"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/file/{fileId}/sync": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Sync file */ post: operations["syncFile"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/file/{fileId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update file */ post: operations["updateFile"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/file/{fileId}/upload": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Upload the specified file * @description Upload the specified file to the file storage service. The file can be * specified either as a HTTP URL, a data URL, a multipart/form-data, or * as a raw file stream. There is currently a limit of 4.5MB for files * uploaded via all available methods except for direct-to-source uploads * when using application/json request body with a file object. * */ post: operations["uploadFile"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/file/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create file */ post: operations["createFile"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/file/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of files */ get: operations["listFiles"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/discord/{discordIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete Discord integration */ post: operations["deleteDiscordIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/discord/{discordIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a discordIntegration */ get: operations["fetchDiscordIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/discord/{discordIntegrationId}/setup": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Setup Discord integration */ post: operations["setupDiscordIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/discord/{discordIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a Discord integration */ post: operations["updateDiscordIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/discord/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create Discord integration */ post: operations["createDiscordIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/discord/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List Discord integrations */ get: operations["listDiscordIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/email/{emailIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete Email integration */ post: operations["deleteEmailIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/email/{emailIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a emailIntegration */ get: operations["fetchEmailIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/email/{emailIntegrationId}/setup": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Setup a Email integration */ post: operations["setupEmailIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/email/{emailIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a Email integration */ post: operations["updateEmailIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/email/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create Email integration */ post: operations["createEmailIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/email/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List Email integrations */ get: operations["listEmailIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/extract/{extractIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete Extract integration */ post: operations["deleteExtractIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/extract/{extractIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a extractIntegration */ get: operations["fetchExtractIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/extract/{extractIntegrationId}/item/export": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Export extract integration items */ get: operations["exportExtractIntegrationItems"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/extract/{extractIntegrationId}/item/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List extract integration items */ get: operations["listExtractIntegrationItems"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/extract/{extractIntegrationId}/trigger": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Trigger extract integration on historic conversations */ post: operations["triggerExtractIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/extract/{extractIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a Extract integration */ post: operations["updateExtractIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/extract/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create Extract integration */ post: operations["createExtractIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/extract/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List Extract integrations */ get: operations["listExtractIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/googlechat/{googlechatIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete Google Chat integration */ post: operations["deleteGooglechatIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/googlechat/{googlechatIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a Google Chat integration */ get: operations["fetchGooglechatIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/googlechat/{googlechatIntegrationId}/setup": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Setup Google Chat integration */ post: operations["setupGooglechatIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/googlechat/{googlechatIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a Google Chat integration */ post: operations["updateGooglechatIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/googlechat/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create Google Chat integration */ post: operations["createGooglechatIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/googlechat/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List Google Chat integrations */ get: operations["listGooglechatIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/instagram/{instagramIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete Instagram integration */ post: operations["deleteInstagramIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/instagram/{instagramIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch an Instagram integration */ get: operations["fetchInstagramIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/instagram/{instagramIntegrationId}/setup": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Setup an Instagram integration */ post: operations["setupInstagramIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/instagram/{instagramIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update an Instagram integration */ post: operations["updateInstagramIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/instagram/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create Instagram integration */ post: operations["createInstagramIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/instagram/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List Instagram integrations */ get: operations["listInstagramIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/mcpserver/{mcpserverIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete McpServer integration */ post: operations["deleteMcpServerIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/mcpserver/{mcpserverIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a mcpserverIntegration */ get: operations["fetchMcpServerIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/mcpserver/{mcpserverIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a McpServer integration */ post: operations["updateMcpServerIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/mcpserver/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create McpServer integration */ post: operations["createMcpServerIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/mcpserver/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List McpServer integrations */ get: operations["listMcpServerIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/messenger/{messengerIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete Messenger integration */ post: operations["deleteMessengerIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/messenger/{messengerIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a messengerIntegration */ get: operations["fetchMessengerIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/messenger/{messengerIntegrationId}/setup": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Setup a Messenger integration */ post: operations["setupMessengerIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/messenger/{messengerIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a Messenger integration */ post: operations["updateMessengerIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/messenger/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create Messenger integration */ post: operations["createMessengerIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/messenger/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List Messenger integrations */ get: operations["listMessengerIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/microsoftteams/{microsoftteamsIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete a Microsoft Teams integration */ post: operations["deleteMicrosoftteamsIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/microsoftteams/{microsoftteamsIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a Microsoft Teams integration */ get: operations["fetchMicrosoftteamsIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/microsoftteams/{microsoftteamsIntegrationId}/setup": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Set up a Microsoft Teams integration */ post: operations["setupMicrosoftteamsIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/microsoftteams/{microsoftteamsIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a Microsoft Teams integration */ post: operations["updateMicrosoftteamsIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/microsoftteams/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create a Microsoft Teams integration */ post: operations["createMicrosoftteamsIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/microsoftteams/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List Microsoft Teams integrations */ get: operations["listMicrosoftteamsIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/notion/{notionIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete Notion integration */ post: operations["deleteNotionIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/notion/{notionIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a notionIntegration */ get: operations["fetchNotionIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/notion/{notionIntegrationId}/sync": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Sync Notion integration */ post: operations["syncNotionIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/notion/{notionIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a Notion integration */ post: operations["updateNotionIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/notion/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create Notion integration */ post: operations["createNotionIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/notion/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List Notion integrations */ get: operations["listNotionIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/sitemap/{sitemapIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete Sitemap integration */ post: operations["deleteSitemapIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/sitemap/{sitemapIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a sitemapIntegration */ get: operations["fetchSitemapIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/sitemap/{sitemapIntegrationId}/sync": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Sync a Sitemap integration */ post: operations["syncSitemapIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/sitemap/{sitemapIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a Sitemap integration */ post: operations["updateSitemapIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/sitemap/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create Sitemap integration */ post: operations["createSitemapIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/sitemap/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List Sitemap integrations */ get: operations["listSitemapIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/skillserver/{skillserverIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete SkillServer integration */ post: operations["deleteSkillServerIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/skillserver/{skillserverIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a skillserverIntegration */ get: operations["fetchSkillServerIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/skillserver/{skillserverIntegrationId}/invoke": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Fetch the SkillServer manual * @description Returns a text-first manual describing the abilities exposed by this skill server and how to invoke them. Authenticated with the static access token as a bearer token. */ get: operations["fetchSkillServerManual"]; put?: never; /** * Invoke a SkillServer ability * @description Directly invoke a single ability from the linked skillset by name. Authenticated with the static access token as a bearer token. Responses are plain text by default; append ?format=json (or send an Accept: application/json header) for a JSON response. */ post: operations["invokeSkillServerAbility"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/skillserver/{skillserverIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a SkillServer integration */ post: operations["updateSkillServerIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/skillserver/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create SkillServer integration */ post: operations["createSkillServerIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/skillserver/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List SkillServer integrations */ get: operations["listSkillServerIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/slack/{slackIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete Slack integration */ post: operations["deleteSlackIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/slack/{slackIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a slackIntegration */ get: operations["fetchSlackIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/slack/{slackIntegrationId}/setup": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Setup Slack integration */ post: operations["setupSlackIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/slack/{slackIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a Slack integration */ post: operations["updateSlackIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/slack/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create Slack integration */ post: operations["createSlackIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/slack/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List Slack integrations */ get: operations["listSlackIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/support/{supportIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete Support integration */ post: operations["deleteSupportIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/support/{supportIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a supportIntegration */ get: operations["fetchSupportIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/support/{supportIntegrationId}/trigger": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Trigger support integration on historic conversations */ post: operations["triggerSupportIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/support/{supportIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a Support integration */ post: operations["updateSupportIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/support/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create Support integration */ post: operations["createSupportIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/support/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List Support integrations */ get: operations["listSupportIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/telegram/{telegramIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete Telegram integration */ post: operations["deleteTelegramIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/telegram/{telegramIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a telegramIntegration */ get: operations["fetchTelegramIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/telegram/{telegramIntegrationId}/setup": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Setup a Telegram integration */ post: operations["setupTelegramIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/telegram/{telegramIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a Telegram integration */ post: operations["updateTelegramIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/telegram/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create Telegram integration */ post: operations["createTelegramIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/telegram/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List Telegram integrations */ get: operations["listTelegramIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/trigger/{triggerIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete Trigger integration */ post: operations["deleteTriggerIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/trigger/{triggerIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a triggerIntegration */ get: operations["fetchTriggerIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/trigger/{triggerIntegrationId}/invoke": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Invoke Trigger integration */ post: operations["invokeTriggerIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/trigger/{triggerIntegrationId}/setup": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Setup a Trigger integration */ post: operations["setupTriggerIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/trigger/{triggerIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a Trigger integration */ post: operations["updateTriggerIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/trigger/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create Trigger integration */ post: operations["createTriggerIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/trigger/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List Trigger integrations */ get: operations["listTriggerIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/twilio/{twilioIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete Twilio integration */ post: operations["deleteTwilioIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/twilio/{twilioIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a twilioIntegration */ get: operations["fetchTwilioIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/twilio/{twilioIntegrationId}/setup": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Setup a Twilio integration */ post: operations["setupTwilioIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/twilio/{twilioIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a Twilio integration */ post: operations["updateTwilioIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/twilio/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create Twilio integration */ post: operations["createTwilioIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/twilio/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List Twilio integrations */ get: operations["listTwilioIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/whatsapp/{whatsappIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete WhatsApp integration */ post: operations["deleteWhatsAppIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/whatsapp/{whatsappIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a whatsappIntegration */ get: operations["fetchWhatsAppIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/whatsapp/{whatsappIntegrationId}/setup": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Setup a WhatsApp integration */ post: operations["setupWhatsAppIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/whatsapp/{whatsappIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a WhatsApp integration */ post: operations["updateWhatsAppIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/whatsapp/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create WhatsApp integration */ post: operations["createWhatsAppIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/whatsapp/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List WhatsApp integrations */ get: operations["listWhatsAppIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/widget/{widgetIntegrationId}/clone": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Clone Widget integration */ post: operations["cloneWidgetIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/widget/{widgetIntegrationId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete Widget integration */ post: operations["deleteWidgetIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/widget/{widgetIntegrationId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a widgetIntegration */ get: operations["fetchWidgetIntegration"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/widget/{widgetIntegrationId}/file/{fileId}/attach": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Attach a file to a widget integration */ post: operations["attachWidgetIntegrationFile"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/widget/{widgetIntegrationId}/file/{fileId}/detach": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Detach a file from a widget integration */ post: operations["detachWidgetIntegrationFile"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/widget/{widgetIntegrationId}/setup": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Setup Widget integration */ post: operations["setupWidgetIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/widget/{widgetIntegrationId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a Widget integration */ post: operations["updateWidgetIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/widget/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create Widget integration */ post: operations["createWidgetIntegration"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/integration/widget/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List Widget integrations */ get: operations["listWidgetIntegrations"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/magic/{promptId}/generate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Generate text (description, records, abilities and more) based on input. */ post: operations["generateMagicFromPrompt"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/magic/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of magic prompts */ get: operations["listMagicPrompts"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/memory/{memoryId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete memory */ post: operations["deleteMemory"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/memory/{memoryId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch memory */ get: operations["fetchMemory"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/memory/{memoryId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update memory */ post: operations["updateMemory"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/memory/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create a new memory * @description Create a new memory with the given parameters. * */ post: operations["createMemory"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/memory/export": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Export memories */ get: operations["exportMemories"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/memory/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List memories */ get: operations["listMemories"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/memory/search": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Search memories for records matching a given search query */ post: operations["searchMemory"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/partner/user/{userId}/context/{contextId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete a partner user context */ post: operations["deletePartnerUserContext"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/partner/user/{userId}/context/{contextId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a partner user context */ get: operations["fetchPartnerUserContext"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/partner/user/{userId}/context/{contextId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a partner user context */ post: operations["updatePartnerUserContext"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/partner/user/{userId}/context/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create partner user context */ post: operations["createPartnerUserContext"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/partner/user/{userId}/context/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List partner user contexts */ get: operations["listPartnerUserContexts"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/partner/user/{userId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete a partner user */ post: operations["deletePartnerUser"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/partner/user/{userId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a partner user */ get: operations["fetchPartnerUser"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/partner/user/{userId}/session/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create a partner user session */ post: operations["createPartnerUserSession"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/partner/user/{userId}/token/{tokenId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete a partner user token */ post: operations["deletePartnerUserToken"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/partner/user/{userId}/token/{tokenId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a partner user token */ post: operations["updatePartnerUserToken"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/partner/user/{userId}/token/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create partner user token */ post: operations["createPartnerUserToken"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/partner/user/{userId}/token/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List partner user tokens */ get: operations["listPartnerUserTokens"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/partner/user/{userId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a partner user */ post: operations["updatePartnerUser"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/partner/user/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create partner user */ post: operations["createPartnerUser"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/partner/user/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List partner users */ get: operations["listPartnerUsers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/ability/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of platform abilities */ get: operations["listPlatformAbilities"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/ability/search": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Search platform abilities using semantic similarity */ post: operations["searchPlatformAbilities"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/action/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of platform actions */ get: operations["listPlatformActions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/doc/{docId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Fetch a specific platform doc * @description Retrieves the complete content and metadata of a specific doc. This * includes the markdown content and all associated frontmatter. * */ get: operations["fetchPlatformDoc"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/doc/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Retrieve a list of platform docs * @description Returns a list of available documentation docs with their metadata. * */ get: operations["listPlatformDocs"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/doc/search": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Search platform docs using semantic similarity */ post: operations["searchPlatformDocs"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/example/{exampleId}/clone": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Clone a platform example */ post: operations["clonePlatformExample"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/example/{exampleId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a specific platform example with full details */ get: operations["fetchPlatformExample"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/example/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of platform examples */ get: operations["listPlatformExamples"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/example/search": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Search platform examples using semantic similarity */ post: operations["searchPlatformExamples"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/guide/{guideId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Fetch a specific platform guide * @description Retrieves the complete content and metadata of a specific guide. This * includes the markdown content and all associated frontmatter. * */ get: operations["fetchPlatformGuide"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/guide/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Retrieve a list of platform guides * @description Returns a list of available guides with their metadata. * */ get: operations["listPlatformGuides"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/guide/search": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Search platform guides using semantic similarity */ post: operations["searchPlatformGuides"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/manual/{manualId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Fetch a specific platform manual * @description Retrieves the complete content and metadata of a specific manual. This * includes the markdown content and all associated frontmatter. * */ get: operations["fetchPlatformManual"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/manual/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Retrieve a list of platform manuals * @description Returns a list of available documentation manuals with their metadata. * */ get: operations["listPlatformManuals"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/manual/search": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Search platform manuals using semantic similarity */ post: operations["searchPlatformManuals"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/model/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of platform models */ get: operations["listPlatformModels"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/secret/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of platform secrets */ get: operations["listPlatformSecrets"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/secret/search": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Search platform secrets using semantic similarity */ post: operations["searchPlatformSecrets"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/tutorial/{tutorialId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Fetch a specific platform tutorial * @description Retrieves the complete content and metadata of a specific tutorial. This * includes the markdown content and all associated frontmatter. * */ get: operations["fetchPlatformTutorial"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/tutorial/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Retrieve a list of platform tutorials * @description Returns a list of available tutorials with their metadata. * */ get: operations["listPlatformTutorials"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/platform/tutorial/search": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Search platform tutorials using semantic similarity */ post: operations["searchPlatformTutorials"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/policy/{policyId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete policy */ post: operations["deletePolicy"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/policy/{policyId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a policy */ get: operations["fetchPolicy"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/policy/{policyId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update policy */ post: operations["updatePolicy"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/policy/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create policy */ post: operations["createPolicy"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/policy/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of policies */ get: operations["listPolicies"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/portal/{portalId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete a portal */ post: operations["deletePortal"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/portal/{portalId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a portal */ get: operations["fetchPortal"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/portal/{portalId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update portal */ post: operations["updatePortal"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/portal/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create portal */ post: operations["createPortal"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/portal/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of portals */ get: operations["listPortals"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/secret/{secretId}/authenticate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Authenticate secret */ post: operations["authenticateSecret"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/secret/{secretId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete a secret */ post: operations["deleteSecret"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/secret/{secretId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a secret */ get: operations["fetchSecret"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/secret/{secretId}/revoke": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Revoke secret */ post: operations["revokeSecret"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/secret/{secretId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update secret */ post: operations["updateSecret"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/secret/{secretId}/verify": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Verify secret */ post: operations["verifySecret"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/secret/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create secret */ post: operations["createSecret"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/secret/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of secrets */ get: operations["listSecrets"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/skillset/{skillsetId}/ability/{abilityId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete a ability from a skillset */ post: operations["deleteSkillsetAbility"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/skillset/{skillsetId}/ability/{abilityId}/execute": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Execute a skillset ability * @description Executes a specific ability from a skillset with the provided input. * This endpoint processes the ability's instruction template using the * given input and returns the execution result along with usage statistics. * The response is streamed as JSON lines (JSONL) to support real-time * progress updates during execution. * */ post: operations["executeSkillsetAbility"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/skillset/{skillsetId}/ability/{abilityId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a ability from a skillset */ get: operations["fetchSkillsetAbility"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/skillset/{skillsetId}/ability/{abilityId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a skillset ability */ post: operations["updateSkillsetAbility"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/skillset/{skillsetId}/ability/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create ability */ post: operations["createSkillsetAbility"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/skillset/{skillsetId}/ability/export": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Export skillset abilities */ get: operations["exportSkillsetAbilities"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/skillset/{skillsetId}/ability/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of skillset abilities */ get: operations["listSkillsetAbilities"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/skillset/{skillsetId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete a skillset */ post: operations["deleteSkillset"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/skillset/{skillsetId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a skillset */ get: operations["fetchSkillset"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/skillset/{skillsetId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update skillset */ post: operations["updateSkillset"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/skillset/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create skillset */ post: operations["createSkillset"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/skillset/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of skillsets */ get: operations["listSkillsets"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{spaceId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete a space */ post: operations["deleteSpace"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{spaceId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a space */ get: operations["fetchSpace"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{spaceId}/site/{siteId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete a space site */ post: operations["deleteSpaceSite"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{spaceId}/site/{siteId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch a space site */ get: operations["fetchSpaceSite"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{spaceId}/site/{siteId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update a space site */ post: operations["updateSpaceSite"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{spaceId}/site/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create a space site */ post: operations["createSpaceSite"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{spaceId}/site/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List space sites */ get: operations["listSpaceSites"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{spaceId}/storage/copy/{path}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Copy a file in space storage * @description Copy a file from one location to another within space storage. The * source file path is specified in the URL after /copy/. The * destinationPath in the request body specifies where to copy the file. * */ post: operations["copySpaceStoragePath"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{spaceId}/storage/delete/{path}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Delete a file or directory from space storage * @description Delete a file or directory from space storage. The path is specified * in the URL after /delete/. If recursive is true and the path is a * directory, all files within it will be deleted. * */ post: operations["deleteSpaceStoragePath"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{spaceId}/storage/download/{path}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Download a file from space storage * @description Download a file from space storage. The file path is specified in the * URL after /download/. Can return either the direct file content * (default) or a presigned download URL (when Accept: application/json). * */ get: operations["downloadSpaceStoragePath"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{spaceId}/storage/list/{path}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List files and directories in space storage * @description List files and directories in the space's storage. Supports both flat * and recursive listing. The path is specified in the URL after /list/. * Omit the path to list the root directory. * */ get: operations["listSpaceStoragePath"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{spaceId}/storage/move/{path}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Move (rename) a file in space storage * @description Move a file from one location to another within space storage, or * rename a file by moving it to a new path. The source file path is * specified in the URL after /move/. The destinationPath in the request * body is the target location for the file. * */ post: operations["moveSpaceStoragePath"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{spaceId}/storage/upload/{path}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Upload a file to space storage * @description Upload a file to space storage. The file path is specified in the URL * after /upload/. The file can be specified either as a HTTP URL, a data * URL, a multipart/form-data, or as a raw file stream. The maximum file * size for uploads is determined dynamically based on user limits and * configuration, and may vary. * */ post: operations["uploadSpaceStoragePath"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/{spaceId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update space */ post: operations["updateSpace"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create space */ post: operations["createSpace"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/export": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Export spaces */ get: operations["exportSpaces"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/space/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List spaces */ get: operations["listSpaces"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/task/{taskId}/cancel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Cancel a running task */ post: operations["cancelTask"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/task/{taskId}/delete": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Delete task */ post: operations["deleteTask"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/task/{taskId}/execution/{taskExecutionId}/cancel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Cancel a task execution */ post: operations["cancelTaskExecution"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/task/{taskId}/execution/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List task executions */ get: operations["listTaskExecutions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/task/{taskId}/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Fetch task */ get: operations["fetchTask"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/task/{taskId}/trigger": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Trigger a task * @description Manually trigger a task to execute immediately. * */ post: operations["triggerTask"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/task/{taskId}/update": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Update task */ post: operations["updateTask"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/task/create": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create a new task * @description Create a new task with the given parameters. * */ post: operations["createTask"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/task/export": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Export tasks */ get: operations["exportTasks"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/task/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List tasks */ get: operations["listTasks"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/team/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Retrieve a list of teams */ get: operations["listTeams"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/usage/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Fetch usage * @description Fetches the usage data for the user in the current billing period. */ get: operations["fetchUsage"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/usage/list": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** List usage records */ get: operations["listUsageRecords"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/usage/series/fetch": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Fetch usage series * @description Fetches a series of usage data points for the user for the last 90 days. */ get: operations["fetchUsageSeries"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; } export type webhooks = Record; export interface components { schemas: { /** @description A message in the conversation */ Message: { /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; }; /** @description Extracted entity from the message */ Entity: { /** @description The entity type */ type: string; /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the entity */ text: string; replacement?: { /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the replacement */ text: string; }; }; /** * @description The type of the message * @enum {string} */ MessageType: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** * @description The type of the trigger * @enum {string} */ Trigger: "never" | "automatic"; /** * @description The schedule * @enum {string} */ Schedule: "never" | "quarterhourly" | "halfhourly" | "hourly" | "twicedaily" | "daily" | "twiceweekly" | "weekly" | "twicemonthly" | "monthly"; /** * @description The sync status of an integration * @enum {string} */ SyncStatus: "pending" | "synced" | "error"; /** * @description The task execution status * @enum {string} */ TaskStatus: "idle" | "running" | "canceled"; /** * @description The task execution outcome * @enum {string} */ TaskOutcome: "pending" | "success" | "failure"; /** * @description The blueprint visibility * @enum {string} */ BlueprintVisibility: "private" | "protected" | "public"; /** * @description The bot visibility * @enum {string} */ BotVisibility: "private" | "protected" | "public"; /** * @description The dataset visibility * @enum {string} */ DatasetVisibility: "private" | "protected" | "public"; /** * @description The dataset file attachment type * @enum {string} */ DatasetFileAttachmentType: "source"; DatasetFilter: { [key: string]: string | number | boolean | { $eq: string | number | boolean; } | { $ne: string | number | boolean; } | { $gt: number; } | { $gte: number; } | { $lt: number; } | { $lte: number; }; }; /** * @description The skillset visibility * @enum {string} */ SkillsetVisibility: "private" | "protected" | "public"; /** * @description The file visibility * @enum {string} */ FileVisibility: "private" | "protected" | "public"; /** * @description The type of the secret * @enum {string} */ SecretType: "plain" | "basic" | "bearer" | "jwt" | "oauth" | "template" | "reference"; /** * @description The kind of the secret * @enum {string} */ SecretKind: "shared" | "personal"; /** * @description The visibility of the secret * @enum {string} */ SecretVisibility: "private" | "protected" | "public"; /** @description Usage information */ Usage: { /** @description The tokens used in this exchange */ token: number; }; /** * @description The reason why the completion ended * @enum {string} */ CompleteReason: "length" | "stop" | "activity" | "abort" | "error" | "iteration"; /** @description Information about an abort event in a streamed response */ Abort: { /** @description The abort reason if available */ reason?: unknown; /** @description The function or tool associated with the abort */ functionName?: string; }; /** @description Information about why the completion ended */ CompleteEnd: { /** * @description The reason why the completion ended * @enum {string} */ reason: "length" | "stop" | "activity" | "abort" | "error" | "iteration"; }; /** @description Execution limits to control conversation processing bounds */ ExecutionLimits: { /** @description Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses. */ iterations?: number; /** @description Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition. */ continuations?: number; /** @description Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation. */ calls?: number; }; /** * @description The policy type * @enum {string} */ PolicyType: "retention" | "usage"; /** @description Limits information */ Limits: { /** @description The tokens limit */ tokens?: number; /** @description The conversations limit */ conversations?: number; /** @description The messages limit */ messages?: number; /** @description The database limits */ database?: { /** @description The datasets limit */ datasets?: number; /** @description The records limit */ records?: number; /** @description The skillsets limit */ skillsets?: number; /** @description The abilities limit */ abilities?: number; /** @description The files limit */ files?: number; }; }; /** @description Meta data information */ Meta: { [key: string]: unknown; }; /** * @description A model definition * @example gpt-5.4 */ Model: string; /** @description A bot configuration that can be applied without a dedicated bot instance. */ BotRef: { /** @description The ID of the bot this configuration is using */ botId?: string; }; /** @description A bot configuration that can be applied without a dedicated bot instance. */ BotConfig: { /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; }; /** @description A bot configuration or reference */ BotRefOrConfig: { /** @description The ID of the bot this configuration is using */ botId?: string; } | { /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; }; /** @description Blueprint properties */ BlueprintProps: { /** @description The ID of the blueprint */ blueprintId?: string; }; /** @description Instance reference properties */ InstanceRefProperties: { /** @description The unique alias for the instance */ alias?: string; }; /** @description Instance list properties */ InstanceMetaProps: { /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; }; /** @description Instance crud properties */ InstanceCrudProps: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; }; /** @description Instance list properties */ InstanceListProps: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; }; /** @description A JSON Schema object type definition (https://json-schema.org/). Represents an object schema with properties and validation rules. */ JsonSchemaObject: { /** * @description The schema type, must be "object" * @enum {string} */ type: "object"; /** @description The schema title */ title?: string; /** @description The schema description */ description?: string; /** @description Object property definitions */ properties: { [key: string]: unknown; }; /** @description Required property names */ required?: string[]; }; /** @description An array of functions to be added to the conversation */ FunctionsDefinition: { /** @description The name of the function (must be a valid JS identifier, max 64 chars) */ name: string; /** @description The description of the function */ description: string; /** @description JSON Schema definition for the function parameters */ parameters: { /** * @description The schema type, must be "object" * @enum {string} */ type: "object"; /** @description Object property definitions */ properties: { [key: string]: unknown; }; /** @description Required property names */ required?: string[]; }; /** @description The result of the function execution */ result?: { /** @description The data returned by the function (can be any type) */ data: unknown; } | { /** @description The channel for streaming function results */ channel: string; }; /** @description Configuration for when this function should be automatically called */ call?: { /** @description If true, this function will be force-called at the start of the conversation */ start?: boolean; /** @description If true, this function will be force-called at the end of the conversation */ end?: boolean; }; }[]; /** @description Extensions to enhance the bot's capabilities */ ExtensionsDefinition: { /** @description Additional backstory for the bot */ backstory?: string; /** @description Inline datasets to provide additional context */ datasets?: { /** @description The name of the dataset */ name?: string; /** @description The description of the dataset */ description?: string; /** @description The records in the dataset */ records: { /** @description The text content of the record */ text: string; /** @description Additional metadata for the record */ meta?: Record; }[]; }[]; /** @description Inline skillsets to provide additional abilities */ skillsets?: { /** @description The name of the skillset */ name?: string; /** @description The description of the skillset */ description?: string; /** @description The abilities in the skillset */ abilities: { /** @description The name of the ability */ name: string; /** @description The description of the ability */ description: string; /** @description The instruction for the ability */ instruction: string; /** @description Optional secret ID for the ability */ secretId?: string; /** @description Additional metadata for the ability */ meta?: Record; }[]; }[]; /** @description Feature flags to enable specific bot capabilities */ features?: { /** @description The name of the feature to enable */ name: string; /** @description Optional configuration options for the feature */ options?: { [key: string]: unknown; }; }[]; }; /** @description An item in the streaming completion response */ CompleteStreamingResponseItem: { /** * @description The type of event * @enum {string} */ type: "error"; /** @description The data for the event */ data: { /** @description The error message */ message: string; }; } | { /** * @description The type of event * @enum {string} */ type: "token"; /** @description The data for the event */ data: { /** @description The token generated */ token: string; }; } | { /** * @description The type of event * @enum {string} */ type: "reasoningToken"; /** @description The data for the event */ data: { /** @description The token generated */ token: string; }; } | { /** * @description The type of event * @enum {string} */ type: "message"; /** @description A message in the conversation */ data: { /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; }; } | { /** * @description The type of event * @enum {string} */ type: "abort"; /** @description Information about an abort event in a streamed response */ data: { /** @description The abort reason if available */ reason?: unknown; /** @description The function or tool associated with the abort */ functionName?: string; }; } | { /** * @description The type of event * @enum {string} */ type: "completeBegin"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "completeEnd"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "waitForChannelMessageBegin"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "waitForChannelMessageEnd"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "usage"; /** @description The data for the event */ data: { /** @description The model used */ model: string; /** @description The number of input tokens used */ inputTokensUsed: number; /** @description The number of output tokens used */ outputTokensUsed: number; }; }; /** @description An item in the task workflow subscription response */ TaskWorkflowStreamingResponseItem: { /** * @description The type of event * @enum {string} */ type: "operationBegin"; /** @description The event creation timestamp in milliseconds since the Unix epoch */ createdAt: number; /** @description The data for the operation begin event */ data: { /** @description The operation ID */ id: string; /** @description The action associated with the operation */ action: { /** @description The action ID */ id: string; /** * @description The action kind * @enum {string} */ kind?: "dataset" | "skillset" | "function"; /** @description The action name */ name?: string; /** @description The action input */ input?: unknown; /** @description The action justification */ justification?: string; /** @description The action icon */ icon?: string; }; }; } | { /** * @description The type of event * @enum {string} */ type: "operationEnd"; /** @description The event creation timestamp in milliseconds since the Unix epoch */ createdAt: number; /** @description The data for the operation end event */ data: { /** @description The operation ID */ id: string; /** @description The action associated with the operation */ action: { /** @description The action ID */ id: string; /** * @description The action kind * @enum {string} */ kind?: "dataset" | "skillset" | "function"; /** @description The action name */ name?: string; /** @description The action input */ input?: unknown; /** @description The action justification */ justification?: string; /** @description The action icon */ icon?: string; }; }; } | { /** * @description The type of event * @enum {string} */ type: "error"; /** @description The event creation timestamp in milliseconds since the Unix epoch */ createdAt: number; /** @description The data for the error event */ data: { /** @description The error code */ code: string; /** @description The error message */ message: string; }; }; }; responses: { /** @description An error response */ ErrorResponse: { headers: { [name: string]: unknown; }; content?: never; }; }; parameters: { /** @description The timezone to use for the request */ TimezoneHeader: string; }; requestBodies: never; headers: never; pathItems: never; } export type $defs = Record; export interface operations { graphql: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The GraphQL query or mutation string */ query: string; /** @description The variables for the GraphQL operation */ variables?: { [key: string]: unknown; }; /** @description The name of the operation to execute */ operationName?: string; }; }; }; responses: { /** @description The result of the GraphQL operation */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The data returned by the GraphQL operation */ data?: { [key: string]: unknown; }; /** @description Any errors returned by the GraphQL operation */ errors?: { message?: string; }[]; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; initiateDiscord: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The Discord channel ID to send to */ channelId: string; /** @description The text message to send to the Discord channel */ text: string; }; }; }; responses: { /** @description The discord integration was successfully initiated */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the initiated integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; initiateEmail: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** * Format: email * @description The email address to use for the conversation */ email: string; /** @description The subject of the email */ subject: string; /** @description The text instruction to use to initiate the conversation */ text: string; }; }; }; responses: { /** @description The email integration was successfully initiated */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the initiated integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; initiateGooglechat: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The Google Chat space resource name to send to, such as spaces/AAAA..., or a Google Chat user identifier for a direct message */ space?: string; /** @description The text message to send to the Google Chat space */ text: string; }; }; }; responses: { /** @description The googlechat integration was successfully initiated */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the initiated integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; initiateInstagram: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The Instagram professional account ID sending the message */ instagramUserId: string; /** @description The Instagram recipient ID from a prior interaction */ recipientId: string; /** @description The free-form text message to send while Meta allows messaging this recipient */ text: string; }; }; }; responses: { /** @description The instagram integration was successfully initiated */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the initiated integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; initiateMessenger: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The Facebook Page ID sending the message */ pageId: string; /** @description The Messenger recipient PSID from a prior interaction */ recipientId: string; /** @description The free-form text message to send while Meta allows messaging this recipient */ text: string; }; }; }; responses: { /** @description The messenger integration was successfully initiated */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the initiated integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; initiateTeams: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The Microsoft Teams Bot Framework conversation ID to send to */ conversationId: string; /** @description The text message to send to the Teams conversation */ text: string; }; }; }; responses: { /** @description The Microsoft Teams integration was initiated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the initiated integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; initiateRecall: { parameters: { query?: never; header?: never; path: { recallIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The URL of the meeting to join */ meetingUrl: string; /** @description The instruction text to use to initiate the meeting session */ text: string; /** @description The display name for the bot in the meeting */ botName?: string; }; }; }; responses: { /** @description The recall integration was successfully initiated */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the recall integration */ id: string; /** @description The meeting bot data from Recall.ai */ bot: Record; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; initiateSlack: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The Slack channel or user to send to */ channel: string; /** @description The text instruction to use to initiate the conversation */ text: string; }; }; }; responses: { /** @description The slack integration was successfully initiated */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the initiated integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; initiateTelegram: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The Telegram chat ID, user ID, group chat ID, or channel username to send to */ chatId: string | number; /** @description The text instruction to use to initiate the conversation */ text: string; }; }; }; responses: { /** @description The telegram integration was successfully initiated */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the initiated integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; initiateTwilio: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** * @description The Twilio channel to use for the conversation * @default sms * @enum {string} */ channel?: "sms" | "call"; /** @description The Twilio sender phone number */ from: string; /** @description The recipient phone number */ to: string; /** @description The text instruction to use to initiate the conversation */ text: string; }; }; }; responses: { /** @description The twilio integration was successfully initiated */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the initiated integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; initiateWhatsapp: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The recipient phone number in E.164 format, without the leading plus sign */ to: string; /** @description The free-form text message to send within an active WhatsApp customer service window */ text: string; }; }; }; responses: { /** @description The whatsapp integration was successfully initiated */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the initiated integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createChatCompletion: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The chat completion (or a text/event-stream when streaming) */ 200: { headers: { [name: string]: unknown; }; content?: never; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; generatePlatformReport: { parameters: { query?: never; header?: never; path: { reportId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { [key: string]: unknown; }; }; }; responses: { /** @description The report was generated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": Record; }; }; /** @description Report not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; generatePlatformReports: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { /** @example { * "clr3m5n8k000008jq7h9e5b1a": { * "periodDays": 30 * }, * "clr3m5n8k000108jq7h9e5b1b": { * "periodDays": 7 * } * } */ "application/json": { [key: string]: Record; }; }; }; responses: { /** @description The reports were generated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { [key: string]: Record | { /** @description Error message if report generation failed */ error?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPlatformReports: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of reports was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; }[]; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; subscribeTaskWorkflowEvents: { parameters: { query?: never; header?: never; path: { taskId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Number of recent workflow events to replay before live events. */ historyLength?: number; }; }; }; responses: { /** @description Successfully subscribed to task workflow events */ 200: { headers: { [name: string]: unknown; }; content: { "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "operationBegin"; /** @description The event creation timestamp in milliseconds since the Unix epoch */ createdAt: number; /** @description The data for the operation begin event */ data: { /** @description The operation ID */ id: string; /** @description The action associated with the operation */ action: { /** @description The action ID */ id: string; /** * @description The action kind * @enum {string} */ kind?: "dataset" | "skillset" | "function"; /** @description The action name */ name?: string; /** @description The action input */ input?: unknown; /** @description The action justification */ justification?: string; /** @description The action icon */ icon?: string; }; }; } | { /** * @description The type of event * @enum {string} */ type: "operationEnd"; /** @description The event creation timestamp in milliseconds since the Unix epoch */ createdAt: number; /** @description The data for the operation end event */ data: { /** @description The operation ID */ id: string; /** @description The action associated with the operation */ action: { /** @description The action ID */ id: string; /** * @description The action kind * @enum {string} */ kind?: "dataset" | "skillset" | "function"; /** @description The action name */ name?: string; /** @description The action input */ input?: unknown; /** @description The action justification */ justification?: string; /** @description The action icon */ icon?: string; }; }; } | { /** * @description The type of event * @enum {string} */ type: "error"; /** @description The event creation timestamp in milliseconds since the Unix epoch */ createdAt: number; /** @description The data for the error event */ data: { /** @description The error code */ code: string; /** @description The error message */ message: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createBlueprintBulletin: { parameters: { query?: never; header?: never; path: { blueprintId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The message to post to the shared board */ text: string; /** @description Optional time-to-live in seconds before the bulletin expires */ ttl?: number; }; }; }; responses: { /** @description The bulletin was posted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the blueprint */ id: string; bulletin: { id: string; text: string; /** @description The display name of the author who posted the bulletin (a bot or a user) */ author?: string; /** @description The ID of the bot the bulletin is associated with, when posted by a bot */ botId?: string; createdAt: number; expiresAt: number; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listBlueprintBulletins: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; }; header?: never; path: { blueprintId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Blueprint bulletins were retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique identifier of the bulletin */ id: string; /** @description The message body */ text: string; /** @description The display name of the author who posted the bulletin (a bot or a user) */ author?: string; /** @description The ID of the bot the bulletin is associated with, when posted by a bot */ botId?: string; /** @description The epoch millisecond timestamp when the bulletin was created */ createdAt: number; /** @description The epoch millisecond timestamp when the bulletin expires */ expiresAt: number; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; data: { /** @description The unique identifier of the bulletin */ id: string; /** @description The message body */ text: string; /** @description The display name of the author who posted the bulletin (a bot or a user) */ author?: string; /** @description The ID of the bot the bulletin is associated with, when posted by a bot */ botId?: string; /** @description The epoch millisecond timestamp when the bulletin was created */ createdAt: number; /** @description The epoch millisecond timestamp when the bulletin expires */ expiresAt: number; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; cloneBlueprint: { parameters: { query?: never; header?: never; path: { blueprintId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The blueprint was cloned successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the cloned blueprint */ id: string; /** @description A map of the resources that were cloned */ resources: Record; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteBlueprint: { parameters: { query?: never; header?: never; path: { blueprintId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** * @description If true, deletes all resources associated with the blueprint. If false or omitted, only the blueprint is deleted. * @default false */ deleteResources?: boolean; }; }; }; responses: { /** @description The blueprint was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted blueprint */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchBlueprint: { parameters: { query?: never; header?: never; path: { blueprintId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The blueprint was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** * @description The blueprint visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; exportBlueprintResources: { parameters: { query?: never; header?: { Accept?: "application/json" | "application/terraform+hcl"; }; path: { blueprintId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The blueprint was exported successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the blueprint */ id: string; /** @description A map of the resources by category */ resources: Record; }; "application/terraform+hcl": string; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; importBlueprintResources: { parameters: { query?: never; header?: never; path: { blueprintId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description When true and the blueprint is addressed by the caller's own @alias, it is created if it does not exist yet (idempotent provision). Ignored for a raw id, which still 404s on miss. */ ensure?: boolean; resources: Record; }; }; }; responses: { /** @description Resources were imported successfully */ 200: { headers: { [name: string]: unknown; }; content?: never; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listBlueprintResources: { parameters: { query?: never; header?: never; path: { blueprintId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Blueprint resources were retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the blueprint */ id: string; /** @description A map of the resources */ resources: Record; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateBlueprint: { parameters: { query?: never; header?: never; path: { blueprintId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** * @description The blueprint visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; responses: { /** @description The blueprint was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the updated blueprint */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createBlueprint: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** * @description The blueprint visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; responses: { /** @description The blueprint was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created blueprint */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listBlueprints: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of blueprints was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** * @description The blueprint visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** * @description The blueprint visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; cloneBot: { parameters: { query?: never; header?: never; path: { botId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The bot was cloned successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the cloned bot */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteBot: { parameters: { query?: never; header?: never; path: { botId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The bot was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted bot */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; downvoteBot: { parameters: { query?: never; header?: never; path: { botId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** * @description The value of the downvote * @default -100 */ value?: number; /** @description The reason for the downvote */ reason?: string; }; }; }; responses: { /** @description The message was downvoted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The bot ID of the downvoted bot */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchBot: { parameters: { query?: never; header?: never; path: { botId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The bot was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The bot visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchBotMemory: { parameters: { query?: never; header?: never; path: { botId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The keyword/phrase to search for */ search: string; }; }; }; responses: { /** @description The search was successful */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description An array of memories matching the search query */ items: { id: string; text: string; meta?: Record; }[]; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createBotSession: { parameters: { query?: never; header?: never; path: { botId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The maximum amount of time this session will stay open */ durationInSeconds?: number; /** @description An array of messages to be included in the conversation */ messages?: { /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; }[]; /** @description Meta data information */ meta?: { [key: string]: unknown; }; }; }; }; responses: { /** @description The bot was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the bot */ id: string; /** @description The ID of the conversation */ conversationId: string; /** @description The token for this conversation */ token: string; /** @description The time the token will expire in milliseconds */ expiresAt: number; /** @description An array of messages included in the conversation */ messages?: { /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; }[]; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateBot: { parameters: { query?: never; header?: never; path: { botId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The bot visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; responses: { /** @description The bot was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the updated bot */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; upvoteBot: { parameters: { query?: never; header?: never; path: { botId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** * @description The value of the upvote * @default 100 */ value?: number; /** @description The reason for the upvote */ reason?: string; }; }; }; responses: { /** @description The bot was upvoted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the upvoted bot */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchBotUsage: { parameters: { query?: { from?: string; to?: string; }; header?: never; path: { botId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Bot usage statistics retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Total number of BASE tokens used */ tokens?: number; /** @description Total number of conversations */ conversations?: number; /** @description Total number of messages */ messages?: number; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createBot: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The bot visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; responses: { /** @description The bot was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created bot */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listBots: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of bots was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The bot visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The bot visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; publishChannelMessage: { parameters: { query?: never; header?: never; path: { channelId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The message to publish to the channel */ message: { [key: string]: unknown; }; }; }; }; responses: { /** @description The message was published successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the channel the message was published to */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; subscribeChannelMessages: { parameters: { query?: never; header?: never; path: { channelId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Number of historical messages to replay from the channel * before subscribing to live updates. When provided, the * subscriber will first receive up to this many recent * messages that were published before the subscription * started. This is useful for catching up on messages that * may have been published during connection setup. * */ historyLength?: number; }; }; }; responses: { /** @description Successfully subscribed to channel messages */ 200: { headers: { [name: string]: unknown; }; content: { "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "message"; /** @description The message data published to the channel */ data: { [key: string]: unknown; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listContactConversations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; }; header?: never; path: { contactId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The list of conversations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: ({ /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact id assigned to this conversation */ contactId?: string; /** @description The task id assigned to this conversation */ taskId?: string; } & ({ /** @description The ID of the bot this configuration is using */ botId?: string; } | { /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; }))[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description A bot configuration or reference */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact id assigned to this conversation */ contactId?: string; /** @description The task id assigned to this conversation */ taskId?: string; } & ({ /** @description The ID of the bot this configuration is using */ botId?: string; } | { /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; }); }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteContact: { parameters: { query?: never; header?: never; path: { contactId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The contact was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted contact */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchContact: { parameters: { query?: never; header?: never; path: { contactId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The contact was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The fingerprint of the contact */ fingerprint: string; /** @description The email address of the contact */ email?: string; /** @description The phone number of the contact */ phone?: string; /** @description The nickname of the contact */ nick?: string; /** @description The preferences of the contact */ preferences?: string; /** @description The timestamp (ms) when the contact was verified */ verifiedAt?: number; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listContactMemories: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; }; header?: never; path: { contactId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The list of memories was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot the memory belongs to */ botId?: string; /** @description The text of the memory */ text: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot the memory belongs to */ botId?: string; /** @description The text of the memory */ text: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchContactMemory: { parameters: { query?: never; header?: never; path: { contactId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The keyword/phrase to search for */ search: string; }; }; }; responses: { /** @description The search was successful */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description An array of memories matching the search query */ items: { id: string; text: string; meta?: Record; }[]; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listContactRatings: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; }; header?: never; path: { contactId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The list of ratings was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact id assigned to this rating */ contactId?: string; /** @description The bot id assigned to this rating */ botId?: string; /** @description The conversation id assigned to this rating */ conversationId?: string; /** @description The message id assigned to this rating */ messageId?: string; /** @description The rating value */ value?: number; /** @description The reason for the rating */ reason?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact id assigned to this rating */ contactId?: string; /** @description The bot id assigned to this rating */ botId?: string; /** @description The conversation id assigned to this rating */ conversationId?: string; /** @description The message id assigned to this rating */ messageId?: string; /** @description The rating value */ value?: number; /** @description The reason for the rating */ reason?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; authenticateContactSecret: { parameters: { query?: never; header?: never; path: { contactId: string; secretId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The contact secret is about to be authenticated */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the secret to authenticate */ id: string; /** @description The URL to authenticate the secret */ url: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; revokeContactSecret: { parameters: { query?: never; header?: never; path: { contactId: string; secretId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The contact secret was revoked successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the revoked secret */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; verifyContactSecret: { parameters: { query?: never; header?: never; path: { contactId: string; secretId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The contact secret was verified successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the verified secret */ id: string; /** * @description The status of the secret * @enum {string} */ status: "unauthenticated" | "authenticated"; action?: { /** * @description The type of action to take * @enum {string} */ type: "authenticate"; /** @description The URL to authenticate the secret */ url: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listContactSecrets: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; }; header?: never; path: { contactId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The list of secrets was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The type of the secret */ type: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The type of the secret */ type: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listContactSpaces: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; }; header?: never; path: { contactId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The list of spaces was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact id assigned to this space */ contactId?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact id assigned to this space */ contactId?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listContactTasks: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; }; header?: never; path: { contactId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The list of tasks was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact id assigned to this task */ contactId?: string; /** @description The bot associated with the task */ botId?: string; /** @description The schedule of the task */ schedule?: string; /** @description The IANA timezone identifier used to evaluate the task schedule. */ timezone?: string | null; /** @description The session duration of the task execution (in milliseconds) */ sessionDuration?: number | null; /** @description The maximum number of iterations per task execution */ maxIterations?: number; /** @description The maximum time per task execution (in milliseconds) */ maxTime?: number; /** * @description The task execution status * @enum {string} */ status?: "idle" | "running" | "canceled"; /** * @description The task execution outcome * @enum {string} */ outcome?: "pending" | "success" | "failure"; /** @description The timestamp (ms) of the last task execution */ lastRunAt?: number | null; /** @description The timestamp (ms) of the next scheduled task execution */ nextRunAt?: number | null; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact id assigned to this task */ contactId?: string; /** @description The bot associated with the task */ botId?: string; /** @description The schedule of the task */ schedule?: string; /** @description The IANA timezone identifier used to evaluate the task schedule. */ timezone?: string | null; /** @description The session duration of the task execution (in milliseconds) */ sessionDuration?: number | null; /** @description The maximum number of iterations per task execution */ maxIterations?: number; /** @description The maximum time per task execution (in milliseconds) */ maxTime?: number; /** * @description The task execution status * @enum {string} */ status?: "idle" | "running" | "canceled"; /** * @description The task execution outcome * @enum {string} */ outcome?: "pending" | "success" | "failure"; /** @description The timestamp (ms) of the last task execution */ lastRunAt?: number | null; /** @description The timestamp (ms) of the next scheduled task execution */ nextRunAt?: number | null; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateContact: { parameters: { query?: never; header?: never; path: { contactId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The fingerprint of the contact */ fingerprint?: string; /** @description The email address of the contact */ email?: string; /** @description The phone number of the contact */ phone?: string; /** @description The nickname of the contact */ nick?: string; /** @description The preferences of the contact */ preferences?: string; /** @description The timestamp (ms) when the contact was verified */ verifiedAt?: number; }; }; }; responses: { /** @description The contact was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the updated contact */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createContact: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The fingerprint of the contact */ fingerprint?: string; /** @description The email address of the contact */ email?: string; /** @description The phone number of the contact */ phone?: string; /** @description The nickname of the contact */ nick?: string; /** @description The preferences of the contact */ preferences?: string; /** @description The timestamp (ms) when the contact was verified */ verifiedAt?: number; }; }; }; responses: { /** @description The contact was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created contact */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; ensureContact: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The fingerprint of the contact */ fingerprint: string; /** @description The email address of the contact */ email?: string; /** @description The phone number of the contact */ phone?: string; /** @description The nickname of the contact */ nick?: string; /** @description The preferences of the contact */ preferences?: string; /** @description The timestamp (ms) when the contact was verified */ verifiedAt?: number; }; }; }; responses: { /** @description The contact was ensured successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the ensured contact */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; exportContacts: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of contacts was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The fingerprint of the contact */ fingerprint: string; /** @description The email address of the contact */ email?: string; /** @description The phone number of the contact */ phone?: string; /** @description The nickname of the contact */ nick?: string; /** @description The preferences of the contact */ preferences?: string; /** @description The timestamp (ms) when the contact was verified */ verifiedAt?: number; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The fingerprint of the contact */ fingerprint: string; /** @description The email address of the contact */ email?: string; /** @description The phone number of the contact */ phone?: string; /** @description The nickname of the contact */ nick?: string; /** @description The preferences of the contact */ preferences?: string; /** @description The timestamp (ms) when the contact was verified */ verifiedAt?: number; }; }; "text/csv": string; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listContacts: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of contacts was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The fingerprint of the contact */ fingerprint: string; /** @description The email address of the contact */ email?: string; /** @description The phone number of the contact */ phone?: string; /** @description The nickname of the contact */ nick?: string; /** @description The preferences of the contact */ preferences?: string; /** @description The timestamp (ms) when the contact was verified */ verifiedAt?: number; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The fingerprint of the contact */ fingerprint: string; /** @description The email address of the contact */ email?: string; /** @description The phone number of the contact */ phone?: string; /** @description The nickname of the contact */ nick?: string; /** @description The preferences of the contact */ preferences?: string; /** @description The timestamp (ms) when the contact was verified */ verifiedAt?: number; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listConversationAttachments: { parameters: { query?: { cursor?: string; take?: number; }; header?: never; path: { conversationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The attachments were listed successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The stored attachment file name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The inferred attachment MIME type */ type?: string; /** @description The attachment size in bytes */ size?: number; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; uploadConversationAttachment: { parameters: { query?: never; header?: never; path: { conversationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The file to upload either as http: or data: URL */ file?: string; } | { /** @description The file definition to upload */ file?: { /** @description The file type */ type: string; /** @description The file size */ size: number; /** @description The file name */ name?: string; }; }; "multipart/form-data": { /** * Format: binary * @description The file to upload */ file: string; }; "*/*": string; }; }; responses: { /** @description The file was uploaded successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the upload file */ id: string; /** @description The name of the uploaded file */ name?: string; /** @description The request required to upload the file */ uploadRequest?: { /** @description The HTTP method to use */ method: string; /** @description The HTTP url to use */ url: string; /** @description The HTTP headers to use */ headers: Record; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; compactConversation: { parameters: { query?: never; header?: never; path: { conversationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The conversation was compacted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created checkpoint message, or the conversation ID if there was nothing to compact */ id: string; /** @description The compacted text of the messages, or an empty string if there was nothing to compact */ text: string; /** @description Usage information */ usage: { /** @description The tokens used in this exchange */ token: number; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; completeConversationMessage: { parameters: { query?: never; header?: { /** @description The timezone to use for the request */ "X-Timezone"?: string; }; path: { conversationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The text of the message to send. Omit to continue receiving from the existing conversation state without sending a new user message. */ text?: string; /** @description Known entities */ entities?: { /** @description The entity type */ type: string; /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the entity */ text: string; replacement?: { /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the replacement */ text: string; }; }[]; /** @description An array of functions to be added to the conversation */ functions?: { /** @description The name of the function (must be a valid JS identifier, max 64 chars) */ name: string; /** @description The description of the function */ description: string; /** @description JSON Schema definition for the function parameters */ parameters: { /** * @description The schema type, must be "object" * @enum {string} */ type: "object"; /** @description Object property definitions */ properties: { [key: string]: unknown; }; /** @description Required property names */ required?: string[]; }; /** @description The result of the function execution */ result?: { /** @description The data returned by the function (can be any type) */ data: unknown; } | { /** @description The channel for streaming function results */ channel: string; }; /** @description Configuration for when this function should be automatically called */ call?: { /** @description If true, this function will be force-called at the start of the conversation */ start?: boolean; /** @description If true, this function will be force-called at the end of the conversation */ end?: boolean; }; }[]; /** @description Extensions to enhance the bot's capabilities */ extensions?: { /** @description Additional backstory for the bot */ backstory?: string; /** @description Inline datasets to provide additional context */ datasets?: { /** @description The name of the dataset */ name?: string; /** @description The description of the dataset */ description?: string; /** @description The records in the dataset */ records: { /** @description The text content of the record */ text: string; /** @description Additional metadata for the record */ meta?: Record; }[]; }[]; /** @description Inline skillsets to provide additional abilities */ skillsets?: { /** @description The name of the skillset */ name?: string; /** @description The description of the skillset */ description?: string; /** @description The abilities in the skillset */ abilities: { /** @description The name of the ability */ name: string; /** @description The description of the ability */ description: string; /** @description The instruction for the ability */ instruction: string; /** @description Optional secret ID for the ability */ secretId?: string; /** @description Additional metadata for the ability */ meta?: Record; }[]; }[]; /** @description Feature flags to enable specific bot capabilities */ features?: { /** @description The name of the feature to enable */ name: string; /** @description Optional configuration options for the feature */ options?: { [key: string]: unknown; }; }[]; }; /** @description Execution limits to control conversation processing bounds */ limits?: { /** @description Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses. */ iterations?: number; /** @description Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition. */ continuations?: number; /** @description Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation. */ calls?: number; }; }; }; }; responses: { /** @description The next message in the conversation completed successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created message */ id: string; /** @description The text of the message received */ text: string; /** @description Usage information */ usage: { /** @description The tokens used in this exchange */ token: number; }; /** @description Information about why the completion ended */ end: { /** * @description The reason why the completion ended * @enum {string} */ reason: "length" | "stop" | "activity" | "abort" | "error" | "iteration"; }; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "result"; data: { /** @description The ID of the created message */ id: string; /** @description The text of the message received */ text: string; /** @description Usage information */ usage: { /** @description The tokens used in this exchange */ token: number; }; /** @description Information about why the completion ended */ end: { /** * @description The reason why the completion ended * @enum {string} */ reason: "length" | "stop" | "activity" | "abort" | "error" | "iteration"; }; }; } | ({ /** * @description The type of event * @enum {string} */ type: "error"; /** @description The data for the event */ data: { /** @description The error message */ message: string; }; } | { /** * @description The type of event * @enum {string} */ type: "token"; /** @description The data for the event */ data: { /** @description The token generated */ token: string; }; } | { /** * @description The type of event * @enum {string} */ type: "reasoningToken"; /** @description The data for the event */ data: { /** @description The token generated */ token: string; }; } | { /** * @description The type of event * @enum {string} */ type: "message"; /** @description A message in the conversation */ data: { /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; }; } | { /** * @description The type of event * @enum {string} */ type: "abort"; /** @description Information about an abort event in a streamed response */ data: { /** @description The abort reason if available */ reason?: unknown; /** @description The function or tool associated with the abort */ functionName?: string; }; } | { /** * @description The type of event * @enum {string} */ type: "completeBegin"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "completeEnd"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "waitForChannelMessageBegin"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "waitForChannelMessageEnd"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "usage"; /** @description The data for the event */ data: { /** @description The model used */ model: string; /** @description The number of input tokens used */ inputTokensUsed: number; /** @description The number of output tokens used */ outputTokensUsed: number; }; }); }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; upsertConversationContact: { parameters: { query?: never; header?: never; path: { conversationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The fingerprint of the contact */ fingerprint?: string; /** @description The email address of the contact */ email?: string; /** @description The phone number of the contact */ phone?: string; /** @description The nickname of the contact */ nick?: string; }; }; }; responses: { /** @description The contact was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created contact */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteConversation: { parameters: { query?: never; header?: never; path: { conversationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The conversation was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted conversation */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; dispatchStatefulConversation: { parameters: { query?: never; header?: { /** @description The timezone to use for the request */ "X-Timezone"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The text of the message to send. Omit to continue receiving from the existing conversation state without sending a new user message. */ text?: string; /** @description Known entities */ entities?: { /** @description The entity type */ type: string; /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the entity */ text: string; replacement?: { /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the replacement */ text: string; }; }[]; /** @description An array of functions to be added to the conversation */ functions?: { /** @description The name of the function (must be a valid JS identifier, max 64 chars) */ name: string; /** @description The description of the function */ description: string; /** @description JSON Schema definition for the function parameters */ parameters: { /** * @description The schema type, must be "object" * @enum {string} */ type: "object"; /** @description Object property definitions */ properties: { [key: string]: unknown; }; /** @description Required property names */ required?: string[]; }; /** @description The result of the function execution */ result?: { /** @description The data returned by the function (can be any type) */ data: unknown; } | { /** @description The channel for streaming function results */ channel: string; }; /** @description Configuration for when this function should be automatically called */ call?: { /** @description If true, this function will be force-called at the start of the conversation */ start?: boolean; /** @description If true, this function will be force-called at the end of the conversation */ end?: boolean; }; }[]; /** @description Extensions to enhance the bot's capabilities */ extensions?: { /** @description Additional backstory for the bot */ backstory?: string; /** @description Inline datasets to provide additional context */ datasets?: { /** @description The name of the dataset */ name?: string; /** @description The description of the dataset */ description?: string; /** @description The records in the dataset */ records: { /** @description The text content of the record */ text: string; /** @description Additional metadata for the record */ meta?: Record; }[]; }[]; /** @description Inline skillsets to provide additional abilities */ skillsets?: { /** @description The name of the skillset */ name?: string; /** @description The description of the skillset */ description?: string; /** @description The abilities in the skillset */ abilities: { /** @description The name of the ability */ name: string; /** @description The description of the ability */ description: string; /** @description The instruction for the ability */ instruction: string; /** @description Optional secret ID for the ability */ secretId?: string; /** @description Additional metadata for the ability */ meta?: Record; }[]; }[]; /** @description Feature flags to enable specific bot capabilities */ features?: { /** @description The name of the feature to enable */ name: string; /** @description Optional configuration options for the feature */ options?: { [key: string]: unknown; }; }[]; }; /** @description Execution limits to control conversation processing bounds */ limits?: { /** @description Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses. */ iterations?: number; /** @description Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition. */ continuations?: number; /** @description Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation. */ calls?: number; }; /** @description A unique ID to deduplicate dispatch requests */ channelId?: string; }; }; }; responses: { /** @description The dispatch was queued successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The channel ID to subscribe to for completion events */ channelId: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; downvoteConversation: { parameters: { query?: never; header?: never; path: { conversationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** * @description The value of the downvote * @default -100 */ value?: number; /** @description The reason for the downvote */ reason?: string; }; }; }; responses: { /** @description The message was downvoted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The conversation ID of the downvoted conversation */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchConversation: { parameters: { query?: never; header?: never; path: { conversationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The conversation was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact id assigned to this conversation */ contactId?: string; /** @description The task id assigned to this conversation */ taskId?: string; } & ({ /** @description The ID of the bot this configuration is using */ botId?: string; } | { /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; }); }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteConversationMessage: { parameters: { query?: never; header?: never; path: { conversationId: string; messageId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The message was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted message */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; downvoteConversationMessage: { parameters: { query?: never; header?: never; path: { conversationId: string; messageId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** * @description The value of the downvote * @default -100 */ value?: number; /** @description The reason for the downvote */ reason?: string; }; }; }; responses: { /** @description The message was downvoted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the downvoted message */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchConversationMessage: { parameters: { query?: never; header?: never; path: { conversationId: string; messageId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The message was fetched successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the fetched message */ text: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; synthesizeConversationMessage: { parameters: { query?: never; header?: never; path: { conversationId: string; messageId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The message was synthesized successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the synthesized message */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateConversationMessage: { parameters: { query?: never; header?: never; path: { conversationId: string; messageId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** * @description The type of the message * @enum {string} */ type?: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The updated text of the message */ text?: string; /** @description Known entities */ entities?: { /** @description The entity type */ type: string; /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the entity */ text: string; replacement?: { /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the replacement */ text: string; }; }[]; }; }; }; responses: { /** @description The message was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the updated message */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; upvoteConversationMessage: { parameters: { query?: never; header?: never; path: { conversationId: string; messageId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** * @description The value of the upvote * @default 100 */ value?: number; /** @description The reason for the upvote */ reason?: string; }; }; }; responses: { /** @description The message was upvoted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the upvoted message */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createConversationMessage: { parameters: { query?: never; header?: never; path: { conversationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; /** @description Known entities */ entities?: { /** @description The entity type */ type: string; /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the entity */ text: string; replacement?: { /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the replacement */ text: string; }; }[]; }; }; }; responses: { /** @description The message was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created message */ id: string; /** @description Extracted entities from the message */ entities: { /** @description The entity type */ type: string; /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the entity */ text: string; replacement?: { /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the replacement */ text: string; }; }[]; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listConversationMessages: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; }; header?: never; path: { conversationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The messages were listed successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; receiveConversationMessage: { parameters: { query?: never; header?: never; path: { conversationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description An array of functions to be added to the conversation */ functions?: { /** @description The name of the function (must be a valid JS identifier, max 64 chars) */ name: string; /** @description The description of the function */ description: string; /** @description JSON Schema definition for the function parameters */ parameters: { /** * @description The schema type, must be "object" * @enum {string} */ type: "object"; /** @description Object property definitions */ properties: { [key: string]: unknown; }; /** @description Required property names */ required?: string[]; }; /** @description The result of the function execution */ result?: { /** @description The data returned by the function (can be any type) */ data: unknown; } | { /** @description The channel for streaming function results */ channel: string; }; /** @description Configuration for when this function should be automatically called */ call?: { /** @description If true, this function will be force-called at the start of the conversation */ start?: boolean; /** @description If true, this function will be force-called at the end of the conversation */ end?: boolean; }; }[]; /** @description Extensions to enhance the bot's capabilities */ extensions?: { /** @description Additional backstory for the bot */ backstory?: string; /** @description Inline datasets to provide additional context */ datasets?: { /** @description The name of the dataset */ name?: string; /** @description The description of the dataset */ description?: string; /** @description The records in the dataset */ records: { /** @description The text content of the record */ text: string; /** @description Additional metadata for the record */ meta?: Record; }[]; }[]; /** @description Inline skillsets to provide additional abilities */ skillsets?: { /** @description The name of the skillset */ name?: string; /** @description The description of the skillset */ description?: string; /** @description The abilities in the skillset */ abilities: { /** @description The name of the ability */ name: string; /** @description The description of the ability */ description: string; /** @description The instruction for the ability */ instruction: string; /** @description Optional secret ID for the ability */ secretId?: string; /** @description Additional metadata for the ability */ meta?: Record; }[]; }[]; /** @description Feature flags to enable specific bot capabilities */ features?: { /** @description The name of the feature to enable */ name: string; /** @description Optional configuration options for the feature */ options?: { [key: string]: unknown; }; }[]; }; }; }; }; responses: { /** @description The message was received successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created message */ id: string; /** @description The text of the message received */ text: string; /** @description Usage information */ usage: { /** @description The tokens used in this exchange */ token: number; }; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type?: "result"; data?: { /** @description The ID of the created message */ id: string; /** @description The text of the message received */ text: string; /** @description Usage information */ usage: { /** @description The tokens used in this exchange */ token: number; }; }; } | ({ /** * @description The type of event * @enum {string} */ type: "error"; /** @description The data for the event */ data: { /** @description The error message */ message: string; }; } | { /** * @description The type of event * @enum {string} */ type: "token"; /** @description The data for the event */ data: { /** @description The token generated */ token: string; }; } | { /** * @description The type of event * @enum {string} */ type: "reasoningToken"; /** @description The data for the event */ data: { /** @description The token generated */ token: string; }; } | { /** * @description The type of event * @enum {string} */ type: "message"; /** @description A message in the conversation */ data: { /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; }; } | { /** * @description The type of event * @enum {string} */ type: "abort"; /** @description Information about an abort event in a streamed response */ data: { /** @description The abort reason if available */ reason?: unknown; /** @description The function or tool associated with the abort */ functionName?: string; }; } | { /** * @description The type of event * @enum {string} */ type: "completeBegin"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "completeEnd"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "waitForChannelMessageBegin"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "waitForChannelMessageEnd"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "usage"; /** @description The data for the event */ data: { /** @description The model used */ model: string; /** @description The number of input tokens used */ inputTokensUsed: number; /** @description The number of output tokens used */ outputTokensUsed: number; }; }); }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; sendConversationMessage: { parameters: { query?: never; header?: never; path: { conversationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The text of the message to send */ text: string; /** @description Known entities */ entities?: { /** @description The entity type */ type: string; /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the entity */ text: string; replacement?: { /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the replacement */ text: string; }; }[]; /** @description An array of functions to be added to the conversation */ functions?: { /** @description The name of the function (must be a valid JS identifier, max 64 chars) */ name: string; /** @description The description of the function */ description: string; /** @description JSON Schema definition for the function parameters */ parameters: { /** * @description The schema type, must be "object" * @enum {string} */ type: "object"; /** @description Object property definitions */ properties: { [key: string]: unknown; }; /** @description Required property names */ required?: string[]; }; /** @description The result of the function execution */ result?: { /** @description The data returned by the function (can be any type) */ data: unknown; } | { /** @description The channel for streaming function results */ channel: string; }; /** @description Configuration for when this function should be automatically called */ call?: { /** @description If true, this function will be force-called at the start of the conversation */ start?: boolean; /** @description If true, this function will be force-called at the end of the conversation */ end?: boolean; }; }[]; /** @description Extensions to enhance the bot's capabilities */ extensions?: { /** @description Additional backstory for the bot */ backstory?: string; /** @description Inline datasets to provide additional context */ datasets?: { /** @description The name of the dataset */ name?: string; /** @description The description of the dataset */ description?: string; /** @description The records in the dataset */ records: { /** @description The text content of the record */ text: string; /** @description Additional metadata for the record */ meta?: Record; }[]; }[]; /** @description Inline skillsets to provide additional abilities */ skillsets?: { /** @description The name of the skillset */ name?: string; /** @description The description of the skillset */ description?: string; /** @description The abilities in the skillset */ abilities: { /** @description The name of the ability */ name: string; /** @description The description of the ability */ description: string; /** @description The instruction for the ability */ instruction: string; /** @description Optional secret ID for the ability */ secretId?: string; /** @description Additional metadata for the ability */ meta?: Record; }[]; }[]; /** @description Feature flags to enable specific bot capabilities */ features?: { /** @description The name of the feature to enable */ name: string; /** @description Optional configuration options for the feature */ options?: { [key: string]: unknown; }; }[]; }; }; }; }; responses: { /** @description The message was sent successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the sent message */ id: string; /** @description Extracted entities from the message */ entities: { /** @description The entity type */ type: string; /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the entity */ text: string; replacement?: { /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the replacement */ text: string; }; }[]; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "result"; data: { /** @description The ID of the sent message */ id: string; /** @description Extracted entities from the message */ entities: { /** @description The entity type */ type: string; /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the entity */ text: string; replacement?: { /** @description Start offset */ begin: number; /** @description End offset */ end: number; /** @description The text value of the replacement */ text: string; }; }[]; }; } | ({ /** * @description The type of event * @enum {string} */ type: "error"; /** @description The data for the event */ data: { /** @description The error message */ message: string; }; } | { /** * @description The type of event * @enum {string} */ type: "token"; /** @description The data for the event */ data: { /** @description The token generated */ token: string; }; } | { /** * @description The type of event * @enum {string} */ type: "reasoningToken"; /** @description The data for the event */ data: { /** @description The token generated */ token: string; }; } | { /** * @description The type of event * @enum {string} */ type: "message"; /** @description A message in the conversation */ data: { /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; }; } | { /** * @description The type of event * @enum {string} */ type: "abort"; /** @description Information about an abort event in a streamed response */ data: { /** @description The abort reason if available */ reason?: unknown; /** @description The function or tool associated with the abort */ functionName?: string; }; } | { /** * @description The type of event * @enum {string} */ type: "completeBegin"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "completeEnd"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "waitForChannelMessageBegin"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "waitForChannelMessageEnd"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "usage"; /** @description The data for the event */ data: { /** @description The model used */ model: string; /** @description The number of input tokens used */ inputTokensUsed: number; /** @description The number of output tokens used */ outputTokensUsed: number; }; }); }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createConversationSession: { parameters: { query?: never; header?: never; path: { conversationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The maximum amount of time this session will stay open */ durationInSeconds?: number; }; }; }; responses: { /** @description The session was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the conversation */ id: string; /** @description The token for this conversation */ token: string; /** @description The time the token will expire in milliseconds */ expiresAt: number; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateConversation: { parameters: { query?: never; header?: never; path: { conversationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The contact id assigned to this conversation */ contactId?: string; /** @description The task id assigned to this conversation */ taskId?: string; /** @description The space id assigned to this conversation */ spaceId?: string; } & ({ /** @description The ID of the bot this configuration is using */ botId?: string; } | { /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; }); }; }; responses: { /** @description The conversation was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the updated conversation */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; upvoteConversation: { parameters: { query?: never; header?: never; path: { conversationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** * @description The value of the upvote * @default 100 */ value?: number; /** @description The reason for the upvote */ reason?: string; }; }; }; responses: { /** @description The conversation was upvoted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the upvoted conversation */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchConversationUsage: { parameters: { query?: { from?: string; to?: string; }; header?: never; path: { conversationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Conversation usage statistics retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Total number of BASE tokens used */ tokens?: number; /** @description Total number of messages */ messages?: number; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; compactConversationStateless: { parameters: { query?: never; header?: { /** @description The timezone to use for the request */ "X-Timezone"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description An array of messages to be compacted */ messages: { /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; }[]; /** @description Extensions to enhance the bot's capabilities */ extensions?: { /** @description Additional backstory for the bot */ backstory?: string; /** @description Inline datasets to provide additional context */ datasets?: { /** @description The name of the dataset */ name?: string; /** @description The description of the dataset */ description?: string; /** @description The records in the dataset */ records: { /** @description The text content of the record */ text: string; /** @description Additional metadata for the record */ meta?: Record; }[]; }[]; /** @description Inline skillsets to provide additional abilities */ skillsets?: { /** @description The name of the skillset */ name?: string; /** @description The description of the skillset */ description?: string; /** @description The abilities in the skillset */ abilities: { /** @description The name of the ability */ name: string; /** @description The description of the ability */ description: string; /** @description The instruction for the ability */ instruction: string; /** @description Optional secret ID for the ability */ secretId?: string; /** @description Additional metadata for the ability */ meta?: Record; }[]; }[]; /** @description Feature flags to enable specific bot capabilities */ features?: { /** @description The name of the feature to enable */ name: string; /** @description Optional configuration options for the feature */ options?: { [key: string]: unknown; }; }[]; }; } & ({ /** @description The ID of the bot this configuration is using */ botId?: string; } | { /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; }); }; }; responses: { /** @description The messages were compacted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The compacted text of the messages, or an empty string if there was nothing to compact */ text: string; /** @description Usage information */ usage: { /** @description The tokens used in this exchange */ token: number; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; completeConversation: { parameters: { query?: never; header?: { /** @description The timezone to use for the request */ "X-Timezone"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description An array of messages to be added to the conversation */ messages: { /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; }[]; /** @description An array of attachments to be added to the conversation */ attachments?: { /** @description The URL of the attachment */ url?: string; }[]; /** @description The contact ID to associate with this conversation */ contactId?: string | { /** @description A unique fingerprint to identify the contact */ fingerprint: string; /** @description The name of the contact */ name?: string; /** @description A description of the contact */ description?: string; /** @description The email address of the contact */ email?: string; /** @description The phone number of the contact */ phone?: string; /** @description A nickname for the contact */ nick?: string; /** @description Additional metadata for the contact */ meta?: { [key: string]: unknown; }; }; /** @description An array of functions to be added to the conversation */ functions?: { /** @description The name of the function (must be a valid JS identifier, max 64 chars) */ name: string; /** @description The description of the function */ description: string; /** @description JSON Schema definition for the function parameters */ parameters: { /** * @description The schema type, must be "object" * @enum {string} */ type: "object"; /** @description Object property definitions */ properties: { [key: string]: unknown; }; /** @description Required property names */ required?: string[]; }; /** @description The result of the function execution */ result?: { /** @description The data returned by the function (can be any type) */ data: unknown; } | { /** @description The channel for streaming function results */ channel: string; }; /** @description Configuration for when this function should be automatically called */ call?: { /** @description If true, this function will be force-called at the start of the conversation */ start?: boolean; /** @description If true, this function will be force-called at the end of the conversation */ end?: boolean; }; }[]; /** @description Extensions to enhance the bot's capabilities */ extensions?: { /** @description Additional backstory for the bot */ backstory?: string; /** @description Inline datasets to provide additional context */ datasets?: { /** @description The name of the dataset */ name?: string; /** @description The description of the dataset */ description?: string; /** @description The records in the dataset */ records: { /** @description The text content of the record */ text: string; /** @description Additional metadata for the record */ meta?: Record; }[]; }[]; /** @description Inline skillsets to provide additional abilities */ skillsets?: { /** @description The name of the skillset */ name?: string; /** @description The description of the skillset */ description?: string; /** @description The abilities in the skillset */ abilities: { /** @description The name of the ability */ name: string; /** @description The description of the ability */ description: string; /** @description The instruction for the ability */ instruction: string; /** @description Optional secret ID for the ability */ secretId?: string; /** @description Additional metadata for the ability */ meta?: Record; }[]; }[]; /** @description Feature flags to enable specific bot capabilities */ features?: { /** @description The name of the feature to enable */ name: string; /** @description Optional configuration options for the feature */ options?: { [key: string]: unknown; }; }[]; }; /** @description Execution limits to control conversation processing bounds */ limits?: { /** @description Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses. */ iterations?: number; /** @description Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition. */ continuations?: number; /** @description Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation. */ calls?: number; }; } & ({ /** @description The ID of the bot this configuration is using */ botId?: string; } | { /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; }); }; }; responses: { /** @description The next message in the conversation completed successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The text of the message received */ text: string; /** @description Usage information */ usage: { /** @description The tokens used in this exchange */ token: number; }; /** @description Information about why the completion ended */ end: { /** * @description The reason why the completion ended * @enum {string} */ reason: "length" | "stop" | "activity" | "abort" | "error" | "iteration"; }; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "result"; data: { /** @description The text of the message received */ text: string; /** @description Usage information */ usage: { /** @description The tokens used in this exchange */ token: number; }; /** @description Information about why the completion ended */ end: { /** * @description The reason why the completion ended * @enum {string} */ reason: "length" | "stop" | "activity" | "abort" | "error" | "iteration"; }; }; } | ({ /** * @description The type of event * @enum {string} */ type: "error"; /** @description The data for the event */ data: { /** @description The error message */ message: string; }; } | { /** * @description The type of event * @enum {string} */ type: "token"; /** @description The data for the event */ data: { /** @description The token generated */ token: string; }; } | { /** * @description The type of event * @enum {string} */ type: "reasoningToken"; /** @description The data for the event */ data: { /** @description The token generated */ token: string; }; } | { /** * @description The type of event * @enum {string} */ type: "message"; /** @description A message in the conversation */ data: { /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; }; } | { /** * @description The type of event * @enum {string} */ type: "abort"; /** @description Information about an abort event in a streamed response */ data: { /** @description The abort reason if available */ reason?: unknown; /** @description The function or tool associated with the abort */ functionName?: string; }; } | { /** * @description The type of event * @enum {string} */ type: "completeBegin"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "completeEnd"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "waitForChannelMessageBegin"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "waitForChannelMessageEnd"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "usage"; /** @description The data for the event */ data: { /** @description The model used */ model: string; /** @description The number of input tokens used */ inputTokensUsed: number; /** @description The number of output tokens used */ outputTokensUsed: number; }; }); }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createConversation: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The contact id assigned to this conversation */ contactId?: string; /** @description The task id assigned to this conversation */ taskId?: string; /** @description The space id assigned to this conversation */ spaceId?: string; /** @description An array of messages to be added to the conversation */ messages?: { /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; }[]; } & ({ /** @description The ID of the bot this configuration is using */ botId?: string; } | { /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; }); }; }; responses: { /** @description The conversation was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created conversation */ id: string; /** @description An array of messages included in the conversation */ messages?: { /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; }[]; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; dispatchConversation: { parameters: { query?: never; header?: { /** @description The timezone to use for the request */ "X-Timezone"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description An array of messages to be added to the conversation */ messages: { /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; }[]; /** @description An array of attachments to be added to the conversation */ attachments?: { /** @description The URL of the attachment */ url?: string; }[]; /** @description The contact ID to associate with this conversation */ contactId?: string | { /** @description A unique fingerprint to identify the contact */ fingerprint: string; /** @description The name of the contact */ name?: string; /** @description A description of the contact */ description?: string; /** @description The email address of the contact */ email?: string; /** @description The phone number of the contact */ phone?: string; /** @description A nickname for the contact */ nick?: string; /** @description Additional metadata for the contact */ meta?: { [key: string]: unknown; }; }; /** @description An array of functions to be added to the conversation */ functions?: { /** @description The name of the function (must be a valid JS identifier, max 64 chars) */ name: string; /** @description The description of the function */ description: string; /** @description JSON Schema definition for the function parameters */ parameters: { /** * @description The schema type, must be "object" * @enum {string} */ type: "object"; /** @description Object property definitions */ properties: { [key: string]: unknown; }; /** @description Required property names */ required?: string[]; }; /** @description The result of the function execution */ result?: { /** @description The data returned by the function (can be any type) */ data: unknown; } | { /** @description The channel for streaming function results */ channel: string; }; /** @description Configuration for when this function should be automatically called */ call?: { /** @description If true, this function will be force-called at the start of the conversation */ start?: boolean; /** @description If true, this function will be force-called at the end of the conversation */ end?: boolean; }; }[]; /** @description Extensions to enhance the bot's capabilities */ extensions?: { /** @description Additional backstory for the bot */ backstory?: string; /** @description Inline datasets to provide additional context */ datasets?: { /** @description The name of the dataset */ name?: string; /** @description The description of the dataset */ description?: string; /** @description The records in the dataset */ records: { /** @description The text content of the record */ text: string; /** @description Additional metadata for the record */ meta?: Record; }[]; }[]; /** @description Inline skillsets to provide additional abilities */ skillsets?: { /** @description The name of the skillset */ name?: string; /** @description The description of the skillset */ description?: string; /** @description The abilities in the skillset */ abilities: { /** @description The name of the ability */ name: string; /** @description The description of the ability */ description: string; /** @description The instruction for the ability */ instruction: string; /** @description Optional secret ID for the ability */ secretId?: string; /** @description Additional metadata for the ability */ meta?: Record; }[]; }[]; /** @description Feature flags to enable specific bot capabilities */ features?: { /** @description The name of the feature to enable */ name: string; /** @description Optional configuration options for the feature */ options?: { [key: string]: unknown; }; }[]; }; /** @description Execution limits to control conversation processing bounds */ limits?: { /** @description Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses. */ iterations?: number; /** @description Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition. */ continuations?: number; /** @description Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation. */ calls?: number; }; /** @description A unique channel ID to subscribe to for completion events */ channelId?: string; } & ({ /** @description The ID of the bot this configuration is using */ botId?: string; } | { /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; }); }; }; responses: { /** @description The dispatch was queued successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The channel ID to subscribe to for completion events */ channelId: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; exportConversations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of conversations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: ({ /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact id assigned to this conversation */ contactId?: string; /** @description The task id assigned to this conversation */ taskId?: string; /** @description The space id assigned to this conversation */ spaceId?: string; } & ({ /** @description The ID of the bot this configuration is using */ botId?: string; } | { /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; }))[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description A bot configuration or reference */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact id assigned to this conversation */ contactId?: string; /** @description The task id assigned to this conversation */ taskId?: string; /** @description The space id assigned to this conversation */ spaceId?: string; } & ({ /** @description The ID of the bot this configuration is using */ botId?: string; } | { /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; }); }; "text/csv": string; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listConversations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of conversations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: ({ /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact id assigned to this conversation */ contactId?: string; /** @description The task id assigned to this conversation */ taskId?: string; /** @description The space id assigned to this conversation */ spaceId?: string; } & ({ /** @description The ID of the bot this configuration is using */ botId?: string; } | { /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; }))[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description A bot configuration or reference */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact id assigned to this conversation */ contactId?: string; /** @description The task id assigned to this conversation */ taskId?: string; /** @description The space id assigned to this conversation */ spaceId?: string; } & ({ /** @description The ID of the bot this configuration is using */ botId?: string; } | { /** * @description A model definition * @example gpt-5.4 */ model?: string; /** @description The backstory this configuration is using */ backstory?: string; /** @description The id of the dataset this configuration is using */ datasetId?: string; /** @description The id of the skillset this configuration is using */ skillsetId?: string; /** @description The privacy flag for this configuration */ privacy?: boolean; /** @description The moderation flag for this configuration */ moderation?: boolean; }); }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteDataset: { parameters: { query?: never; header?: never; path: { datasetId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The dataset was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted dataset */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchDataset: { parameters: { query?: never; header?: never; path: { datasetId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The dataset was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The storage class for the dataset */ store: string; /** @description The reranker class for the dataset */ reranker?: string; /** @description The total number of tokens for each record */ recordMaxTokens?: number; /** @description The minimum score to filter search results by */ searchMinScore?: number; /** @description The total number of records to return during search */ searchMaxRecords?: number; /** @description The total number of tokens to use during search */ searchMaxTokens?: number; /** @description An instruction to include before found records */ matchInstruction?: string; /** @description An instruction to include if no records where found */ mismatchInstruction?: string; /** @description A list of separators to use when tokenizing text */ separators?: string; /** * @description The dataset visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; attachDatasetFile: { parameters: { query?: never; header?: never; path: { datasetId: string; fileId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** * @description The dataset file attachment type * @enum {string} */ type?: "source"; }; }; }; responses: { /** @description The dataset file that was attached successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the dataset file */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; detachDatasetFile: { parameters: { query?: never; header?: never; path: { datasetId: string; fileId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Delete records associated with the file */ deleteRecords?: boolean; }; }; }; responses: { /** @description The dataset file that was detached successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the dataset file */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; syncDatasetFile: { parameters: { query?: never; header?: never; path: { datasetId: string; fileId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The dataset file that was synced successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the dataset file */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listDatasetFiles: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; }; header?: never; path: { datasetId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The list of files was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** * @description The file visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The file visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteDatasetRecord: { parameters: { query?: never; header?: never; path: { datasetId: string; recordId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The record was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted record */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchDatasetRecord: { parameters: { query?: never; header?: never; path: { datasetId: string; recordId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The dataset was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The text of the dataset record */ text: string; /** @description The source of the dataset record */ source?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateDatasetRecord: { parameters: { query?: never; header?: never; path: { datasetId: string; recordId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The text to update the record with */ text?: string; /** @description The source to update the record with */ source?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; }; }; }; responses: { /** @description The record was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the updated record */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createDatasetRecord: { parameters: { query?: never; header?: never; path: { datasetId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The text of the record */ text: string; /** @description The source of the record */ source?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; }; }; }; responses: { /** @description The record was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created record */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; exportDatasetRecords: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; }; header?: never; path: { datasetId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The export of dataset records was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; text: string; source?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; text: string; source?: string; }; }; "text/csv": string; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listDatasetRecords: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; }; header?: never; path: { datasetId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The list of records was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; text: string; source?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; text: string; source?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchDataset: { parameters: { query?: never; header?: never; path: { datasetId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The keyword/phrase to search for */ search: string; filter?: { [key: string]: string | number | boolean | { $eq: string | number | boolean; } | { $ne: string | number | boolean; } | { $gt: number; } | { $gte: number; } | { $lt: number; } | { $lte: number; }; }; }; }; }; responses: { /** @description The search was successful */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the dataset that was searched */ id: string; /** @description An array of records matching the search query */ records: { id: string; text: string; source?: string; meta?: Record; score: number; }[]; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateDataset: { parameters: { query?: never; header?: never; path: { datasetId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The reranker class for the dataset */ reranker?: string; /** @description The total number of tokens to for each record */ recordMaxTokens?: number; /** @description The minimum score to filter search results by */ searchMinScore?: number; /** @description The total number of records to return during search */ searchMaxRecords?: number; /** @description The total number of tokens to use during search */ searchMaxTokens?: number; /** @description An instruction to include before found records */ matchInstruction?: string; /** @description An instruction to include if no records where found */ mismatchInstruction?: string; /** @description A list of separators to use when tokenizing text */ separators?: string; /** * @description The dataset visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; responses: { /** @description The dataset was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the updated dataset */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createDataset: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The storage class for the dataset */ store?: string; /** @description The reranker class for the dataset */ reranker?: string; /** @description The total number of tokens for each record */ recordMaxTokens?: number; /** @description The minimum score to filter search results by */ searchMinScore?: number; /** @description The total number of records to return during search */ searchMaxRecords?: number; /** @description The total number of tokens to use during search */ searchMaxTokens?: number; /** @description An instruction to include before found records */ matchInstruction?: string; /** @description An instruction to include if no records where found */ mismatchInstruction?: string; /** @description A list of separators to use when tokenizing text */ separators?: string; /** * @description The dataset visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; responses: { /** @description The dataset was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created dataset */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listDatasets: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of datasets was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The storage class for the dataset */ store: string; /** @description The reranker class for the dataset */ reranker?: string; /** @description The total number of tokens for each record */ recordMaxTokens?: number; /** @description The minimum score to filter search results by */ searchMinScore?: number; /** @description The total number of records to return during search */ searchMaxRecords?: number; /** @description The total number of tokens to use during search */ searchMaxTokens?: number; /** @description An instruction to include before found records */ matchInstruction?: string; /** @description An instruction to include if no records where found */ mismatchInstruction?: string; /** @description A list of separators to use when tokenizing text */ separators?: string; /** * @description The dataset visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The storage class for the dataset */ store: string; /** @description The reranker class for the dataset */ reranker?: string; /** @description The total number of tokens for each record */ recordMaxTokens?: number; /** @description The minimum score to filter search results by */ searchMinScore?: number; /** @description The total number of records to return during search */ searchMaxRecords?: number; /** @description The total number of tokens to use during search */ searchMaxTokens?: number; /** @description An instruction to include before found records */ matchInstruction?: string; /** @description An instruction to include if no records where found */ mismatchInstruction?: string; /** @description A list of separators to use when tokenizing text */ separators?: string; /** * @description The dataset visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; exportEventLogs: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of events was exported successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The type of event (e.g., 'conversation.create') */ type: string; /** @description Related conversation ID if applicable */ conversationId?: string; /** @description Related task ID if applicable */ taskId?: string; /** @description Related contact ID if applicable */ contactId?: string; /** @description Related blueprint ID if applicable */ blueprintId?: string; /** @description Related bot ID if applicable */ botId?: string; /** @description Related dataset ID if applicable */ datasetId?: string; /** @description Related record ID if applicable */ recordId?: string; /** @description Related skillset ID if applicable */ skillsetId?: string; /** @description Related ability ID if applicable */ abilityId?: string; /** @description Related file ID if applicable */ fileId?: string; /** @description Related secret ID if applicable */ secretId?: string; /** @description Related portal ID if applicable */ portalId?: string; /** @description Related widget integration ID if applicable */ widgetIntegrationId?: string; /** @description Related Slack integration ID if applicable */ slackIntegrationId?: string; /** @description Related Discord integration ID if applicable */ discordIntegrationId?: string; /** @description Related Microsoft Teams integration ID if applicable */ microsoftteamsIntegrationId?: string; /** @description Related Google Chat integration ID if applicable */ googlechatIntegrationId?: string; /** @description Related WhatsApp integration ID if applicable */ whatsappIntegrationId?: string; /** @description Related Messenger integration ID if applicable */ messengerIntegrationId?: string; /** @description Related Telegram integration ID if applicable */ telegramIntegrationId?: string; /** @description Related Twilio integration ID if applicable */ twilioIntegrationId?: string; /** @description Related email integration ID if applicable */ emailIntegrationId?: string; /** @description Related sitemap integration ID if applicable */ sitemapIntegrationId?: string; /** @description Related Notion integration ID if applicable */ notionIntegrationId?: string; /** @description Related trigger integration ID if applicable */ triggerIntegrationId?: string; /** @description Related support integration ID if applicable */ supportIntegrationId?: string; /** @description Related extract integration ID if applicable */ extractIntegrationId?: string; /** @description Related MCP server integration ID if applicable */ mcpserverIntegrationId?: string; /** @description Related webhook ID if applicable */ webhookId?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The type of event (e.g., 'conversation.create') */ type: string; /** @description Related conversation ID if applicable */ conversationId?: string; /** @description Related task ID if applicable */ taskId?: string; /** @description Related contact ID if applicable */ contactId?: string; /** @description Related blueprint ID if applicable */ blueprintId?: string; /** @description Related bot ID if applicable */ botId?: string; /** @description Related dataset ID if applicable */ datasetId?: string; /** @description Related record ID if applicable */ recordId?: string; /** @description Related skillset ID if applicable */ skillsetId?: string; /** @description Related ability ID if applicable */ abilityId?: string; /** @description Related file ID if applicable */ fileId?: string; /** @description Related secret ID if applicable */ secretId?: string; /** @description Related portal ID if applicable */ portalId?: string; /** @description Related widget integration ID if applicable */ widgetIntegrationId?: string; /** @description Related Slack integration ID if applicable */ slackIntegrationId?: string; /** @description Related Discord integration ID if applicable */ discordIntegrationId?: string; /** @description Related Microsoft Teams integration ID if applicable */ microsoftteamsIntegrationId?: string; /** @description Related Google Chat integration ID if applicable */ googlechatIntegrationId?: string; /** @description Related WhatsApp integration ID if applicable */ whatsappIntegrationId?: string; /** @description Related Messenger integration ID if applicable */ messengerIntegrationId?: string; /** @description Related Telegram integration ID if applicable */ telegramIntegrationId?: string; /** @description Related Twilio integration ID if applicable */ twilioIntegrationId?: string; /** @description Related email integration ID if applicable */ emailIntegrationId?: string; /** @description Related sitemap integration ID if applicable */ sitemapIntegrationId?: string; /** @description Related Notion integration ID if applicable */ notionIntegrationId?: string; /** @description Related trigger integration ID if applicable */ triggerIntegrationId?: string; /** @description Related support integration ID if applicable */ supportIntegrationId?: string; /** @description Related extract integration ID if applicable */ extractIntegrationId?: string; /** @description Related MCP server integration ID if applicable */ mcpserverIntegrationId?: string; /** @description Related webhook ID if applicable */ webhookId?: string; }; }; "text/csv": string; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listEventLogs: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of events was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The type of event (e.g., 'conversation.create') */ type: string; /** @description Related conversation ID if applicable */ conversationId?: string; /** @description Related task ID if applicable */ taskId?: string; /** @description Related contact ID if applicable */ contactId?: string; /** @description Related blueprint ID if applicable */ blueprintId?: string; /** @description Related bot ID if applicable */ botId?: string; /** @description Related dataset ID if applicable */ datasetId?: string; /** @description Related record ID if applicable */ recordId?: string; /** @description Related skillset ID if applicable */ skillsetId?: string; /** @description Related ability ID if applicable */ abilityId?: string; /** @description Related file ID if applicable */ fileId?: string; /** @description Related secret ID if applicable */ secretId?: string; /** @description Related portal ID if applicable */ portalId?: string; /** @description Related widget integration ID if applicable */ widgetIntegrationId?: string; /** @description Related Slack integration ID if applicable */ slackIntegrationId?: string; /** @description Related Discord integration ID if applicable */ discordIntegrationId?: string; /** @description Related Microsoft Teams integration ID if applicable */ microsoftteamsIntegrationId?: string; /** @description Related Google Chat integration ID if applicable */ googlechatIntegrationId?: string; /** @description Related WhatsApp integration ID if applicable */ whatsappIntegrationId?: string; /** @description Related Messenger integration ID if applicable */ messengerIntegrationId?: string; /** @description Related Telegram integration ID if applicable */ telegramIntegrationId?: string; /** @description Related Twilio integration ID if applicable */ twilioIntegrationId?: string; /** @description Related email integration ID if applicable */ emailIntegrationId?: string; /** @description Related sitemap integration ID if applicable */ sitemapIntegrationId?: string; /** @description Related Notion integration ID if applicable */ notionIntegrationId?: string; /** @description Related trigger integration ID if applicable */ triggerIntegrationId?: string; /** @description Related support integration ID if applicable */ supportIntegrationId?: string; /** @description Related extract integration ID if applicable */ extractIntegrationId?: string; /** @description Related MCP server integration ID if applicable */ mcpserverIntegrationId?: string; /** @description Related webhook ID if applicable */ webhookId?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The type of event (e.g., 'conversation.create') */ type: string; /** @description Related conversation ID if applicable */ conversationId?: string; /** @description Related task ID if applicable */ taskId?: string; /** @description Related contact ID if applicable */ contactId?: string; /** @description Related blueprint ID if applicable */ blueprintId?: string; /** @description Related bot ID if applicable */ botId?: string; /** @description Related dataset ID if applicable */ datasetId?: string; /** @description Related record ID if applicable */ recordId?: string; /** @description Related skillset ID if applicable */ skillsetId?: string; /** @description Related ability ID if applicable */ abilityId?: string; /** @description Related file ID if applicable */ fileId?: string; /** @description Related secret ID if applicable */ secretId?: string; /** @description Related portal ID if applicable */ portalId?: string; /** @description Related widget integration ID if applicable */ widgetIntegrationId?: string; /** @description Related Slack integration ID if applicable */ slackIntegrationId?: string; /** @description Related Discord integration ID if applicable */ discordIntegrationId?: string; /** @description Related Microsoft Teams integration ID if applicable */ microsoftteamsIntegrationId?: string; /** @description Related Google Chat integration ID if applicable */ googlechatIntegrationId?: string; /** @description Related WhatsApp integration ID if applicable */ whatsappIntegrationId?: string; /** @description Related Messenger integration ID if applicable */ messengerIntegrationId?: string; /** @description Related Telegram integration ID if applicable */ telegramIntegrationId?: string; /** @description Related Twilio integration ID if applicable */ twilioIntegrationId?: string; /** @description Related email integration ID if applicable */ emailIntegrationId?: string; /** @description Related sitemap integration ID if applicable */ sitemapIntegrationId?: string; /** @description Related Notion integration ID if applicable */ notionIntegrationId?: string; /** @description Related trigger integration ID if applicable */ triggerIntegrationId?: string; /** @description Related support integration ID if applicable */ supportIntegrationId?: string; /** @description Related extract integration ID if applicable */ extractIntegrationId?: string; /** @description Related MCP server integration ID if applicable */ mcpserverIntegrationId?: string; /** @description Related webhook ID if applicable */ webhookId?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; subscribeEventLogs: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Number of recent historical events to replay before * subscribing to live updates. When provided, the subscriber * will first receive up to this many recent events that were * logged before the subscription started. This is useful for * catching up on events that may have occurred during * connection setup. * */ historyLength?: number; }; }; }; responses: { /** @description Successfully subscribed to event logs */ 200: { headers: { [name: string]: unknown; }; content: { "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The type of event (e.g., 'conversation.create') */ type: string; /** @description Related conversation ID if applicable */ conversationId?: string; /** @description Related task ID if applicable */ taskId?: string; /** @description Related contact ID if applicable */ contactId?: string; /** @description Related blueprint ID if applicable */ blueprintId?: string; /** @description Related bot ID if applicable */ botId?: string; /** @description Related dataset ID if applicable */ datasetId?: string; /** @description Related record ID if applicable */ recordId?: string; /** @description Related skillset ID if applicable */ skillsetId?: string; /** @description Related ability ID if applicable */ abilityId?: string; /** @description Related file ID if applicable */ fileId?: string; /** @description Related secret ID if applicable */ secretId?: string; /** @description Related portal ID if applicable */ portalId?: string; /** @description Related widget integration ID if applicable */ widgetIntegrationId?: string; /** @description Related Slack integration ID if applicable */ slackIntegrationId?: string; /** @description Related Discord integration ID if applicable */ discordIntegrationId?: string; /** @description Related Microsoft Teams integration ID if applicable */ microsoftteamsIntegrationId?: string; /** @description Related Google Chat integration ID if applicable */ googlechatIntegrationId?: string; /** @description Related WhatsApp integration ID if applicable */ whatsappIntegrationId?: string; /** @description Related Messenger integration ID if applicable */ messengerIntegrationId?: string; /** @description Related Telegram integration ID if applicable */ telegramIntegrationId?: string; /** @description Related Twilio integration ID if applicable */ twilioIntegrationId?: string; /** @description Related email integration ID if applicable */ emailIntegrationId?: string; /** @description Related sitemap integration ID if applicable */ sitemapIntegrationId?: string; /** @description Related Notion integration ID if applicable */ notionIntegrationId?: string; /** @description Related trigger integration ID if applicable */ triggerIntegrationId?: string; /** @description Related support integration ID if applicable */ supportIntegrationId?: string; /** @description Related extract integration ID if applicable */ extractIntegrationId?: string; /** @description Related MCP server integration ID if applicable */ mcpserverIntegrationId?: string; /** @description Related webhook ID if applicable */ webhookId?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteFile: { parameters: { query?: never; header?: never; path: { fileId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The file was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted file */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; downloadFile: { parameters: { query?: never; header?: never; path: { fileId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The file was downloaded successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The URL to download the file */ url: string; }; "*/*": string; }; }; /** @description The file resource exists but has no content stored yet */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchFile: { parameters: { query?: never; header?: never; path: { fileId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The file was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The file visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; syncFile: { parameters: { query?: never; header?: never; path: { fileId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The file was synced successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the file */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateFile: { parameters: { query?: never; header?: never; path: { fileId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The file visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; responses: { /** @description The file was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the updated file */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; uploadFile: { parameters: { query?: never; header?: never; path: { fileId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The file to upload either as http: or data: URL */ file?: string; } | { /** @description The file definition to upload */ file?: { /** @description The file type */ type: string; /** @description The file size */ size: number; /** @description The file name */ name?: string; }; }; "multipart/form-data": { /** * Format: binary * @description The file to upload */ file: string; }; "*/*": string; }; }; responses: { /** @description The file was upload successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the upload file */ id: string; /** @description The request required to upload the file */ uploadRequest?: { /** @description The HTTP method to use */ method: string; /** @description The HTTP url to use */ url: string; /** @description The HTTP headers to use */ headers: Record; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createFile: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The file visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; responses: { /** @description The file was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created file */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listFiles: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of files was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The file visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The file visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteDiscordIntegration: { parameters: { query?: never; header?: never; path: { discordIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Discord integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted Discord integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchDiscordIntegration: { parameters: { query?: never; header?: never; path: { discordIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Discord integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The Discord application ID */ appId?: string; /** @description The Discord command handle */ handle?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The chat session duration */ sessionDuration?: number; /** @description Restrict which Discord users can interact with this integration. Accepts Discord user IDs (17-18 digit snowflakes) or @username, one per line. Use * to allow all senders. Leave empty to deny all. */ allowFrom?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; setupDiscordIntegration: { parameters: { query?: never; header?: never; path: { discordIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Discord integration was setup successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the setup Discord integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateDiscordIntegration: { parameters: { query?: never; header?: never; path: { discordIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The Discord application ID */ appId?: string; /** @description The Discord bot token */ botToken?: string; /** @description The Discord public key */ publicKey?: string; /** @description The Discord command handle */ handle?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The chat session duration */ sessionDuration?: number; /** @description Restrict which Discord users can interact with this integration. Accepts Discord user IDs (17-18 digit snowflakes) or @username, one per line. Use * to allow all senders. Leave empty to deny all. */ allowFrom?: string; }; }; }; responses: { /** @description The Discord integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Discord Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createDiscordIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The Discord application ID */ appId?: string; /** @description The Discord bot token */ botToken?: string; /** @description The Discord public key */ publicKey?: string; /** @description The Discord command handle */ handle?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The chat session duration */ sessionDuration?: number; /** @description Restrict which Discord users can interact with this integration. Accepts Discord user IDs (17-18 digit snowflakes) or @username, one per line. Use * to allow all senders. Leave empty to deny all. */ allowFrom?: string; }; }; }; responses: { /** @description The Discord integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Discord Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listDiscordIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of Discord integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The Discord application ID */ appId?: string; /** @description The Discord command handle */ handle?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The chat session duration */ sessionDuration?: number; /** @description Restrict which Discord users can interact with this integration. Accepts Discord user IDs (17-18 digit snowflakes) or @username, one per line. Use * to allow all senders. Leave empty to deny all. */ allowFrom?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The Discord application ID */ appId?: string; /** @description The Discord command handle */ handle?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The chat session duration */ sessionDuration?: number; /** @description Restrict which Discord users can interact with this integration. Accepts Discord user IDs (17-18 digit snowflakes) or @username, one per line. Use * to allow all senders. Leave empty to deny all. */ allowFrom?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteEmailIntegration: { parameters: { query?: never; header?: never; path: { emailIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Email integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted Email integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchEmailIntegration: { parameters: { query?: never; header?: never; path: { emailIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Email integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Weather the bot supports attachments */ attachments?: boolean; /** @description Newline-separated list of email patterns allowed to send messages to this integration */ allowFrom?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; setupEmailIntegration: { parameters: { query?: never; header?: never; path: { emailIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Email integration was successfully setup */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Email Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateEmailIntegration: { parameters: { query?: never; header?: never; path: { emailIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Weather the bot supports attachments */ attachments?: boolean; /** @description Newline-separated list of email patterns allowed to send messages to this integration */ allowFrom?: string; }; }; }; responses: { /** @description The Email integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Email Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createEmailIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Weather the bot supports attachments */ attachments?: boolean; /** @description Newline-separated list of email patterns allowed to send messages to this integration */ allowFrom?: string; }; }; }; responses: { /** @description The Email integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Email Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listEmailIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of Email integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Weather the bot supports attachments */ attachments?: boolean; /** @description Newline-separated list of email patterns allowed to send messages to this integration */ allowFrom?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Weather the bot supports attachments */ attachments?: boolean; /** @description Newline-separated list of email patterns allowed to send messages to this integration */ allowFrom?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteExtractIntegration: { parameters: { query?: never; header?: never; path: { extractIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Extract integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted Extract integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchExtractIntegration: { parameters: { query?: never; header?: never; path: { extractIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Extract integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the Bot to use */ botId: string; /** @description The configured extraction schema */ schema?: { [key: string]: unknown; }; /** @description Optional webhook to receive the extracted data */ request?: string; /** @description The language model to use for data extraction */ model?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; exportExtractIntegrationItems: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; }; header?: never; path: { extractIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The extract integration items were exported successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items?: { /** @description The unique identifier of the item */ id: string; /** @description The ID of the extract integration */ extractIntegrationId: string; /** @description The ID of the conversation from which data was extracted */ conversationId?: string; /** @description The extracted data in YAML-serializable format */ data: { [key: string]: unknown; }; /** @description The timestamp when the item was created */ createdAt?: string; /** @description The timestamp when the item was last updated */ updatedAt?: string; }[]; /** @description Cursor for fetching the next page */ cursor?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listExtractIntegrationItems: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; }; header?: never; path: { extractIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The list of extract integration items was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items?: { /** @description The unique identifier of the item */ id: string; /** @description The ID of the extract integration */ extractIntegrationId: string; /** @description The ID of the conversation from which data was extracted */ conversationId?: string; /** @description The extracted data matching the integration schema */ data: { [key: string]: unknown; }; /** @description The timestamp when the item was created */ createdAt?: string; /** @description The timestamp when the item was last updated */ updatedAt?: string; }[]; /** @description Cursor for fetching the next page */ cursor?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; triggerExtractIntegration: { parameters: { query?: never; header?: never; path: { extractIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Array of conversation IDs to process */ conversationIds?: string[]; /** @description Number of recent conversations to process (default 20) */ sample?: number; }; }; }; responses: { /** @description Extract integration trigger initiated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description ID of the extract integration */ id: string; /** @description Number of conversations queued for processing */ triggered: number; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateExtractIntegration: { parameters: { query?: never; header?: never; path: { extractIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the Bot to use */ botId?: string; /** @description The configured extraction schema */ schema?: { [key: string]: unknown; }; /** @description Optional webhook to receive the extracted data */ request?: string; /** @description The language model to use for data extraction */ model?: string; }; }; }; responses: { /** @description The Extract integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Extract Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createExtractIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the Bot to use */ botId?: string; /** @description The configured extraction schema */ schema?: { [key: string]: unknown; }; /** @description Optional webhook to receive the extracted data */ request?: string; /** @description The language model to use for data extraction */ model?: string; }; }; }; responses: { /** @description The Extract integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Extract Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listExtractIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of Extract integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the Bot to use */ botId: string; /** @description The configured extraction schema */ schema?: { [key: string]: unknown; }; /** @description Optional webhook to receive the extracted data */ request?: string; /** @description The language model to use for data extraction */ model?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the Bot to use */ botId: string; /** @description The configured extraction schema */ schema?: { [key: string]: unknown; }; /** @description Optional webhook to receive the extracted data */ request?: string; /** @description The language model to use for data extraction */ model?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteGooglechatIntegration: { parameters: { query?: never; header?: never; path: { googlechatIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Google Chat integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted Google Chat integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchGooglechatIntegration: { parameters: { query?: never; header?: never; path: { googlechatIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Google Chat integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The service account key (returned as '********' if configured, null otherwise) */ serviceAccountKey?: string; /** @description The Google Cloud project number for JWT verification */ projectNumber?: string; /** @description Whether to collect contacts */ contactCollection?: boolean; /** @description The session duration for the integration */ sessionDuration?: number; /** @description Whether file attachment processing is enabled */ attachments?: boolean; /** @description The auto-respond configuration */ autoRespond?: string; /** @description The allowed senders for this integration */ allowFrom?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; setupGooglechatIntegration: { parameters: { query?: never; header?: never; path: { googlechatIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Google Chat integration was set up successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Google Chat Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateGooglechatIntegration: { parameters: { query?: never; header?: never; path: { googlechatIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The Google service account JSON key for sending messages */ serviceAccountKey?: string; /** @description The Google Cloud project number for JWT verification */ projectNumber?: string; /** @description Whether to collect contacts */ contactCollection?: boolean; /** @description The session duration for the integration */ sessionDuration?: number; /** @description Whether file attachment processing is enabled */ attachments?: boolean; /** @description The auto-respond configuration */ autoRespond?: string; /** @description The allowed senders for this integration */ allowFrom?: string; }; }; }; responses: { /** @description The Google Chat integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Google Chat Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createGooglechatIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The Google service account JSON key for sending messages via the Chat REST API */ serviceAccountKey?: string; /** @description The Google Cloud project number used to verify incoming event JWT audience claims */ projectNumber?: string; /** @description Whether to collect contacts */ contactCollection?: boolean; /** @description The session duration for the Google Chat integration */ sessionDuration?: number; /** @description Whether file attachment processing is enabled */ attachments?: boolean; /** @description Configure automatic response behavior. Use '@all' to respond to all messages, '@agent ' for agent-powered decisions, or custom instructions for lightweight LLM filtering. Null/empty defaults to DMs and direct messages only. */ autoRespond?: string; /** @description Restrict which Google Chat users can interact with this integration. Accepts user resource names (users/USER_ID) or * to allow all. One per line. */ allowFrom?: string; }; }; }; responses: { /** @description The Google Chat integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Google Chat Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listGooglechatIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of Google Chat integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The service account key (returned as '********' if configured, null otherwise) */ serviceAccountKey?: string; /** @description The Google Cloud project number for JWT verification */ projectNumber?: string; /** @description Whether to collect contacts */ contactCollection?: boolean; /** @description The session duration for the integration */ sessionDuration?: number; /** @description Whether file attachment processing is enabled */ attachments?: boolean; /** @description The auto-respond configuration */ autoRespond?: string; /** @description The allowed senders for this integration */ allowFrom?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The service account key (returned as '********' if configured, null otherwise) */ serviceAccountKey?: string; /** @description The Google Cloud project number for JWT verification */ projectNumber?: string; /** @description Whether to collect contacts */ contactCollection?: boolean; /** @description The session duration for the integration */ sessionDuration?: number; /** @description Whether file attachment processing is enabled */ attachments?: boolean; /** @description The auto-respond configuration */ autoRespond?: string; /** @description The allowed senders for this integration */ allowFrom?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteInstagramIntegration: { parameters: { query?: never; header?: never; path: { instagramIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Instagram integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted Instagram integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchInstagramIntegration: { parameters: { query?: never; header?: never; path: { instagramIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Instagram integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The Instagram integration verify token */ verifyToken: string; /** @description The Instagram integration access token (returned as '********' if configured, null otherwise) */ accessToken?: string; /** @description Whether to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Whether the bot supports attachments */ attachments?: boolean; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; setupInstagramIntegration: { parameters: { query?: never; header?: never; path: { instagramIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Instagram integration was successfully setup */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Instagram Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateInstagramIntegration: { parameters: { query?: never; header?: never; path: { instagramIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The Instagram integration access token */ accessToken?: string; /** @description Whether to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Whether the bot supports attachments */ attachments?: boolean; }; }; }; responses: { /** @description The Instagram integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Instagram Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createInstagramIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The Instagram integration access token */ accessToken?: string; /** @description Whether to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Whether the bot supports attachments */ attachments?: boolean; }; }; }; responses: { /** @description The Instagram integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Instagram Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listInstagramIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of Instagram integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The Instagram integration verify token */ verifyToken: string; /** @description The Instagram integration access token (returned as '********' if configured, null otherwise) */ accessToken?: string; /** @description Whether to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Whether the bot supports attachments */ attachments?: boolean; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The Instagram integration verify token */ verifyToken: string; /** @description The Instagram integration access token (returned as '********' if configured, null otherwise) */ accessToken?: string; /** @description Whether to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Whether the bot supports attachments */ attachments?: boolean; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteMcpServerIntegration: { parameters: { query?: never; header?: never; path: { mcpserverIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The McpServer integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted McpServer integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchMcpServerIntegration: { parameters: { query?: never; header?: never; path: { mcpserverIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The McpServer integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the skillset */ skillsetId?: string; /** @description The ID of the OAuth connection for IdP-based authentication */ oAuthConnectionId?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateMcpServerIntegration: { parameters: { query?: never; header?: never; path: { mcpserverIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the skillset */ skillsetId?: string; /** @description The ID of the OAuth connection for IdP-based authentication */ oAuthConnectionId?: string; }; }; }; responses: { /** @description The McpServer integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the McpServer Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createMcpServerIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the skillset */ skillsetId?: string; /** @description The ID of the OAuth connection for IdP-based authentication */ oAuthConnectionId?: string; }; }; }; responses: { /** @description The McpServer integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the McpServer Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listMcpServerIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of McpServer integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the skillset */ skillsetId?: string; /** @description The ID of the OAuth connection for IdP-based authentication */ oAuthConnectionId?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the skillset */ skillsetId?: string; /** @description The ID of the OAuth connection for IdP-based authentication */ oAuthConnectionId?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteMessengerIntegration: { parameters: { query?: never; header?: never; path: { messengerIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Messenger integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted Messenger integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchMessengerIntegration: { parameters: { query?: never; header?: never; path: { messengerIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Messenger integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The Messenger integration verify token */ verifyToken: string; /** @description The Messenger integration access token (returned as '********' if configured, null otherwise) */ accessToken?: string; /** @description Whether to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Whether the bot supports attachments */ attachments?: boolean; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; setupMessengerIntegration: { parameters: { query?: never; header?: never; path: { messengerIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Messenger integration was successfully setup */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Messenger Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateMessengerIntegration: { parameters: { query?: never; header?: never; path: { messengerIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The Messenger integration access token */ accessToken?: string; /** @description Whether to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Whether the bot supports attachments */ attachments?: boolean; }; }; }; responses: { /** @description The Messenger integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Messenger Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createMessengerIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The Messenger integration access token */ accessToken?: string; /** @description Whether to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Whether the bot supports attachments */ attachments?: boolean; }; }; }; responses: { /** @description The Messenger integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Messenger Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listMessengerIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of Messenger integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The Messenger integration verify token */ verifyToken: string; /** @description The Messenger integration access token (returned as '********' if configured, null otherwise) */ accessToken?: string; /** @description Whether to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Whether the bot supports attachments */ attachments?: boolean; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The Messenger integration verify token */ verifyToken: string; /** @description The Messenger integration access token (returned as '********' if configured, null otherwise) */ accessToken?: string; /** @description Whether to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Whether the bot supports attachments */ attachments?: boolean; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteMicrosoftteamsIntegration: { parameters: { query?: never; header?: never; path: { microsoftteamsIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Microsoft Teams integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted Microsoft Teams integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchMicrosoftteamsIntegration: { parameters: { query?: never; header?: never; path: { microsoftteamsIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Microsoft Teams integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The Microsoft Bot Framework Application ID */ botFrameworkAppId?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The chat session duration */ sessionDuration?: number; /** @description The allowed senders for this integration */ allowFrom?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; setupMicrosoftteamsIntegration: { parameters: { query?: never; header?: never; path: { microsoftteamsIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Microsoft Teams integration was set up successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Microsoft Teams integration that was set up */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateMicrosoftteamsIntegration: { parameters: { query?: never; header?: never; path: { microsoftteamsIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The Microsoft Bot Framework Application ID */ botFrameworkAppId?: string; /** @description The Microsoft Bot Framework Application Secret */ botFrameworkAppSecret?: string; /** @description The Microsoft Entra tenant ID */ tenantId?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The chat session duration */ sessionDuration?: number; /** @description The allowed senders for this integration */ allowFrom?: string; }; }; }; responses: { /** @description The Microsoft Teams integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Microsoft Teams integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createMicrosoftteamsIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The Microsoft Bot Framework Application ID */ botFrameworkAppId?: string; /** @description The Microsoft Bot Framework Application Secret */ botFrameworkAppSecret?: string; /** @description The Microsoft Entra tenant ID */ tenantId?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The chat session duration */ sessionDuration?: number; /** @description The allowed senders for this integration */ allowFrom?: string; }; }; }; responses: { /** @description The Microsoft Teams integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Microsoft Teams integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listMicrosoftteamsIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of Microsoft Teams integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The Microsoft Bot Framework Application ID */ botFrameworkAppId?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The chat session duration */ sessionDuration?: number; /** @description The allowed senders for this integration */ allowFrom?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The Microsoft Bot Framework Application ID */ botFrameworkAppId?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The chat session duration */ sessionDuration?: number; /** @description The allowed senders for this integration */ allowFrom?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteNotionIntegration: { parameters: { query?: never; header?: never; path: { notionIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Notion integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted Notion integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchNotionIntegration: { parameters: { query?: never; header?: never; path: { notionIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Notion integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the dataset to sync into */ datasetId: string; /** @description The Notion API token (returned as '********' if configured, null otherwise) */ token?: string; /** * @description The sync status of an integration * @enum {string} */ syncStatus?: "pending" | "synced" | "error"; /** @description The sync schedule */ syncSchedule?: string; /** * Format: date-time * @description The timestamp of the last successful sync */ lastSyncedAt?: string; /** @description The time in milliseconds until records expire */ expiresIn?: number; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; syncNotionIntegration: { parameters: { query?: never; header?: never; path: { notionIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Notion integration was synced successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the synced Notion integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateNotionIntegration: { parameters: { query?: never; header?: never; path: { notionIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the dataset to sync into */ datasetId?: string; /** @description The Notion API token */ token?: string; /** @description The sync schedule */ syncSchedule?: string; /** @description The time in milliseconds until records expire */ expiresIn?: number; }; }; }; responses: { /** @description The Notion integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Notion Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createNotionIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the dataset to sync into */ datasetId?: string; /** @description The Notion API token */ token?: string; /** @description The sync schedule */ syncSchedule?: string; /** @description The time in milliseconds until records expire */ expiresIn?: number; }; }; }; responses: { /** @description The Notion integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Notion Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listNotionIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of Notion integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the dataset to sync into */ datasetId: string; /** @description The Notion API token (returned as '********' if configured, null otherwise) */ token?: string; /** * @description The sync status of an integration * @enum {string} */ syncStatus?: "pending" | "synced" | "error"; /** @description The sync schedule */ syncSchedule?: string; /** * Format: date-time * @description The timestamp of the last successful sync */ lastSyncedAt?: string; /** @description The time in milliseconds until records expire */ expiresIn?: number; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the dataset to sync into */ datasetId: string; /** @description The Notion API token (returned as '********' if configured, null otherwise) */ token?: string; /** * @description The sync status of an integration * @enum {string} */ syncStatus?: "pending" | "synced" | "error"; /** @description The sync schedule */ syncSchedule?: string; /** * Format: date-time * @description The timestamp of the last successful sync */ lastSyncedAt?: string; /** @description The time in milliseconds until records expire */ expiresIn?: number; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteSitemapIntegration: { parameters: { query?: never; header?: never; path: { sitemapIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Sitemap integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted Sitemap integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchSitemapIntegration: { parameters: { query?: never; header?: never; path: { sitemapIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Sitemap integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the dataset used in the Sitemap integration */ datasetId: string; /** @description The URL to use for this Sitemap integration */ url?: string; /** @description The glob rules to use for this Sitemap integration */ glob?: string; /** @description The selector rules to use for this Sitemap integration */ selectors?: string; /** @description Indicates if the Sitemap integration should use JavaScript during the spidering process */ javascript?: boolean; /** * @description The sync status of an integration * @enum {string} */ syncStatus?: "pending" | "synced" | "error"; /** @description The sync schedule to use for this Sitemap integration */ syncSchedule?: string; /** * Format: date-time * @description The timestamp of the last successful sync */ lastSyncedAt?: string; /** @description Record expiry in milliseconds */ expiresIn?: number; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; syncSitemapIntegration: { parameters: { query?: never; header?: never; path: { sitemapIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Sitemap integration was scheduled for syncing successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Sitemap Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateSitemapIntegration: { parameters: { query?: never; header?: never; path: { sitemapIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the dataset to use for this Sitemap integration */ datasetId?: string; /** @description The URL to use for this Sitemap integration */ url?: string; /** @description The glob rules to use for this Sitemap integration */ glob?: string; /** @description The selector rules to use for this Sitemap integration */ selectors?: string; /** @description Indicates if the Sitemap integration should use JavaScript during the spidering process */ javascript?: boolean; /** @description The sync schedule to use for this Sitemap integration */ syncSchedule?: string; /** @description Record expiry in milliseconds */ expiresIn?: number; }; }; }; responses: { /** @description The Sitemap integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Sitemap Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createSitemapIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the dataset to use for this Sitemap integration */ datasetId?: string; /** @description The URL to use for this Sitemap integration */ url?: string; /** @description The glob rules to use for this Sitemap integration */ glob?: string; /** @description The selector rules to use for this Sitemap integration */ selectors?: string; /** @description Indicates if the Sitemap integration should use JavaScript during the spidering process */ javascript?: boolean; /** @description The sync schedule to use for this Sitemap integration */ syncSchedule?: string; /** @description Record expiry in milliseconds */ expiresIn?: number; }; }; }; responses: { /** @description The Sitemap integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Sitemap Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSitemapIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of Sitemap integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the dataset used in the Sitemap integration */ datasetId: string; /** @description The URL to use for this Sitemap integration */ url?: string; /** @description The glob rules to use for this Sitemap integration */ glob?: string; /** @description The selector rules to use for this Sitemap integration */ selectors?: string; /** @description Indicates if the Sitemap integration should use JavaScript during the spidering process */ javascript?: boolean; /** * @description The sync status of an integration * @enum {string} */ syncStatus?: "pending" | "synced" | "error"; /** @description The sync schedule to use for this Sitemap integration */ syncSchedule?: string; /** * Format: date-time * @description The timestamp of the last successful sync */ lastSyncedAt?: string; /** @description Record expiry in milliseconds */ expiresIn?: number; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the dataset used in the Sitemap integration */ datasetId: string; /** @description The URL to use for this Sitemap integration */ url?: string; /** @description The glob rules to use for this Sitemap integration */ glob?: string; /** @description The selector rules to use for this Sitemap integration */ selectors?: string; /** @description Indicates if the Sitemap integration should use JavaScript during the spidering process */ javascript?: boolean; /** * @description The sync status of an integration * @enum {string} */ syncStatus?: "pending" | "synced" | "error"; /** @description The sync schedule to use for this Sitemap integration */ syncSchedule?: string; /** * Format: date-time * @description The timestamp of the last successful sync */ lastSyncedAt?: string; /** @description Record expiry in milliseconds */ expiresIn?: number; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteSkillServerIntegration: { parameters: { query?: never; header?: never; path: { skillserverIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The SkillServer integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted SkillServer integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchSkillServerIntegration: { parameters: { query?: never; header?: never; path: { skillserverIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The SkillServer integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the skillset */ skillsetId?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchSkillServerManual: { parameters: { query?: never; header?: never; path: { skillserverIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The skill server manual */ 200: { headers: { [name: string]: unknown; }; content: { "text/markdown": string; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; invokeSkillServerAbility: { parameters: { query?: { format?: "json"; session?: string; }; header?: never; path: { skillserverIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The name of the ability to invoke (as listed in the manual) */ ability: string; /** @description The ability input */ input?: Record; }; }; }; responses: { /** @description The ability was invoked */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": string; "application/json": { result?: unknown; error?: string | null; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateSkillServerIntegration: { parameters: { query?: never; header?: never; path: { skillserverIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the skillset */ skillsetId?: string; }; }; }; responses: { /** @description The SkillServer integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the SkillServer Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createSkillServerIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the skillset */ skillsetId?: string; }; }; }; responses: { /** @description The SkillServer integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the SkillServer Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSkillServerIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of SkillServer integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the skillset */ skillsetId?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the skillset */ skillsetId?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteSlackIntegration: { parameters: { query?: never; header?: never; path: { slackIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Slack integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted Slack integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchSlackIntegration: { parameters: { query?: never; header?: never; path: { slackIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Slack integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The signing secret (returned as '********' if configured, null otherwise) */ signingSecret?: string; /** @description The bot token (returned as '********' if configured, null otherwise) */ botToken?: string; /** @description The user token (returned as '********' if configured, null otherwise) */ userToken?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration for the Slack integration */ sessionDuration?: number; /** @description Whether to enable references feature */ references?: boolean; /** @description Whether to enable ratings buttons feature */ ratings?: boolean; /** @description The number of visible messages outside of the new thread */ visibleMessages?: number; /** @description Configure automatic response behavior. Use '@all' to respond to all messages, '@agent ' for agent-powered decisions, or custom instructions for lightweight LLM filtering. Null/empty defaults to current behavior (DMs, mentions, threads only). */ autoRespond?: string; /** @description Restrict which Slack users or channels can interact with this integration. Accepts Slack user IDs (U…/W…), channel IDs (C…/G…/D…), @username, or */ allowFrom?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; setupSlackIntegration: { parameters: { query?: never; header?: never; path: { slackIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Slack integration was setup successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the setup Slack integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateSlackIntegration: { parameters: { query?: never; header?: never; path: { slackIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The signing secret for the Slack integration */ signingSecret?: string; /** @description The bot token for the Slack integration */ botToken?: string; /** @description The user token for the Slack integration */ userToken?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration for the Slack integration */ sessionDuration?: number; /** @description Whether to enable references feature */ references?: boolean; /** @description Whether to enable ratings buttons feature */ ratings?: boolean; /** @description The number of visible messages outside of the new thread */ visibleMessages?: number; /** @description Configure automatic response behavior. Use '@all' to respond to all messages, '@agent ' for agent-powered decisions, or custom instructions for lightweight LLM filtering. Null/empty defaults to current behavior (DMs, mentions, threads only). */ autoRespond?: string; /** @description Restrict which Slack users or channels can interact with this integration. Accepts Slack user IDs (U…/W…), channel IDs (C…/G…/D…), @username, or */ allowFrom?: string; }; }; }; responses: { /** @description The Slack integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Slack Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createSlackIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The signing secret for the Slack integration */ signingSecret?: string; /** @description The bot token for the Slack integration */ botToken?: string; /** @description The user token for the Slack integration */ userToken?: string; /** @description The session duration for the Slack integration */ sessionDuration?: number; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description Whether to enable references feature */ references?: boolean; /** @description Whether to enable ratings buttons feature */ ratings?: boolean; /** @description The number of visible messages outside of the new thread */ visibleMessages?: number; /** @description Configure automatic response behavior. Use '@all' to respond to all messages, '@agent ' for agent-powered decisions, or custom instructions for lightweight LLM filtering. Null/empty defaults to current behavior (DMs, mentions, threads only). */ autoRespond?: string; /** @description Restrict which Slack users or channels can interact with this integration. Accepts Slack user IDs (U…/W…), channel IDs (C…/G…/D…), @username, or */ allowFrom?: string; }; }; }; responses: { /** @description The Slack integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Slack Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSlackIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of Slack integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The signing secret (returned as '********' if configured, null otherwise) */ signingSecret?: string; /** @description The bot token (returned as '********' if configured, null otherwise) */ botToken?: string; /** @description The user token (returned as '********' if configured, null otherwise) */ userToken?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration for the Slack integration */ sessionDuration?: number; /** @description Whether to enable references feature */ references?: boolean; /** @description Whether to enable ratings buttons feature */ ratings?: boolean; /** @description The number of visible messages outside of the new thread */ visibleMessages?: number; /** @description Configure automatic response behavior. Use '@all' to respond to all messages, '@agent ' for agent-powered decisions, or custom instructions for lightweight LLM filtering. Null/empty defaults to current behavior (DMs, mentions, threads only). */ autoRespond?: string; /** @description Restrict which Slack users or channels can interact with this integration. Accepts Slack user IDs (U…/W…), channel IDs (C…/G…/D…), @username, or */ allowFrom?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The signing secret (returned as '********' if configured, null otherwise) */ signingSecret?: string; /** @description The bot token (returned as '********' if configured, null otherwise) */ botToken?: string; /** @description The user token (returned as '********' if configured, null otherwise) */ userToken?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration for the Slack integration */ sessionDuration?: number; /** @description Whether to enable references feature */ references?: boolean; /** @description Whether to enable ratings buttons feature */ ratings?: boolean; /** @description The number of visible messages outside of the new thread */ visibleMessages?: number; /** @description Configure automatic response behavior. Use '@all' to respond to all messages, '@agent ' for agent-powered decisions, or custom instructions for lightweight LLM filtering. Null/empty defaults to current behavior (DMs, mentions, threads only). */ autoRespond?: string; /** @description Restrict which Slack users or channels can interact with this integration. Accepts Slack user IDs (U…/W…), channel IDs (C…/G…/D…), @username, or */ allowFrom?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteSupportIntegration: { parameters: { query?: never; header?: never; path: { supportIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Support integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted Support integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchSupportIntegration: { parameters: { query?: never; header?: never; path: { supportIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Support integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId: string; /** @description The email to use */ email?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; triggerSupportIntegration: { parameters: { query?: never; header?: never; path: { supportIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description Array of conversation IDs to process */ conversationIds?: string[]; /** @description Number of recent conversations to process (default 20) */ sample?: number; }; }; }; responses: { /** @description Support integration trigger initiated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description ID of the support integration */ id: string; /** @description Number of conversations queued for processing */ triggered: number; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateSupportIntegration: { parameters: { query?: never; header?: never; path: { supportIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The email to use */ email?: string; }; }; }; responses: { /** @description The Support integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Support Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createSupportIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The email to use */ email?: string; }; }; }; responses: { /** @description The Support integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Support Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSupportIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of Support integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId: string; /** @description The email to use */ email?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description A bot configuration that can be applied without a dedicated bot instance. */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId: string; /** @description The email to use */ email?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteTelegramIntegration: { parameters: { query?: never; header?: never; path: { telegramIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Telegram integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted Telegram integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchTelegramIntegration: { parameters: { query?: never; header?: never; path: { telegramIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Telegram integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Weather the bot supports attachments */ attachments?: boolean; /** @description Newline-or-comma-separated list of allowed senders */ allowFrom?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; setupTelegramIntegration: { parameters: { query?: never; header?: never; path: { telegramIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Telegram integration was successfully setup */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Telegram Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateTelegramIntegration: { parameters: { query?: never; header?: never; path: { telegramIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The Telegram integration bot token */ botToken?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Weather the bot supports attachments */ attachments?: boolean; /** @description Newline-or-comma-separated list of allowed senders. Use @username or @numericId for users, */ allowFrom?: string; }; }; }; responses: { /** @description The Telegram integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Telegram Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createTelegramIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The Telegram integration bot token */ botToken?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Weather the bot supports attachments */ attachments?: boolean; /** @description Newline-or-comma-separated list of allowed senders. Use @username or @numericId for users, */ allowFrom?: string; }; }; }; responses: { /** @description The Telegram integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Telegram Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listTelegramIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of Telegram integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Weather the bot supports attachments */ attachments?: boolean; /** @description Newline-or-comma-separated list of allowed senders. Use @username or @numericId for users, */ allowFrom?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Weather the bot supports attachments */ attachments?: boolean; /** @description Newline-or-comma-separated list of allowed senders. Use @username or @numericId for users, */ allowFrom?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteTriggerIntegration: { parameters: { query?: never; header?: never; path: { triggerIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Trigger integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted Trigger integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchTriggerIntegration: { parameters: { query?: never; header?: never; path: { triggerIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Trigger integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The Trigger integration secret */ secret: string; /** @description When enabled the integration requires authentication */ authenticate?: boolean; /** @description The schedule for the trigger integration (interval, cron expression, ISO date, or null) */ schedule?: string | null; /** @description The IANA timezone identifier used to evaluate the trigger schedule. */ timezone?: string | null; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description The timestamp (ms) of the last trigger execution */ lastTriggerAt?: number | null; /** @description The timestamp (ms) of the next scheduled trigger execution */ nextTriggerAt?: number | null; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; invokeTriggerIntegration: { parameters: { query?: never; header?: never; path: { triggerIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Trigger integration was trigged successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the trigged Trigger integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; setupTriggerIntegration: { parameters: { query?: never; header?: never; path: { triggerIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Trigger integration was successfully setup */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Trigger Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateTriggerIntegration: { parameters: { query?: never; header?: never; path: { triggerIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description When enabled the integration requires authentication */ authenticate?: boolean; /** @description The schedule for the trigger integration (interval, cron expression, or ISO date) */ schedule?: string | null; /** * @description An optional IANA timezone identifier used when evaluating the trigger schedule. * @example America/New_York */ timezone?: string | null; /** @description The session duration (in milliseconds) */ sessionDuration?: number; }; }; }; responses: { /** @description The Trigger integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Trigger Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createTriggerIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description When enabled the integration requires authentication */ authenticate?: boolean; /** @description The schedule for the trigger integration (interval, cron expression, or ISO date) */ schedule?: string | null; /** * @description An optional IANA timezone identifier used when evaluating the trigger schedule. * @example America/New_York */ timezone?: string | null; /** @description The session duration (in milliseconds) */ sessionDuration?: number; }; }; }; responses: { /** @description The Trigger integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Trigger Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listTriggerIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of Trigger integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The Trigger integration secret */ secret: string; /** @description When enabled the integration requires authentication */ authenticate?: boolean; /** @description The schedule for the trigger integration (interval, cron expression, ISO date, or null) */ schedule?: string | null; /** @description The IANA timezone identifier used to evaluate the trigger schedule. */ timezone?: string | null; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description The timestamp (ms) of the last trigger execution */ lastTriggerAt?: number | null; /** @description The timestamp (ms) of the next scheduled trigger execution */ nextTriggerAt?: number | null; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description A bot configuration that can be applied without a dedicated bot instance. */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The Trigger integration secret */ secret: string; /** @description When enabled the integration requires authentication */ authenticate?: boolean; /** @description The schedule for the trigger integration (interval, cron expression, ISO date, or null) */ schedule?: string | null; /** @description The IANA timezone identifier used to evaluate the trigger schedule. */ timezone?: string | null; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description The timestamp (ms) of the last trigger execution */ lastTriggerAt?: number | null; /** @description The timestamp (ms) of the next scheduled trigger execution */ nextTriggerAt?: number | null; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteTwilioIntegration: { parameters: { query?: never; header?: never; path: { twilioIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Twilio integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted Twilio integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchTwilioIntegration: { parameters: { query?: never; header?: never; path: { twilioIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Twilio integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The Twilio account SID */ accountSid?: string; /** @description The voice configuration structured string */ voice?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Newline-or-comma-separated list of allowed senders */ allowFrom?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; setupTwilioIntegration: { parameters: { query?: never; header?: never; path: { twilioIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Twilio integration was successfully setup */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Twilio Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateTwilioIntegration: { parameters: { query?: never; header?: never; path: { twilioIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The Twilio account SID */ accountSid?: string; /** @description The Twilio auth token */ authToken?: string; /** @description The voice configuration structured string */ voice?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Newline-or-comma-separated list of allowed senders. Use E.164 phone numbers with or without the leading `+`. Set to `*` to allow all. Leave empty to deny all. */ allowFrom?: string; }; }; }; responses: { /** @description The Twilio integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Twilio Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createTwilioIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The Twilio account SID */ accountSid?: string; /** @description The Twilio auth token */ authToken?: string; /** @description The voice configuration structured string */ voice?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Newline-or-comma-separated list of allowed senders. Use E.164 phone numbers with or without the leading `+`. Set to `*` to allow all. Leave empty to deny all. */ allowFrom?: string; }; }; }; responses: { /** @description The Twilio integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Twilio Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listTwilioIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of Twilio integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The Twilio account SID */ accountSid?: string; /** @description The voice configuration structured string */ voice?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Newline-or-comma-separated list of allowed senders */ allowFrom?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The Twilio account SID */ accountSid?: string; /** @description The voice configuration structured string */ voice?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Newline-or-comma-separated list of allowed senders */ allowFrom?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteWhatsAppIntegration: { parameters: { query?: never; header?: never; path: { whatsappIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The WhatsApp integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted WhatsApp integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchWhatsAppIntegration: { parameters: { query?: never; header?: never; path: { whatsappIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The WhatsApp integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The WhatsApp integration verify token */ verifyToken: string; /** @description The WhatsApp integration phone number ID */ phoneNumberId?: string; /** @description The WhatsApp integration access token (returned as '********' if configured, null otherwise) */ accessToken?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Weather the bot supports attachments */ attachments?: boolean; /** @description Newline-or-comma-separated list of allowed senders */ allowFrom?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; setupWhatsAppIntegration: { parameters: { query?: never; header?: never; path: { whatsappIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The WhatsApp integration was successfully setup */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the WhatsApp Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateWhatsAppIntegration: { parameters: { query?: never; header?: never; path: { whatsappIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The WhatsApp integration phone number ID */ phoneNumberId?: string; /** @description The WhatsApp integration access token */ accessToken?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Weather the bot supports attachments */ attachments?: boolean; /** @description Newline-or-comma-separated list of allowed senders. Use E.164 phone numbers with or without the leading `+`. Set to `*` to allow all. Leave empty to deny all. */ allowFrom?: string; }; }; }; responses: { /** @description The WhatsApp integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the WhatsApp Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createWhatsAppIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The WhatsApp integration phone number ID */ phoneNumberId?: string; /** @description The WhatsApp integration access token */ accessToken?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Weather the bot supports attachments */ attachments?: boolean; /** @description Newline-or-comma-separated list of allowed senders. Use E.164 phone numbers with or without the leading `+`. Set to `*` to allow all. Leave empty to deny all. */ allowFrom?: string; }; }; }; responses: { /** @description The WhatsApp integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the WhatsApp Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listWhatsAppIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of WhatsApp integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The WhatsApp integration verify token */ verifyToken: string; /** @description The WhatsApp integration phone number ID */ phoneNumberId?: string; /** @description The WhatsApp integration access token (returned as '********' if configured, null otherwise) */ accessToken?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Weather the bot supports attachments */ attachments?: boolean; /** @description Newline-or-comma-separated list of allowed senders. Use phone numbers in E.164 format (digits only). Leave empty to block all. Use * to allow everyone. */ allowFrom?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The WhatsApp integration verify token */ verifyToken: string; /** @description The WhatsApp integration phone number ID */ phoneNumberId?: string; /** @description The WhatsApp integration access token (returned as '********' if configured, null otherwise) */ accessToken?: string; /** @description Weather to collect contacts */ contactCollection?: boolean; /** @description The session duration (in milliseconds) */ sessionDuration?: number; /** @description Weather the bot supports attachments */ attachments?: boolean; /** @description Newline-or-comma-separated list of allowed senders. Use phone numbers in E.164 format (digits only). Leave empty to block all. Use * to allow everyone. */ allowFrom?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; cloneWidgetIntegration: { parameters: { query?: never; header?: never; path: { widgetIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Widget integration was cloned successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the cloned Widget integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteWidgetIntegration: { parameters: { query?: never; header?: never; path: { widgetIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Widget integration was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted Widget integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchWidgetIntegration: { parameters: { query?: never; header?: never; path: { widgetIntegrationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The Widget integration was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The theme of the Widget integration */ theme?: string; /** @description The default layout of the Widget integration */ layout?: string; /** @description The title of the Widget integration */ title?: string; /** @description The intro of the Widget integration */ intro?: string; /** @description The initial message of the Widget integration */ initial?: string; /** @description The input placeholder of the Widget integration */ placeholder?: string; /** @description The origin URLs of the Widget integration */ origin?: string; /** @description The session duration of the Widget integration */ sessionDuration?: number; /** @description The language of the Widget integration */ language?: string; /** @description The plugins of the Widget integration */ plugins?: string; /** @description Whether the Widget integration is streaming */ stream?: boolean; /** @description Whether the Widget integration is verbose */ verbose?: boolean; /** @description Whether the Widget integration has tools */ tools?: boolean; /** @description Whether the Widget integration unfurls links */ unfurl?: boolean; /** @description Whether the Widget integration supports math */ math?: boolean; /** @description Whether the Widget integration supports carousels */ carousel?: boolean; /** @description Whether the Widget integration supports forms */ form?: boolean; /** @description Whether the Widget integration supports attachments */ attachments?: boolean; /** @description Whether the Widget integration auto scrolls */ autoScroll?: boolean; /** @description Whether the Widget integration starts first */ startFirst?: boolean; /** @description Whether the Widget integration collects contacts */ contactCollection?: boolean; /** @description Controls whether the Widget allows exporting the current conversation */ exportConversation?: boolean; /** @description Controls whether the Widget allows restarting the conversation */ restartConversation?: boolean; /** @description Controls whether the Widget allows maximizing the conversation */ maximize?: boolean; /** @description Controls whether the Widget allows peeking at the initial messages */ messagePeek?: boolean; /** @description Whether the Widget integration supports voice input */ voiceIn?: boolean; /** @description Whether the Widget integration supports voice output */ voiceOut?: boolean; /** @description Whether the Widget integration displays powered by */ poweredBy?: boolean; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; attachWidgetIntegrationFile: { parameters: { query?: never; header?: never; path: { widgetIntegrationId: string; fileId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** * @description The attachment slot type for the file * @enum {string} */ type: "bar" | "user" | "bot" | "button"; }; }; }; responses: { /** @description The file was attached to the widget integration successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the attached file */ id: string; /** @description The attachment slot type */ type: string; /** @description The ID of the widget integration */ widgetIntegrationId: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; detachWidgetIntegrationFile: { parameters: { query?: never; header?: never; path: { widgetIntegrationId: string; fileId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The file was detached from the widget integration successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the detached file */ id: string; /** @description The attachment slot type that was cleared */ type: string; /** @description The ID of the widget integration */ widgetIntegrationId: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; setupWidgetIntegration: { parameters: { query?: never; header?: never; path: { widgetIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The Widget integration was setup successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Widget integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateWidgetIntegration: { parameters: { query?: never; header?: never; path: { widgetIntegrationId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The theme of the Widget integration */ theme?: string; /** @description The default layout of the Widget integration */ layout?: string; /** @description The title of the Widget integration */ title?: string; /** @description The intro of the Widget integration */ intro?: string; /** @description The initial message of the Widget integration */ initial?: string; /** @description The input placeholder of the Widget integration */ placeholder?: string; /** @description The origin URLs of the Widget integration */ origin?: string; /** @description The session duration of the Widget integration */ sessionDuration?: number; /** @description The language of the Widget integration */ language?: string; /** @description The plugins of the Widget integration */ plugins?: string; /** @description Whether the Widget integration is streaming */ stream?: boolean; /** @description Whether the Widget integration is verbose */ verbose?: boolean; /** @description Whether the Widget integration has tools */ tools?: boolean; /** @description Whether the Widget integration unfurls links */ unfurl?: boolean; /** @description Whether the Widget integration supports math */ math?: boolean; /** @description Whether the Widget integration supports carousels */ carousel?: boolean; /** @description Whether the Widget integration supports forms */ form?: boolean; /** @description Whether the Widget integration supports attachments */ attachments?: boolean; /** @description Whether the Widget integration auto scrolls */ autoScroll?: boolean; /** @description Whether the Widget integration starts first */ startFirst?: boolean; /** @description Whether the Widget integration collects contacts */ contactCollection?: boolean; /** @description Controls whether the Widget allows exporting the current conversation */ exportConversation?: boolean; /** @description Controls whether the Widget allows restarting the conversation */ restartConversation?: boolean; /** @description Controls whether the Widget allows maximizing the conversation */ maximize?: boolean; /** @description Controls whether the Widget allows peeking at the initial messages */ messagePeek?: boolean; /** @description Controls whether the Widget allows voice input */ voiceIn?: boolean; /** @description Controls whether the Widget allows voice output */ voiceOut?: boolean; /** @description Whether the Widget integration displays powered by */ poweredBy?: boolean; }; }; }; responses: { /** @description The Widget integration was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Widget Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createWidgetIntegration: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The theme of the Widget integration */ theme?: string; /** @description The default layout of the Widget integration */ layout?: string; /** @description The title of the Widget integration */ title?: string; /** @description The intro of the Widget integration */ intro?: string; /** @description The initial message of the Widget integration */ initial?: string; /** @description The input placeholder of the Widget integration */ placeholder?: string; /** @description The origin URLs of the Widget integration */ origin?: string; /** @description The session duration of the Widget integration */ sessionDuration?: number; /** @description The language of the Widget integration */ language?: string; /** @description The plugins of the Widget integration */ plugins?: string; /** @description Whether the Widget integration is streaming */ stream?: boolean; /** @description Whether the Widget integration is verbose */ verbose?: boolean; /** @description Whether the Widget integration has tools */ tools?: boolean; /** @description Whether the Widget integration unfurls links */ unfurl?: boolean; /** @description Weather the Widget integration supports math */ math?: boolean; /** @description Weather the Widget integration supports carousels */ carousel?: boolean; /** @description Weather the Widget integration supports forms */ form?: boolean; /** @description Weather the Widget integration supports attachments */ attachments?: boolean; /** @description Whether the Widget integration auto scrolls */ autoScroll?: boolean; /** @description Whether the Widget integration starts first */ startFirst?: boolean; /** @description Whether the Widget integration collects contacts */ contactCollection?: boolean; /** @description Controls whether the Widget allows exporting the current conversation */ exportConversation?: boolean; /** @description Controls whether the Widget allows restarting the conversation */ restartConversation?: boolean; /** @description Controls whether the Widget allows maximizing the conversation */ maximize?: boolean; /** @description Controls whether the Widget allows peeking at the initial messages */ messagePeek?: boolean; /** @description Controls whether the Widget allows voice input */ voiceIn?: boolean; /** @description Controls whether the Widget allows voice output */ voiceOut?: boolean; /** @description Whether the Widget integration displays powered by */ poweredBy?: boolean; }; }; }; responses: { /** @description The Widget integration was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the Widget Integration */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listWidgetIntegrations: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of Widget integrations was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The theme of the Widget integration */ theme?: string; /** @description The default layout of the Widget integration */ layout?: string; /** @description The title of the Widget integration */ title?: string; /** @description The intro of the Widget integration */ intro?: string; /** @description The initial message of the Widget integration */ initial?: string; /** @description The input placeholder of the Widget integration */ placeholder?: string; /** @description The origin URLs of the Widget integration */ origin?: string; /** @description The session duration of the Widget integration */ sessionDuration?: number; /** @description The language of the Widget integration */ language?: string; /** @description The plugins of the Widget integration */ plugins?: string; /** @description Whether the Widget integration is streaming */ stream?: boolean; /** @description Whether the Widget integration is verbose */ verbose?: boolean; /** @description Whether the Widget integration has tools */ tools?: boolean; /** @description Whether the Widget integration unfurls links */ unfurl?: boolean; /** @description Weather the Widget integration supports math */ math?: boolean; /** @description Weather the Widget integration supports carousels */ carousel?: boolean; /** @description Weather the Widget integration supports forms */ form?: boolean; /** @description Weather the Widget integration supports attachments */ attachments?: boolean; /** @description Whether the Widget integration auto scrolls */ autoScroll?: boolean; /** @description Whether the Widget integration starts first */ startFirst?: boolean; /** @description Whether the Widget integration collects contacts */ contactCollection?: boolean; /** @description Controls whether the Widget allows exporting the current conversation */ exportConversation?: boolean; /** @description Controls whether the Widget allows restarting the conversation */ restartConversation?: boolean; /** @description Controls whether the Widget allows maximizing the conversation */ maximize?: boolean; /** @description Controls whether the Widget allows peeking at the initial messages */ messagePeek?: boolean; /** @description Whether the Widget integration supports voice input */ voiceIn?: boolean; /** @description Whether the Widget integration supports voice output */ voiceOut?: boolean; /** @description Whether the Widget integration displays powered by */ poweredBy?: boolean; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description A bot configuration that can be applied without a dedicated bot instance. */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this configuration is using */ botId?: string; /** @description The theme of the Widget integration */ theme?: string; /** @description The default layout of the Widget integration */ layout?: string; /** @description The title of the Widget integration */ title?: string; /** @description The intro of the Widget integration */ intro?: string; /** @description The initial message of the Widget integration */ initial?: string; /** @description The input placeholder of the Widget integration */ placeholder?: string; /** @description The origin URLs of the Widget integration */ origin?: string; /** @description The session duration of the Widget integration */ sessionDuration?: number; /** @description The language of the Widget integration */ language?: string; /** @description The plugins of the Widget integration */ plugins?: string; /** @description Whether the Widget integration is streaming */ stream?: boolean; /** @description Whether the Widget integration is verbose */ verbose?: boolean; /** @description Whether the Widget integration has tools */ tools?: boolean; /** @description Whether the Widget integration unfurls links */ unfurl?: boolean; /** @description Weather the Widget integration supports math */ math?: boolean; /** @description Weather the Widget integration supports carousels */ carousel?: boolean; /** @description Weather the Widget integration supports forms */ form?: boolean; /** @description Weather the Widget integration supports attachments */ attachments?: boolean; /** @description Whether the Widget integration auto scrolls */ autoScroll?: boolean; /** @description Whether the Widget integration starts first */ startFirst?: boolean; /** @description Whether the Widget integration collects contacts */ contactCollection?: boolean; /** @description Controls whether the Widget allows exporting the current conversation */ exportConversation?: boolean; /** @description Controls whether the Widget allows restarting the conversation */ restartConversation?: boolean; /** @description Controls whether the Widget allows maximizing the conversation */ maximize?: boolean; /** @description Controls whether the Widget allows peeking at the initial messages */ messagePeek?: boolean; /** @description Whether the Widget integration supports voice input */ voiceIn?: boolean; /** @description Whether the Widget integration supports voice output */ voiceOut?: boolean; /** @description Whether the Widget integration displays powered by */ poweredBy?: boolean; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; generateMagicFromPrompt: { parameters: { query?: never; header?: never; path: { promptId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The text to use as input */ text: string; /** @description Additional properties to pass to the prompt */ props?: Record; /** @description Optional language model to use for generation */ model?: string; }; }; }; responses: { /** @description The magic prompt completed successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The input text */ text: string; /** @description Usage information */ usage: { /** @description The tokens used in this exchange */ token: number; }; }; "application/jsonl": { /** * @description The generated text * @enum {string} */ type: "result"; data: { /** @description The input text */ text: string; /** @description Usage information */ usage: { /** @description The tokens used in this exchange */ token: number; }; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listMagicPrompts: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of magic prompts was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The alias of the item */ alias: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The alias of the item */ alias: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteMemory: { parameters: { query?: never; header?: never; path: { memoryId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The memory was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted memory */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchMemory: { parameters: { query?: never; header?: never; path: { memoryId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The memory was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact associated with the memory */ contactId?: string; /** @description The bot associated with the memory */ botId?: string; /** @description The text of the memory */ text?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateMemory: { parameters: { query?: never; header?: never; path: { memoryId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The contact associated with the memory */ contactId?: string; /** @description The bot associated with the memory */ botId?: string; /** @description The text of the memory */ text?: string; }; }; }; responses: { /** @description The memory was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the updated memory */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createMemory: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The contact associated with the memory */ contactId?: string; /** @description The bot associated with the memory */ botId?: string; /** @description The text of the memory */ text: string; }; }; }; responses: { /** @description The memory was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created memory */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; exportMemories: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of memories was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact associated with the memory */ contactId?: string; /** @description The bot associated with the memory */ botId?: string; /** @description The text of the memory */ text?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact associated with the memory */ contactId?: string; /** @description The bot associated with the memory */ botId?: string; /** @description The text of the memory */ text?: string; }; }; "text/csv": string; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listMemories: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of memories was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact associated with the memory */ contactId?: string; /** @description The bot associated with the memory */ botId?: string; /** @description The text of the memory */ text?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The contact associated with the memory */ contactId?: string; /** @description The bot associated with the memory */ botId?: string; /** @description The text of the memory */ text?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchMemory: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The keyword/phrase to search for */ search: string; /** @description The ID of the contact to filter memories by */ contactId?: string; /** @description The ID of the bot to filter memories by */ botId?: string; }; }; }; responses: { /** @description The search was successful */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description An array of memories matching the search query */ items: { id: string; text: string; meta?: Record; }[]; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deletePartnerUserContext: { parameters: { query?: never; header?: never; path: { userId: string; contextId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The context was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted context */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchPartnerUserContext: { parameters: { query?: never; header?: never; path: { userId: string; contextId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The context was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; blueprintId?: string; botId?: string; datasetId?: string; skillsetId?: string; payload?: Record; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updatePartnerUserContext: { parameters: { query?: never; header?: never; path: { userId: string; contextId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description Context payload */ payload?: Record; }; }; }; responses: { /** @description The context was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the updated context */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createPartnerUserContext: { parameters: { query?: never; header?: never; path: { userId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description Context payload */ payload?: Record; }; }; }; responses: { /** @description The partner user context was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; blueprintId?: string; botId?: string; datasetId?: string; skillsetId?: string; payload?: Record; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPartnerUserContexts: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; blueprintId?: string; botId?: string; datasetId?: string; skillsetId?: string; }; header?: never; path: { userId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The list of contexts was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; blueprintId?: string; botId?: string; datasetId?: string; skillsetId?: string; payload?: Record; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; blueprintId?: string; botId?: string; datasetId?: string; skillsetId?: string; payload?: Record; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deletePartnerUser: { parameters: { query?: never; header?: never; path: { userId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The user was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted user */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchPartnerUser: { parameters: { query?: never; header?: never; path: { userId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The partner user was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The image of the partner user */ image?: string; /** @description The email of the partner user */ email?: string; /** @description Limits information */ limits?: { /** @description The tokens limit */ tokens?: number; /** @description The conversations limit */ conversations?: number; /** @description The messages limit */ messages?: number; /** @description The database limits */ database?: { /** @description The datasets limit */ datasets?: number; /** @description The records limit */ records?: number; /** @description The skillsets limit */ skillsets?: number; /** @description The abilities limit */ abilities?: number; /** @description The files limit */ files?: number; }; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createPartnerUserSession: { parameters: { query?: never; header?: never; path: { userId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The lifetime of the session token in seconds */ durationInSeconds?: number; config?: { /** @description Glob patterns restricting which API routes the token may access */ allowedRoutes?: string[]; /** @description Optional contact ID to include in the session token */ contactId?: string; }; }; }; }; responses: { /** @description The session was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created session */ id: string; /** @description The temporary session token */ token: string; /** @description The timestamp for when the session token expires (in milliseconds) */ expiresAt: number; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deletePartnerUserToken: { parameters: { query?: never; header?: never; path: { userId: string; tokenId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The user token was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted user token */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updatePartnerUserToken: { parameters: { query?: never; header?: never; path: { userId: string; tokenId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The name of the token */ name?: string; /** @description The description of the token */ description?: string; /** @description Token configuration */ config?: Record; /** @description Custom metadata for the token */ meta?: Record; }; }; }; responses: { /** @description The user token was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the updated user token */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createPartnerUserToken: { parameters: { query?: never; header?: never; path: { userId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The name of the token */ name?: string; /** @description The description of the token */ description?: string; /** @description Token configuration */ config?: Record; /** @description Custom metadata for the token */ meta?: Record; }; }; }; responses: { /** @description The user token was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created user token */ id: string; /** @description The token of the created user token */ token: string; /** @description The timestamp for when the user token was created (in milliseconds) */ createdAt: number; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPartnerUserTokens: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; }; header?: never; path: { userId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The list of user tokens was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updatePartnerUser: { parameters: { query?: never; header?: never; path: { userId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The image of the partner user */ image?: string; /** @description The email of the partner user */ email?: string; /** @description Limits information */ limits?: { /** @description The tokens limit */ tokens?: number; /** @description The conversations limit */ conversations?: number; /** @description The messages limit */ messages?: number; /** @description The database limits */ database?: { /** @description The datasets limit */ datasets?: number; /** @description The records limit */ records?: number; /** @description The skillsets limit */ skillsets?: number; /** @description The abilities limit */ abilities?: number; /** @description The files limit */ files?: number; }; }; }; }; }; responses: { /** @description The message was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the updated partner user */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createPartnerUser: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The image of the partner user */ image?: string; /** @description The email of the partner user */ email?: string; /** @description Limits information */ limits?: { /** @description The tokens limit */ tokens?: number; /** @description The conversations limit */ conversations?: number; /** @description The messages limit */ messages?: number; /** @description The database limits */ database?: { /** @description The datasets limit */ datasets?: number; /** @description The records limit */ records?: number; /** @description The skillsets limit */ skillsets?: number; /** @description The abilities limit */ abilities?: number; /** @description The files limit */ files?: number; }; }; }; }; }; responses: { /** @description The user was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created user */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPartnerUsers: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of users was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The image of the partner user */ image?: string; /** @description The email of the partner user */ email?: string; /** @description Limits information */ limits?: { /** @description The tokens limit */ tokens?: number; /** @description The conversations limit */ conversations?: number; /** @description The messages limit */ messages?: number; /** @description The database limits */ database?: { /** @description The datasets limit */ datasets?: number; /** @description The records limit */ records?: number; /** @description The skillsets limit */ skillsets?: number; /** @description The abilities limit */ abilities?: number; /** @description The files limit */ files?: number; }; }; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The image of the partner user */ image?: string; /** @description The email of the partner user */ email?: string; /** @description Limits information */ limits?: { /** @description The tokens limit */ tokens?: number; /** @description The conversations limit */ conversations?: number; /** @description The messages limit */ messages?: number; /** @description The database limits */ database?: { /** @description The datasets limit */ datasets?: number; /** @description The records limit */ records?: number; /** @description The skillsets limit */ skillsets?: number; /** @description The abilities limit */ abilities?: number; /** @description The files limit */ files?: number; }; }; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPlatformAbilities: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of abilities was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The original template identifier for the ability */ template?: string; instruction: string; /** @description A JSON Schema object type definition (https://json-schema.org/). Represents an object schema with properties and validation rules. */ schema: { /** * @description The schema type, must be "object" * @enum {string} */ type: "object"; /** @description The schema title */ title?: string; /** @description The schema description */ description?: string; /** @description Object property definitions */ properties: { [key: string]: unknown; }; /** @description Required property names */ required?: string[]; }; /** @description The ID of the bot associated with the ability */ bot?: string; /** @description The ID of the file associated with the ability */ file?: string; /** @description The ID of the secret associated with the ability */ secret?: string; /** @description The ID of the space associated with the ability */ space?: string; /** @description The provider of the ability */ provider?: string; icon: string; tags?: string[]; setup?: string; commentary?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The original template identifier for the ability */ template?: string; instruction: string; /** @description A JSON Schema object type definition (https://json-schema.org/). Represents an object schema with properties and validation rules. */ schema: { /** * @description The schema type, must be "object" * @enum {string} */ type: "object"; /** @description The schema title */ title?: string; /** @description The schema description */ description?: string; /** @description Object property definitions */ properties: { [key: string]: unknown; }; /** @description Required property names */ required?: string[]; }; /** @description The ID of the bot associated with the ability */ bot?: string; /** @description The ID of the file associated with the ability */ file?: string; /** @description The ID of the secret associated with the ability */ secret?: string; /** @description The ID of the space associated with the ability */ space?: string; /** @description The provider of the ability */ provider?: string; icon: string; tags?: string[]; setup?: string; commentary?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchPlatformAbilities: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The search query to find relevant abilities */ search: string; /** * @description The maximum number of results to return (1-100, default 10) * @default 10 */ take?: number; }; }; }; responses: { /** @description The search was successful */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The original template identifier for the ability */ template?: string; instruction: string; /** @description A JSON Schema object type definition (https://json-schema.org/). Represents an object schema with properties and validation rules. */ schema: { /** * @description The schema type, must be "object" * @enum {string} */ type: "object"; /** @description The schema title */ title?: string; /** @description The schema description */ description?: string; /** @description Object property definitions */ properties: { [key: string]: unknown; }; /** @description Required property names */ required?: string[]; }; bot?: string; file?: string; secret?: string; space?: string; provider?: string; icon: string; tags?: string[]; setup?: string; commentary?: string; /** @description The similarity score of the search result */ score: number; /** @description An excerpt from the most relevant part of the ability */ excerpt: string; /** @description The URL to the official ability page */ link?: string; }[]; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPlatformActions: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of actions was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The description of the action */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description Example demonstrating the action usage */ examples: string[]; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The description of the action */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description Example demonstrating the action usage */ examples: string[]; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchPlatformDoc: { parameters: { query?: never; header?: never; path: { docId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The doc was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The associated name */ name: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The category of the manual */ category?: string; /** @description Tags associated with the doc */ tags?: string[]; /** @description The display order index */ index?: number; /** @description The markdown content of the doc */ content: string; /** @description The URL to the official documentation page */ link?: string; }; }; }; /** @description Doc not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPlatformDocs: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of docs was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The category of the doc */ category?: string; /** @description Tags associated with the doc */ tags: string[]; /** @description The display order index */ index: number; /** @description The URL to the official documentation page */ link: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The category of the doc */ category?: string; /** @description Tags associated with the doc */ tags: string[]; /** @description The display order index */ index: number; /** @description The URL to the official documentation page */ link: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchPlatformDocs: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The search query to find relevant docs */ search: string; /** * @description The maximum number of results to return (1-100, default 10) * @default 10 */ take?: number; }; }; }; responses: { /** @description The search was successful */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The category of the doc */ category?: string; /** @description Tags associated with the doc */ tags: string[]; /** @description The display order index */ index: number; /** @description The similarity score of the search result */ score: number; /** @description An excerpt from the most relevant part of the doc */ excerpt: string; /** @description The URL to the official documentation page */ link: string; }[]; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; clonePlatformExample: { parameters: { query?: never; header?: never; path: { exampleId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The example was cloned successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description A map of resource types to arrays of created resources */ resources: { [key: string]: { /** @description The unique identifier of the resource */ id: string; /** @description The name of the resource */ name?: string; /** @description The description of the resource */ description?: string; }[]; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchPlatformExample: { parameters: { query?: never; header?: never; path: { exampleId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The example was fetched successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID (slug) of the example */ id: string; /** @description The name of the example */ name: string; /** @description The description of the example */ description: string; /** * @description The type of the example * @enum {string} */ type: "blueprint" | "project" | "widget" | "slack" | "discord" | "whatsapp" | "messenger" | "telegram" | "twilio" | "email" | "trigger"; /** @description The full configuration details of the example */ config: { [key: string]: unknown; }; /** @description The URL to the official example page */ link: string; /** @description Tags associated with the example */ tags?: string[]; /** @description The creation timestamp */ createdAt?: number; /** @description The last update timestamp */ updatedAt?: number; }; }; }; /** @description The example was not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPlatformExamples: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of examples was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** * @description The type of the example * @enum {string} */ type: "blueprint" | "project" | "widget" | "slack" | "discord" | "whatsapp" | "messenger" | "telegram" | "twilio" | "email" | "trigger"; /** @description Tags associated with the example */ tags?: string[]; /** @description The URL to the official example page */ link: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** * @description The type of the example * @enum {string} */ type: "blueprint" | "project" | "widget" | "slack" | "discord" | "whatsapp" | "messenger" | "telegram" | "twilio" | "email" | "trigger"; /** @description Tags associated with the example */ tags?: string[]; /** @description The URL to the official example page */ link: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchPlatformExamples: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The search query to find relevant examples */ search: string; /** * @description The maximum number of results to return (1-100, default 10) * @default 10 */ take?: number; }; }; }; responses: { /** @description The search was successful */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** * @description The type of the example * @enum {string} */ type: "blueprint" | "project" | "widget" | "slack" | "discord" | "whatsapp" | "messenger" | "telegram" | "twilio" | "email" | "trigger"; /** @description Tags associated with the example */ tags?: string[]; /** @description The URL to the official example page */ link: string; }[]; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchPlatformGuide: { parameters: { query?: never; header?: never; path: { guideId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The guide was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The associated name */ name: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The category of the guide */ category?: string; /** @description Tags associated with the guide */ tags?: string[]; /** @description The display order index */ index?: number; /** @description The markdown content of the guide */ content: string; /** @description The URL to the official guide page */ link?: string; }; }; }; /** @description Guide not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPlatformGuides: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of guides was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The category of the guide */ category?: string; /** @description Tags associated with the guide */ tags: string[]; /** @description The display order index */ index: number; /** @description The URL to the official guide page */ link: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The category of the guide */ category?: string; /** @description Tags associated with the guide */ tags: string[]; /** @description The display order index */ index: number; /** @description The URL to the official guide page */ link: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchPlatformGuides: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The search query to find relevant guides */ search: string; /** * @description The maximum number of results to return (1-100, default 10) * @default 10 */ take?: number; }; }; }; responses: { /** @description The search was successful */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The category of the guide */ category?: string; /** @description Tags associated with the guide */ tags: string[]; /** @description The display order index */ index: number; /** @description The similarity score of the search result */ score: number; /** @description An excerpt from the most relevant part of the guide */ excerpt: string; /** @description The URL to the official guide page */ link: string; }[]; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchPlatformManual: { parameters: { query?: never; header?: never; path: { manualId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The manual was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The associated name */ name: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The category of the manual */ category?: string; /** @description Tags associated with the manual */ tags?: string[]; /** @description The display order index */ index?: number; /** @description The markdown content of the manual */ content: string; /** @description The URL to the official documentation page */ link?: string; }; }; }; /** @description Manual not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPlatformManuals: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of manuals was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The category of the manual */ category?: string; /** @description Tags associated with the manual */ tags: string[]; /** @description The display order index */ index: number; /** @description The URL to the official documentation page */ link: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The category of the manual */ category?: string; /** @description Tags associated with the manual */ tags: string[]; /** @description The display order index */ index: number; /** @description The URL to the official documentation page */ link: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchPlatformManuals: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The search query to find relevant manuals */ search: string; /** * @description The maximum number of results to return (1-100, default 10) * @default 10 */ take?: number; }; }; }; responses: { /** @description The search was successful */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The category of the manual */ category?: string; /** @description Tags associated with the manual */ tags: string[]; /** @description The display order index */ index: number; /** @description The similarity score of the search result */ score: number; /** @description An excerpt from the most relevant part of the manual */ excerpt: string; /** @description The URL to the official documentation page */ link: string; }[]; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPlatformModels: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of models was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The backstory of the model */ provider: string; /** @description The model of the model */ family: string; /** @description The maximum number of tokens the model can use */ maxTokens: number; /** @description The maximum number of tokens the model can accept */ maxInputTokens: number; /** @description The maximum number of tokens the model can generate */ maxOutputTokens: number; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The backstory of the model */ provider: string; /** @description The model of the model */ family: string; /** @description The maximum number of tokens the model can use */ maxTokens: number; /** @description The maximum number of tokens the model can accept */ maxInputTokens: number; /** @description The maximum number of tokens the model can generate */ maxOutputTokens: number; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPlatformSecrets: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of secrets was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The original template identifier for the secret */ template?: string; /** * @description The type of the secret * @enum {string} */ type: "plain" | "basic" | "bearer" | "jwt" | "oauth" | "template" | "reference"; /** * @description The kind of the secret * @enum {string} */ kind?: "shared" | "personal"; config?: { [key: string]: unknown; }; icon?: string; tags?: string[]; setup?: string; commentary?: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The original template identifier for the secret */ template?: string; /** * @description The type of the secret * @enum {string} */ type: "plain" | "basic" | "bearer" | "jwt" | "oauth" | "template" | "reference"; /** * @description The kind of the secret * @enum {string} */ kind?: "shared" | "personal"; config?: { [key: string]: unknown; }; icon?: string; tags?: string[]; setup?: string; commentary?: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchPlatformSecrets: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The search query to find relevant secrets */ search: string; /** * @description The maximum number of results to return (1-100, default 10) * @default 10 */ take?: number; }; }; }; responses: { /** @description The search was successful */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The original template identifier for the secret */ template?: string; /** * @description The type of the secret * @enum {string} */ type: "plain" | "basic" | "bearer" | "jwt" | "oauth" | "template" | "reference"; /** * @description The kind of the secret * @enum {string} */ kind?: "shared" | "personal"; config?: { [key: string]: unknown; }; icon?: string; tags?: string[]; setup?: string; commentary?: string; /** @description The similarity score of the search result */ score: number; /** @description An excerpt from the most relevant part of the secret */ excerpt: string; /** @description The URL to the official secret page */ link?: string; }[]; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchPlatformTutorial: { parameters: { query?: never; header?: never; path: { tutorialId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The tutorial was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The associated name */ name: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The category of the tutorial */ category?: string; /** @description Tags associated with the tutorial */ tags?: string[]; /** @description The display order index */ index?: number; /** @description The markdown content of the tutorial */ content: string; /** @description The URL to the official tutorial page */ link?: string; }; }; }; /** @description Tutorial not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPlatformTutorials: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of tutorials was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The category of the tutorial */ category?: string; /** @description Tags associated with the tutorial */ tags: string[]; /** @description The display order index */ index: number; /** @description The URL to the official tutorial page */ link: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Instance list properties */ data: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The category of the tutorial */ category?: string; /** @description Tags associated with the tutorial */ tags: string[]; /** @description The display order index */ index: number; /** @description The URL to the official tutorial page */ link: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; searchPlatformTutorials: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The search query to find relevant tutorials */ search: string; /** * @description The maximum number of results to return (1-100, default 10) * @default 10 */ take?: number; }; }; }; responses: { /** @description The search was successful */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The category of the tutorial */ category?: string; /** @description Tags associated with the tutorial */ tags: string[]; /** @description The display order index */ index: number; /** @description The similarity score of the search result */ score: number; /** @description An excerpt from the most relevant part of the tutorial */ excerpt: string; /** @description The URL to the official tutorial page */ link: string; }[]; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deletePolicy: { parameters: { query?: never; header?: never; path: { policyId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The policy was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted policy */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchPolicy: { parameters: { query?: never; header?: never; path: { policyId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The policy was fetched successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this policy applies to. When omitted the policy is global and applies to every bot. */ botId?: string; /** * @description The policy type * @enum {string} */ type: "retention" | "usage"; /** @description The policy configuration as JSON */ config?: { [key: string]: unknown; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updatePolicy: { parameters: { query?: never; header?: never; path: { policyId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this policy applies to. When omitted the policy is global and applies to every bot. */ botId?: string; /** * @description The policy type * @enum {string} */ type?: "retention" | "usage"; /** @description The policy configuration as JSON */ config?: { [key: string]: unknown; }; }; }; }; responses: { /** @description The policy was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the updated policy */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createPolicy: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this policy applies to. When omitted the policy is global and applies to every bot. */ botId?: string; /** * @description The policy type * @enum {string} */ type: "retention" | "usage"; /** @description The policy configuration as JSON */ config?: { [key: string]: unknown; }; }; }; }; responses: { /** @description The policy was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created policy */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPolicies: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; botId?: string; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of policies was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this policy applies to. When omitted the policy is global and applies to every bot. */ botId?: string; /** * @description The policy type * @enum {string} */ type: "retention" | "usage"; /** @description The policy configuration as JSON */ config?: { [key: string]: unknown; }; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the bot this policy applies to. When omitted the policy is global and applies to every bot. */ botId?: string; /** * @description The policy type * @enum {string} */ type: "retention" | "usage"; /** @description The policy configuration as JSON */ config?: { [key: string]: unknown; }; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deletePortal: { parameters: { query?: never; header?: never; path: { portalId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The portal was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted portal */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchPortal: { parameters: { query?: never; header?: never; path: { portalId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The portal was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The slug of the portal */ slug?: string; /** @description The config of the portal */ config?: { [key: string]: unknown; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updatePortal: { parameters: { query?: never; header?: never; path: { portalId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The slug for the portal */ slug?: string; /** @description The config for the portal */ config?: { [key: string]: unknown; }; }; }; }; responses: { /** @description The portal was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the updated portal */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createPortal: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The slug of the portal */ slug?: string; /** @description The config of the portal */ config?: { [key: string]: unknown; }; }; }; }; responses: { /** @description The portal was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created portal */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listPortals: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of portals was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The slug of the portal */ slug?: string; /** @description The config of the portal */ config?: { [key: string]: unknown; }; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The slug of the portal */ slug?: string; /** @description The config of the portal */ config?: { [key: string]: unknown; }; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; authenticateSecret: { parameters: { query?: never; header?: never; path: { secretId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The secret is about to be authenticated */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the secret to authenticate */ id: string; /** @description The URL to authenticate the secret */ url: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteSecret: { parameters: { query?: never; header?: never; path: { secretId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The secret was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted secret */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchSecret: { parameters: { query?: never; header?: never; path: { secretId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The secret was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The kind of the secret * @enum {string} */ kind?: "shared" | "personal"; /** * @description The type of the secret * @enum {string} */ type?: "plain" | "basic" | "bearer" | "jwt" | "oauth" | "template" | "reference"; /** @description The config of the secret */ config?: { [key: string]: unknown; }; /** * @description The visibility of the secret * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; revokeSecret: { parameters: { query?: never; header?: never; path: { secretId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The secret was revoked successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the revoked secret */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateSecret: { parameters: { query?: never; header?: never; path: { secretId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The kind of the secret * @enum {string} */ kind?: "shared" | "personal"; /** * @description The type of the secret * @enum {string} */ type?: "plain" | "basic" | "bearer" | "jwt" | "oauth" | "template" | "reference"; /** @description The value of the secret */ value?: string; /** @description The config of the secret */ config?: { [key: string]: unknown; }; /** * @description The visibility of the secret * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; responses: { /** @description The secret was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the updated secret */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; verifySecret: { parameters: { query?: never; header?: never; path: { secretId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The secret was verified successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the verified secret */ id: string; /** * @description The status of the secret * @enum {string} */ status: "unauthenticated" | "authenticated"; action?: { /** * @description The type of action to take * @enum {string} */ type: "authenticate"; /** @description The URL to authenticate the secret */ url: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createSecret: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The kind of the secret * @enum {string} */ kind?: "shared" | "personal"; /** * @description The type of the secret * @enum {string} */ type?: "plain" | "basic" | "bearer" | "jwt" | "oauth" | "template" | "reference"; /** @description The value of the secret */ value?: string; /** @description The config of the secret */ config?: { [key: string]: unknown; }; /** * @description The visibility of the secret * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; responses: { /** @description The secret was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created secret */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSecrets: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of secrets was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The kind of the secret * @enum {string} */ kind?: "shared" | "personal"; /** * @description The type of the secret * @enum {string} */ type?: "plain" | "basic" | "bearer" | "jwt" | "oauth" | "template" | "reference"; /** @description The config of the secret */ config?: { [key: string]: unknown; }; /** * @description The visibility of the secret * @enum {string} */ visibility?: "private" | "protected" | "public"; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The kind of the secret * @enum {string} */ kind?: "shared" | "personal"; /** * @description The type of the secret * @enum {string} */ type?: "plain" | "basic" | "bearer" | "jwt" | "oauth" | "template" | "reference"; /** @description The config of the secret */ config?: { [key: string]: unknown; }; /** * @description The visibility of the secret * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteSkillsetAbility: { parameters: { query?: never; header?: never; path: { skillsetId: string; abilityId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The ability was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted ability */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; executeSkillsetAbility: { parameters: { query?: never; header?: never; path: { skillsetId: string; abilityId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The input to process with the ability. This can be structured * text such as JSON or YAML for precise parameter control, or * unstructured natural language text. When unstructured text is * provided, the system will automatically detect and extract the * relevant parameters from the input. * */ input?: string; /** @description The ID of the contact to associate with the execution */ contactId?: string; }; }; }; responses: { /** @description The ability was executed successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description Usage information */ usage: { /** @description The tokens used in this exchange */ token: number; }; /** @description Error message if execution failed */ error?: string; /** @description The result of the ability execution */ result?: unknown; /** @description Messages generated during execution */ messages?: { /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; }[]; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "result"; data: { /** @description Usage information */ usage: { /** @description The tokens used in this exchange */ token: number; }; /** @description Error message if execution failed */ error?: string; /** @description The result of the ability execution */ result?: unknown; /** @description Messages generated during execution */ messages?: { /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; }[]; }; } | ({ /** * @description The type of event * @enum {string} */ type: "error"; /** @description The data for the event */ data: { /** @description The error message */ message: string; }; } | { /** * @description The type of event * @enum {string} */ type: "token"; /** @description The data for the event */ data: { /** @description The token generated */ token: string; }; } | { /** * @description The type of event * @enum {string} */ type: "reasoningToken"; /** @description The data for the event */ data: { /** @description The token generated */ token: string; }; } | { /** * @description The type of event * @enum {string} */ type: "message"; /** @description A message in the conversation */ data: { /** * @description The type of the message * @enum {string} */ type: "user" | "bot" | "reasoning" | "context" | "instruction" | "backstory" | "activity" | "checkpoint"; /** @description The text of the message */ text: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; }; } | { /** * @description The type of event * @enum {string} */ type: "abort"; /** @description Information about an abort event in a streamed response */ data: { /** @description The abort reason if available */ reason?: unknown; /** @description The function or tool associated with the abort */ functionName?: string; }; } | { /** * @description The type of event * @enum {string} */ type: "completeBegin"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "completeEnd"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "waitForChannelMessageBegin"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "waitForChannelMessageEnd"; /** @description The data for the event */ data: { [key: string]: unknown; }; } | { /** * @description The type of event * @enum {string} */ type: "usage"; /** @description The data for the event */ data: { /** @description The model used */ model: string; /** @description The number of input tokens used */ inputTokensUsed: number; /** @description The number of output tokens used */ outputTokensUsed: number; }; }); }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchSkillsetAbility: { parameters: { query?: never; header?: never; path: { skillsetId: string; abilityId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The skillset was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the secret associated with the ability */ secretId?: string; /** @description The ID of the file associated with the ability */ fileId?: string; /** @description The ID of the bot associated with the ability */ botId?: string; /** @description The ID of the space associated with the ability */ spaceId?: string; /** @description The instruction of the skillset ability */ instruction: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateSkillsetAbility: { parameters: { query?: never; header?: never; path: { skillsetId: string; abilityId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the secret associated with the ability */ secretId?: string; /** @description The ID of the file associated with the ability */ fileId?: string; /** @description The ID of the bot associated with the ability */ botId?: string; /** @description The ID of the space associated with the ability */ spaceId?: string; /** @description The text to update the ability with */ instruction?: string; }; }; }; responses: { /** @description The ability was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the updated ability */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createSkillsetAbility: { parameters: { query?: never; header?: never; path: { skillsetId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the secret associated with the ability */ secretId?: string; /** @description The ID of the file associated with the ability */ fileId?: string; /** @description The ID of the bot associated with the ability */ botId?: string; /** @description The ID of the space associated with the ability */ spaceId?: string; /** @description The instruction of the ability */ instruction?: string; }; }; }; responses: { /** @description The ability was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created ability */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; exportSkillsetAbilities: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; }; header?: never; path: { skillsetId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The export of skillset abilities was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the secret associated with the ability */ secretId?: string; /** @description The ID of the file associated with the ability */ fileId?: string; /** @description The ID of the bot associated with the ability */ botId?: string; /** @description The ID of the space associated with the ability */ spaceId?: string; instruction: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the secret associated with the ability */ secretId?: string; /** @description The ID of the file associated with the ability */ fileId?: string; /** @description The ID of the bot associated with the ability */ botId?: string; /** @description The ID of the space associated with the ability */ spaceId?: string; instruction: string; }; }; "text/csv": string; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSkillsetAbilities: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; }; header?: never; path: { skillsetId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The list of abilities was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the secret associated with the ability */ secretId?: string; /** @description The ID of the file associated with the ability */ fileId?: string; /** @description The ID of the bot associated with the ability */ botId?: string; /** @description The ID of the space associated with the ability */ spaceId?: string; instruction: string; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The associated name */ name: string; /** @description The associated description */ description: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The ID of the secret associated with the ability */ secretId?: string; /** @description The ID of the file associated with the ability */ fileId?: string; /** @description The ID of the bot associated with the ability */ botId?: string; /** @description The ID of the space associated with the ability */ spaceId?: string; instruction: string; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteSkillset: { parameters: { query?: never; header?: never; path: { skillsetId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The skillset was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted skillset */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchSkillset: { parameters: { query?: never; header?: never; path: { skillsetId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The skillset was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The skillset visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateSkillset: { parameters: { query?: never; header?: never; path: { skillsetId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The skillset visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; responses: { /** @description The skillset was updated successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the updated skillset */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; createSkillset: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The skillset visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; responses: { /** @description The skillset was created successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the created skillset */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; listSkillsets: { parameters: { query?: { cursor?: string; order?: "asc" | "desc"; take?: number; meta?: { [key: string]: string; }; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description The list of skillsets was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { items: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The skillset visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }[]; /** @description Cursor for fetching the next page */ cursor: string; }; "application/jsonl": { /** * @description The type of event * @enum {string} */ type: "item"; /** @description Blueprint properties */ data: { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** * @description The skillset visibility * @enum {string} */ visibility?: "private" | "protected" | "public"; }; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteSpace: { parameters: { query?: never; header?: never; path: { spaceId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The space was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted space */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchSpace: { parameters: { query?: never; header?: never; path: { spaceId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The space was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The ID of the blueprint */ blueprintId?: string; /** @description The contact associated with the space */ contactId?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; deleteSpaceSite: { parameters: { query?: never; header?: never; path: { spaceId: string; siteId: string; }; cookie?: never; }; requestBody: { content: { "application/json": Record; }; }; responses: { /** @description The site was deleted successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The ID of the deleted site */ id: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; fetchSpaceSite: { parameters: { query?: never; header?: never; path: { spaceId: string; siteId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The site was retrieved successfully */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The instance ID */ id: string; /** @description The timestamp (ms) when the instance was created */ createdAt: number; /** @description The timestamp (ms) when the instance was updated */ updatedAt: number; /** @description The space the site belongs to */ spaceId?: string; /** @description The host the site is served at */ domain?: string; /** @description The folder prefix inside the space */ prefix?: string; /** @description Directory index filename */ index?: string; /** @description Not found filename */ notFound?: string; }; }; }; /** @description An error response */ default: { headers: { [name: string]: unknown; }; content?: never; }; }; }; updateSpaceSite: { parameters: { query?: never; header?: never; path: { spaceId: string; siteId: string; }; cookie?: never; }; requestBody: { content: { "application/json": { /** @description The unique alias for the instance */ alias?: string; /** @description The associated name */ name?: string; /** @description The associated description */ description?: string; /** @description Meta data information */ meta?: { [key: string]: unknown; }; /** @description The host the site is served at (a