{"openapi":"3.0.0","info":{"title":"CBK API","version":"v1 (build 1776607264903)"},"servers":[{"url":"https://api.chatbotkit.com/v1"}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer"}},"parameters":{"TimezoneHeader":{"name":"X-Timezone","in":"header","description":"The timezone to use for the request","required":false,"schema":{"type":"string","example":"Europe/London"}}},"schemas":{"Message":{"type":"object","description":"A message in the conversation","properties":{"type":{"$ref":"#/components/schemas/MessageType"},"text":{"type":"string","description":"The text of the message"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["type","text"]},"Entity":{"type":"object","description":"Extracted entity from the message","properties":{"type":{"type":"string","description":"The entity type"},"begin":{"type":"number","description":"Start offset"},"end":{"type":"number","description":"End offset"},"text":{"type":"string","description":"The text value of the entity"},"replacement":{"type":"object","properties":{"begin":{"type":"number","description":"Start offset"},"end":{"type":"number","description":"End offset"},"text":{"type":"string","description":"The text value of the replacement"}},"required":["begin","end","text"]}},"required":["type","begin","end","text"]},"MessageType":{"type":"string","description":"The type of the message","enum":["user","bot","reasoning","context","instruction","backstory","activity","checkpoint"]},"Trigger":{"type":"string","description":"The type of the trigger","enum":["never","automatic"]},"Schedule":{"type":"string","description":"The schedule","enum":["never","quarterhourly","halfhourly","hourly","twicedaily","daily","twiceweekly","weekly","twicemonthly","monthly"]},"SyncStatus":{"type":"string","description":"The sync status of an integration","enum":["pending","synced","error"]},"TaskStatus":{"type":"string","description":"The task execution status","enum":["idle","running"]},"TaskOutcome":{"type":"string","description":"The task execution outcome","enum":["pending","success","failure"]},"BlueprintVisibility":{"type":"string","description":"The blueprint visibility","enum":["private","protected","public"]},"BotVisibility":{"type":"string","description":"The bot visibility","enum":["private","protected","public"]},"DatasetVisibility":{"type":"string","description":"The dataset visibility","enum":["private","protected","public"]},"DatasetFileAttachmentType":{"type":"string","description":"The dataset file attachment type","enum":["source"]},"DatasetFilter":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object","properties":{"$eq":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"required":["$eq"],"additionalProperties":false},{"type":"object","properties":{"$ne":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}]}},"required":["$ne"],"additionalProperties":false},{"type":"object","properties":{"$gt":{"type":"number"}},"required":["$gt"],"additionalProperties":false},{"type":"object","properties":{"$gte":{"type":"number"}},"required":["$gte"],"additionalProperties":false},{"type":"object","properties":{"$lt":{"type":"number"}},"required":["$lt"],"additionalProperties":false},{"type":"object","properties":{"$lte":{"type":"number"}},"required":["$lte"],"additionalProperties":false}]}},"SkillsetVisibility":{"type":"string","description":"The skillset visibility","enum":["private","protected","public"]},"FileVisibility":{"type":"string","description":"The file visibility","enum":["private","protected","public"]},"SecretType":{"type":"string","description":"The type of the secret","enum":["plain","basic","bearer","oauth","template","reference"]},"SecretKind":{"type":"string","description":"The kind of the secret","enum":["shared","personal"]},"SecretVisibility":{"type":"string","description":"The visibility of the secret","enum":["private","protected","public"]},"Usage":{"type":"object","description":"Usage information","properties":{"token":{"type":"number","description":"The tokens used in this exchange"}},"required":["token"]},"CompleteReason":{"type":"string","description":"The reason why the completion ended","enum":["length","stop","activity","error","iteration"]},"CompleteEnd":{"type":"object","description":"Information about why the completion ended","properties":{"reason":{"$ref":"#/components/schemas/CompleteReason"}},"required":["reason"]},"ExecutionLimits":{"type":"object","description":"Execution limits to control conversation processing bounds","properties":{"iterations":{"type":"integer","minimum":1,"description":"Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses."},"continuations":{"type":"integer","minimum":1,"description":"Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition."},"calls":{"type":"integer","minimum":1,"description":"Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation."}}},"PolicyType":{"type":"string","description":"The policy type","enum":["retention"]},"Limits":{"type":"object","description":"Limits information","properties":{"tokens":{"type":"number","description":"The tokens limit"},"conversations":{"type":"number","description":"The conversations limit"},"messages":{"type":"number","description":"The messages limit"},"database":{"type":"object","description":"The database limits","properties":{"datasets":{"type":"number","description":"The datasets limit"},"records":{"type":"number","description":"The records limit"},"skillsets":{"type":"number","description":"The skillsets limit"},"abilities":{"type":"number","description":"The abilities limit"},"files":{"type":"number","description":"The files limit"}}}}},"Meta":{"type":"object","description":"Meta data information","additionalProperties":true},"Model":{"type":"string","description":"A model definition","pattern":"\\w+(?:\\/\\w+=\\w+)*","example":"gpt-4-turbo/temperature=0.7"},"BotRef":{"type":"object","description":"A bot configuration that can be applied without a dedicated bot instance.","properties":{"botId":{"type":"string","description":"The ID of the bot this configuration is using"}}},"BotConfig":{"type":"object","description":"A bot configuration that can be applied without a dedicated bot instance.","properties":{"model":{"$ref":"#/components/schemas/Model"},"backstory":{"type":"string","description":"The backstory this configuration is using"},"datasetId":{"type":"string","description":"The id of the dataset this configuration is using"},"skillsetId":{"type":"string","description":"The id of the skillset this configuration is using"},"privacy":{"type":"boolean","description":"The privacy flag for this configuration"},"moderation":{"type":"boolean","description":"The moderation flag for this configuration"}}},"BotRefOrConfig":{"description":"A bot configuration or reference","oneOf":[{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BotConfig"}]},"BlueprintProps":{"type":"object","description":"Blueprint properties","properties":{"blueprintId":{"type":"string","description":"The ID of the blueprint"}}},"InstanceRefProperties":{"description":"Instance reference properties","type":"object","properties":{"alias":{"type":"string","description":"The unique alias for the instance"}}},"InstanceMetaProps":{"description":"Instance list properties","type":"object","properties":{"id":{"type":"string","description":"The instance ID"},"createdAt":{"type":"number","description":"The timestamp (ms) when the instance was created"},"updatedAt":{"type":"number","description":"The timestamp (ms) when the instance was updated"}},"required":["id","createdAt","updatedAt"]},"InstanceCrudProps":{"type":"object","description":"Instance crud properties","properties":{"name":{"type":"string","description":"The associated name"},"description":{"type":"string","description":"The associated description"},"meta":{"$ref":"#/components/schemas/Meta"}}},"InstanceListProps":{"description":"Instance list properties","allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/InstanceMetaProps"}]},"JsonSchemaObject":{"description":"A JSON Schema object type definition (https://json-schema.org/). Represents an object schema with properties and validation rules.","type":"object","properties":{"type":{"type":"string","enum":["object"],"description":"The schema type, must be \"object\""},"title":{"type":"string","description":"The schema title"},"description":{"type":"string","description":"The schema description"},"properties":{"type":"object","description":"Object property definitions","additionalProperties":true},"required":{"type":"array","description":"Required property names","items":{"type":"string"}}},"required":["type","properties"]},"FunctionsDefinition":{"description":"An array of functions to be added to the conversation","type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the function (must be a valid JS identifier, max 64 chars)","type":"string"},"description":{"description":"The description of the function","type":"string"},"parameters":{"description":"JSON Schema definition for the function parameters","type":"object","properties":{"type":{"description":"The schema type, must be \"object\"","type":"string","enum":["object"]},"properties":{"description":"Object property definitions","type":"object","additionalProperties":true},"required":{"description":"Required property names","type":"array","items":{"type":"string"}}},"required":["type","properties"]},"result":{"description":"The result of the function execution","oneOf":[{"type":"object","properties":{"data":{"description":"The data returned by the function (can be any type)"}},"required":["data"]},{"type":"object","properties":{"channel":{"description":"The channel for streaming function results","type":"string"}},"required":["channel"]}]},"call":{"description":"Configuration for when this function should be automatically called","type":"object","properties":{"start":{"description":"If true, this function will be force-called at the start of the conversation","type":"boolean"},"end":{"description":"If true, this function will be force-called at the end of the conversation","type":"boolean"}}}},"required":["name","description","parameters"]}},"ExtensionsDefinition":{"description":"Extensions to enhance the bot's capabilities","type":"object","properties":{"backstory":{"description":"Additional backstory for the bot","type":"string"},"datasets":{"description":"Inline datasets to provide additional context","type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the dataset","type":"string"},"description":{"description":"The description of the dataset","type":"string"},"records":{"description":"The records in the dataset","type":"array","items":{"type":"object","properties":{"text":{"description":"The text content of the record","type":"string"},"meta":{"description":"Additional metadata for the record","type":"object"}},"required":["text"]}}},"required":["records"]}},"skillsets":{"description":"Inline skillsets to provide additional abilities","type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the skillset","type":"string"},"description":{"description":"The description of the skillset","type":"string"},"abilities":{"description":"The abilities in the skillset","type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the ability","type":"string"},"description":{"description":"The description of the ability","type":"string"},"instruction":{"description":"The instruction for the ability","type":"string"},"secretId":{"description":"Optional secret ID for the ability","type":"string"},"meta":{"description":"Additional metadata for the ability","type":"object"}},"required":["name","description","instruction"]}}},"required":["abilities"]}},"features":{"description":"Feature flags to enable specific bot capabilities","type":"array","items":{"type":"object","properties":{"name":{"description":"The name of the feature to enable","type":"string"},"options":{"description":"Optional configuration options for the feature","type":"object","additionalProperties":true}},"required":["name"]}}}},"CompleteStreamingResponseItem":{"description":"An item in the streaming completion response","oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["error"]},"data":{"description":"The data for the event","type":"object","properties":{"message":{"description":"The error message","type":"string"}},"required":["message"]}},"required":["type","data"]},{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["token"]},"data":{"description":"The data for the event","type":"object","properties":{"token":{"description":"The token generated","type":"string"}},"required":["token"]}},"required":["type","data"]},{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["reasoningToken"]},"data":{"description":"The data for the event","type":"object","properties":{"token":{"description":"The token generated","type":"string"}},"required":["token"]}},"required":["type","data"]},{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["message"]},"data":{"allOf":[{"$ref":"#/components/schemas/Message"},{"type":"object","properties":{}}]}},"required":["type","data"]},{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["completeBegin"]},"data":{"description":"The data for the event","type":"object","properties":{},"additionalProperties":true}},"required":["type","data"]},{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["completeEnd"]},"data":{"description":"The data for the event","type":"object","properties":{},"additionalProperties":true}},"required":["type","data"]},{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["waitForChannelMessageBegin"]},"data":{"description":"The data for the event","type":"object","properties":{},"additionalProperties":true}},"required":["type","data"]},{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["waitForChannelMessageEnd"]},"data":{"description":"The data for the event","type":"object","properties":{},"additionalProperties":true}},"required":["type","data"]},{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["usage"]},"data":{"description":"The data for the event","type":"object","properties":{"model":{"description":"The model used","type":"string"},"inputTokensUsed":{"description":"The number of input tokens used","type":"number"},"outputTokensUsed":{"description":"The number of output tokens used","type":"number"}},"required":["model","inputTokensUsed","outputTokensUsed"]}},"required":["type","data"]}]}},"responses":{"ErrorResponse":{"type":"object","description":"An error response","properties":{"message":{"type":"string","description":"The error message"},"code":{"type":"string","description":"The error code"}},"required":["message","code"]}}},"security":[{"BearerAuth":[]}],"paths":{"/graphql":{"post":{"operationId":"graphql","summary":"Execute a GraphQL query","tags":["GraphQL"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"query":{"description":"The GraphQL query or mutation string","type":"string"},"variables":{"description":"The variables for the GraphQL operation","type":"object","additionalProperties":true},"operationName":{"description":"The name of the operation to execute","type":"string"}},"required":["query"]}}}},"responses":{"200":{"description":"The result of the GraphQL operation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"description":"The data returned by the GraphQL operation","type":"object","additionalProperties":true},"errors":{"description":"Any errors returned by the GraphQL operation","type":"array","items":{"type":"object","properties":{"message":{"type":"string"}}}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/report/{reportId}/generate":{"post":{"operationId":"generatePlatformReport","summary":"Generate a specific report","description":"Generates a report based on the specified report ID and input\nparameters.\n","tags":["Platform"],"parameters":[{"in":"path","name":"reportId","required":true,"schema":{"description":"The ID of the report to generate","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Input parameters specific to the report type","additionalProperties":true}}}},"responses":{"200":{"description":"The report was generated successfully","content":{"application/json":{"schema":{"type":"object","description":"Report output data specific to the report type"}}}},"404":{"description":"Report not found"},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/report/generate":{"post":{"operationId":"generatePlatformReports","summary":"Generate multiple reports","description":"Generates multiple reports in a single request. Input is a map where\neach key is a report ID and each value contains the input parameters\nfor that report. Returns a map with the same keys containing the\ncorresponding report outputs.\n","tags":["Platform"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Map of report IDs to their input parameters","additionalProperties":{"type":"object","description":"Input parameters specific to the report type"}},"example":{"clr3m5n8k000008jq7h9e5b1a":{"periodDays":30},"clr3m5n8k000108jq7h9e5b1b":{"periodDays":7}}}}},"responses":{"200":{"description":"The reports were generated successfully","content":{"application/json":{"schema":{"type":"object","description":"Map of report IDs to their output data or error","additionalProperties":{"oneOf":[{"type":"object","description":"Successful report output data"},{"type":"object","properties":{"error":{"type":"string","description":"Error message if report generation failed"}}}]}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/report/list":{"get":{"operationId":"listPlatformReports","summary":"Retrieve a list of available reports","tags":["Platform"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}}],"responses":{"200":{"description":"The list of reports was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{}}]}}},"required":["items"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1platform~1report~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/blueprint/{blueprintId}/clone":{"post":{"operationId":"cloneBlueprint","summary":"Clone a blueprint","tags":["Blueprint"],"parameters":[{"in":"path","name":"blueprintId","required":true,"schema":{"description":"The ID of the blueprint to clone","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The blueprint was cloned successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the cloned blueprint","type":"string"},"resources":{"description":"A map of the resources that were cloned","type":"object"}},"required":["id","resources"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/blueprint/{blueprintId}/delete":{"post":{"operationId":"deleteBlueprint","summary":"Delete a blueprint","tags":["Blueprint"],"parameters":[{"in":"path","name":"blueprintId","required":true,"schema":{"description":"The ID of the blueprint to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"deleteResources":{"description":"If true, deletes all resources associated with the blueprint. If false or omitted, only the blueprint is deleted.","type":"boolean","default":false}}}}}},"responses":{"200":{"description":"The blueprint was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted blueprint","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/blueprint/{blueprintId}/fetch":{"get":{"operationId":"fetchBlueprint","summary":"Fetch a blueprint","tags":["Blueprint"],"parameters":[{"in":"path","name":"blueprintId","required":true,"schema":{"description":"The ID of the blueprint to retrieve","type":"string"}}],"responses":{"200":{"description":"The blueprint was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"visibility":{"$ref":"#/components/schemas/BlueprintVisibility"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/blueprint/{blueprintId}/resource/export":{"get":{"operationId":"exportBlueprintResources","summary":"Export blueprint resources","description":"Export a blueprint and all its resources. The default format is JSON.\nSet the Accept header to `application/terraform+hcl` to export as\nTerraform HCL code.\n","tags":["Blueprint Resources"],"parameters":[{"in":"path","name":"blueprintId","required":true,"schema":{"description":"The ID of the blueprint to export","type":"string"}},{"in":"header","name":"Accept","schema":{"description":"The desired export format","type":"string","enum":["application/json","application/terraform+hcl"],"default":"application/json"}}],"responses":{"200":{"description":"The blueprint was exported successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the blueprint","type":"string"},"name":{"description":"The name of the blueprint","type":"string"},"description":{"description":"The description of the blueprint","type":"string"},"resources":{"description":"A map of the resources by category","type":"object"}},"required":["id","resources"]}},"application/terraform+hcl":{"schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/blueprint/{blueprintId}/resource/import":{"post":{"operationId":"importBlueprintResources","summary":"Import resources into an existing blueprint","description":"Caller-provided resource ids are ignored and replaced with platform-generated ids.","tags":["Blueprint Resources"],"parameters":[{"in":"path","name":"blueprintId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"type":"object"}},"required":["resource"]}}}},"responses":{"200":{"description":"Resources were imported successfully"},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/blueprint/{blueprintId}/resource/list":{"get":{"operationId":"listBlueprintResources","summary":"List the resources of a blueprint","tags":["Blueprint Resources"],"parameters":[{"in":"path","name":"blueprintId","required":true,"schema":{"description":"The ID of the blueprint to clone","type":"string"}}],"responses":{"200":{"description":"Blueprint resources were retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the blueprint","type":"string"},"resources":{"description":"A map of the resources","type":"object"}},"required":["id","resources"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/blueprint/{blueprintId}/update":{"post":{"operationId":"updateBlueprint","summary":"Update blueprint","tags":["Blueprint"],"parameters":[{"in":"path","name":"blueprintId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceRefProperties"},{"$ref":"#/components/schemas/InstanceCrudProps"},{"type":"object","properties":{"visibility":{"$ref":"#/components/schemas/BlueprintVisibility"}}}]}}}},"responses":{"200":{"description":"The blueprint was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the updated blueprint","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/blueprint/create":{"post":{"operationId":"createBlueprint","summary":"Create blueprint","tags":["Blueprint"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceRefProperties"},{"$ref":"#/components/schemas/InstanceCrudProps"},{"type":"object","properties":{"visibility":{"$ref":"#/components/schemas/BlueprintVisibility"}}}]}}}},"responses":{"200":{"description":"The blueprint was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created blueprint","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/blueprint/list":{"get":{"operationId":"listBlueprints","summary":"Retrieve a list of blueprints","tags":["Blueprint"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of blueprints was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"visibility":{"$ref":"#/components/schemas/BlueprintVisibility"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1blueprint~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/bot/{botId}/clone":{"post":{"operationId":"cloneBot","summary":"Clone bot","tags":["Bot"],"parameters":[{"in":"path","name":"botId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"The bot was cloned successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the cloned bot","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/bot/{botId}/delete":{"post":{"operationId":"deleteBot","summary":"Delete a bot","tags":["Bot"],"parameters":[{"in":"path","name":"botId","required":true,"schema":{"description":"The ID of the bot to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The bot was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted bot","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/bot/{botId}/downvote":{"post":{"operationId":"downvoteBot","summary":"Downvote a bot","tags":["Bot"],"parameters":[{"in":"path","name":"botId","required":true,"schema":{"description":"The ID of the bot","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"description":"The value of the downvote","type":"integer","minimum":-100,"maximum":-1,"default":-100},"reason":{"description":"The reason for the downvote","type":"string"}}}}}},"responses":{"200":{"description":"The message was downvoted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The bot ID of the downvoted bot","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/bot/{botId}/fetch":{"get":{"operationId":"fetchBot","summary":"Fetch a bot","tags":["Bot"],"parameters":[{"in":"path","name":"botId","required":true,"schema":{"description":"The ID of the bot to retrieve","type":"string"}}],"responses":{"200":{"description":"The bot was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotConfig"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"visibility":{"$ref":"#/components/schemas/BotVisibility"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/bot/{botId}/memory/search":{"post":{"operationId":"searchBotMemory","summary":"Search memories for a specific bot","tags":["Bot Memory"],"parameters":[{"in":"path","name":"botId","required":true,"schema":{"description":"The ID of the bot to search memories for","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"description":"The keyword/phrase to search for","type":"string"}},"required":["search"]}}}},"responses":{"200":{"description":"The search was successful","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"description":"An array of memories matching the search query","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"meta":{"type":"object"}},"required":["id","text"]}}},"required":["items"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/bot/{botId}/session/create":{"post":{"operationId":"createBotSession","summary":"Create bot session","tags":["Bot Session"],"parameters":[{"in":"path","name":"botId","required":true,"schema":{"description":"The ID of the bot for this session","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"durationInSeconds":{"description":"The maximum amount of time this session will stay open","type":"number"},"messages":{"description":"An array of messages to be included in the conversation","type":"array","items":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/MessageType"},"text":{"description":"The text of the message","type":"string"}},"required":["type","text"]}},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"responses":{"200":{"description":"The bot was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the bot","type":"string"},"conversationId":{"description":"The ID of the conversation","type":"string"},"token":{"description":"The token for this conversation","type":"string"},"expiresAt":{"description":"The time the token will expire in milliseconds","type":"number"},"messages":{"description":"An array of messages included in the conversation","type":"array","items":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/MessageType"},"text":{"description":"The text of the message","type":"string"}},"required":["type","text"]}}},"required":["id","conversationId","token","expiresAt"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/bot/{botId}/update":{"post":{"operationId":"updateBot","summary":"Update bot","tags":["Bot"],"parameters":[{"in":"path","name":"botId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceRefProperties"},{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BotConfig"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"visibility":{"$ref":"#/components/schemas/BotVisibility"}}}]}}}},"responses":{"200":{"description":"The bot was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the updated bot","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/bot/{botId}/upvote":{"post":{"operationId":"upvoteBot","summary":"Upvote a bot","tags":["Bot"],"parameters":[{"in":"path","name":"botId","required":true,"schema":{"description":"The ID of the bot","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"description":"The value of the upvote","type":"integer","minimum":1,"maximum":100,"default":100},"reason":{"description":"The reason for the upvote","type":"string"}}}}}},"responses":{"200":{"description":"The bot was upvoted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the upvoted bot","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/bot/{botId}/usage/fetch":{"get":{"operationId":"fetchBotUsage","summary":"Fetch bot usage statistics","description":"Retrieve usage statistics for a specific bot, including total tokens\n(BASE type only), total conversations, and total messages. Optionally\nfilter by date range.\n","tags":["Bot"],"parameters":[{"in":"path","name":"botId","required":true,"schema":{"description":"The ID of the bot","type":"string"}},{"in":"query","name":"from","schema":{"description":"Start date for the period (ISO 8601 format)","type":"string","format":"date-time"}},{"in":"query","name":"to","schema":{"description":"End date for the period (ISO 8601 format)","type":"string","format":"date-time"}}],"responses":{"200":{"description":"Bot usage statistics retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"tokens":{"description":"Total number of BASE tokens used","type":"integer"},"conversations":{"description":"Total number of conversations","type":"integer"},"messages":{"description":"Total number of messages","type":"integer"}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/bot/create":{"post":{"operationId":"createBot","summary":"Create bot","tags":["Bot"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceRefProperties"},{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BotConfig"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"visibility":{"$ref":"#/components/schemas/BotVisibility"}}}]}}}},"responses":{"200":{"description":"The bot was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created bot","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/bot/list":{"get":{"operationId":"listBots","summary":"Retrieve a list of bots","tags":["Bot"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of bots was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotConfig"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"visibility":{"$ref":"#/components/schemas/BotVisibility"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1bot~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/channel/{channelId}/publish":{"post":{"operationId":"publishChannelMessage","summary":"Publish a message to a channel","description":"Publish a message to a specific channel. The message will be broadcast\nto all subscribers currently listening to this channel via the\nsubscribe endpoint.\n","tags":["Channel"],"parameters":[{"in":"path","name":"channelId","required":true,"schema":{"description":"The ID of the channel to publish to (minimum 16 characters)","type":"string","minLength":16}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"The message to publish to the channel","type":"object","properties":{},"additionalProperties":true}},"required":["message"]}}}},"responses":{"200":{"description":"The message was published successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the channel the message was published to","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/channel/{channelId}/subscribe":{"post":{"operationId":"subscribeChannelMessages","summary":"Subscribe to channel messages","description":"Subscribe to a channel to receive real-time messages published to it.\nThis endpoint returns a streaming response that will continuously send\nmessage events as they are published to the channel via the publish\nendpoint. The connection remains open until the client closes it or\nan error occurs.\n","tags":["Channel"],"parameters":[{"in":"path","name":"channelId","required":true,"schema":{"description":"The ID of the channel to subscribe to (minimum 16 characters)","type":"string","minLength":16}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"historyLength":{"description":"Number of historical messages to replay from the channel\nbefore subscribing to live updates. When provided, the\nsubscriber will first receive up to this many recent\nmessages that were published before the subscription\nstarted. This is useful for catching up on messages that\nmay have been published during connection setup.\n","type":"integer","minimum":0,"maximum":10000}}}}}},"responses":{"200":{"description":"Successfully subscribed to channel messages","content":{"application/jsonl":{"schema":{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["message"]},"data":{"description":"The message data published to the channel","type":"object","properties":{},"additionalProperties":true}},"required":["type","data"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/contact/{contactId}/conversation/list":{"get":{"operationId":"listContactConversations","summary":"List contact conversations","tags":["Contact Conversation"],"parameters":[{"in":"path","name":"contactId","required":true,"schema":{"description":"The ID of the contact to list conversations for","type":"string"}},{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}}],"responses":{"200":{"description":"The list of conversations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRefOrConfig"},{"type":"object","properties":{"contactId":{"description":"The contact id assigned to this conversation","type":"string"},"taskId":{"description":"The task id assigned to this conversation","type":"string"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1contact~1{contactId}~1conversation~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/contact/{contactId}/delete":{"post":{"operationId":"deleteContact","summary":"Delete contact","tags":["Contact"],"parameters":[{"in":"path","name":"contactId","required":true,"schema":{"description":"The ID of the contact to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The contact was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted contact","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/contact/{contactId}/fetch":{"get":{"operationId":"fetchContact","summary":"Fetch contact","tags":["Contact"],"parameters":[{"in":"path","name":"contactId","required":true,"schema":{"description":"The ID of the contact to retrieve","type":"string"}}],"responses":{"200":{"description":"The contact was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"fingerprint":{"description":"The fingerprint of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"phone":{"description":"The phone number of the contact","type":"string"},"nick":{"description":"The nickname of the contact","type":"string"},"preferences":{"description":"The preferences of the contact","type":"string"},"verifiedAt":{"description":"The timestamp (ms) when the contact was verified","type":"number"}},"required":["fingerprint"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/contact/{contactId}/memory/list":{"get":{"operationId":"listContactMemories","summary":"List contact memories","tags":["Contact Memory"],"parameters":[{"in":"path","name":"contactId","required":true,"schema":{"description":"The ID of the contact to list memories for","type":"string"}},{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}}],"responses":{"200":{"description":"The list of memories was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"botId":{"description":"The ID of the bot the memory belongs to","type":"string"},"text":{"description":"The text of the memory","type":"string"}},"required":["text"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1contact~1{contactId}~1memory~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/contact/{contactId}/memory/search":{"post":{"operationId":"searchContactMemory","summary":"Search memories for a specific contact","tags":["Contact Memory"],"parameters":[{"in":"path","name":"contactId","required":true,"schema":{"description":"The ID of the contact to search memories for","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"description":"The keyword/phrase to search for","type":"string"}},"required":["search"]}}}},"responses":{"200":{"description":"The search was successful","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"description":"An array of memories matching the search query","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"meta":{"type":"object"}},"required":["id","text"]}}},"required":["items"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/contact/{contactId}/secret/{secretId}/authenticate":{"post":{"operationId":"authenticateContactSecret","summary":"Authenticate contact secret","tags":["Contact Secret"],"parameters":[{"in":"path","name":"contactId","required":true,"schema":{"type":"string","description":"The ID of the contact the secret belongs to"}},{"in":"path","name":"secretId","required":true,"schema":{"type":"string","description":"The ID of the secret to authenticate"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The contact secret is about to be authenticated","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the secret to authenticate","type":"string"},"url":{"description":"The URL to authenticate the secret","type":"string"}},"required":["id","url"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/contact/{contactId}/secret/{secretId}/revoke":{"post":{"operationId":"revokeContactSecret","summary":"Revoke contact secret","tags":["Contact Secret"],"parameters":[{"in":"path","name":"contactId","required":true,"schema":{"type":"string","description":"The ID of the contact the secret belongs to"}},{"in":"path","name":"secretId","required":true,"schema":{"type":"string","description":"The ID of the secret to be revoked"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The contact secret was revoked successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the revoked secret","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/contact/{contactId}/secret/{secretId}/verify":{"post":{"operationId":"verifyContactSecret","summary":"Verify contact secret","tags":["Contact Secret"],"parameters":[{"in":"path","name":"contactId","required":true,"schema":{"type":"string","description":"The ID of the contact the secret belongs to"}},{"in":"path","name":"secretId","required":true,"schema":{"type":"string","description":"The ID of the secret to be verified"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The contact secret was verified successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the verified secret","type":"string"},"status":{"description":"The status of the secret","type":"string","enum":["unauthenticated","authenticated"]},"action":{"oneOf":[{"description":"The action to take next","type":"object","properties":{"type":{"description":"The type of action to take","type":"string","enum":["authenticate"]},"url":{"description":"The URL to authenticate the secret","type":"string"}},"required":["type","url"]}]}},"required":["id","status"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/contact/{contactId}/secret/list":{"get":{"operationId":"listContactSecrets","summary":"List contact secrets","tags":["Contact Secret"],"parameters":[{"in":"path","name":"contactId","required":true,"schema":{"description":"The ID of the contact to list secrets for","type":"string"}},{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}}],"responses":{"200":{"description":"The list of secrets was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"type":{"description":"The type of the secret","type":"string"}},"required":["type"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1contact~1{contactId}~1secret~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/contact/{contactId}/space/list":{"get":{"operationId":"listContactSpaces","summary":"List contact spaces","tags":["Contact Space"],"parameters":[{"in":"path","name":"contactId","required":true,"schema":{"description":"The ID of the contact to list spaces for","type":"string"}},{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}}],"responses":{"200":{"description":"The list of spaces was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"contactId":{"description":"The contact id assigned to this space","type":"string"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1contact~1{contactId}~1space~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/contact/{contactId}/task/list":{"get":{"operationId":"listContactTasks","summary":"List contact tasks","tags":["Contact Task"],"parameters":[{"in":"path","name":"contactId","required":true,"schema":{"description":"The ID of the contact to list tasks for","type":"string"}},{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}}],"responses":{"200":{"description":"The list of tasks was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"contactId":{"description":"The contact id assigned to this task","type":"string"},"botId":{"type":"string","description":"The bot associated with the task"},"schedule":{"type":"string","description":"The schedule of the task"},"status":{"$ref":"#/components/schemas/TaskStatus"},"outcome":{"$ref":"#/components/schemas/TaskOutcome"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1contact~1{contactId}~1task~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/contact/{contactId}/update":{"post":{"operationId":"updateContact","summary":"Update contact","tags":["Contact"],"parameters":[{"in":"path","name":"contactId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"type":"object","properties":{"fingerprint":{"description":"The fingerprint of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"phone":{"description":"The phone number of the contact","type":"string"},"nick":{"description":"The nickname of the contact","type":"string"},"preferences":{"description":"The preferences of the contact","type":"string"},"verifiedAt":{"description":"The timestamp (ms) when the contact was verified","type":"number"}}}]}}}},"responses":{"200":{"description":"The contact was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the updated contact","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/contact/create":{"post":{"operationId":"createContact","summary":"Create a new contact","description":"Create a new contact with the given parameters.\n","tags":["Contact"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"type":"object","properties":{"fingerprint":{"description":"The fingerprint of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"phone":{"description":"The phone number of the contact","type":"string"},"nick":{"description":"The nickname of the contact","type":"string"},"preferences":{"description":"The preferences of the contact","type":"string"},"verifiedAt":{"description":"The timestamp (ms) when the contact was verified","type":"number"}}}]}}}},"responses":{"200":{"description":"The contact was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created contact","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/contact/ensure":{"post":{"operationId":"ensureContact","summary":"Ensure a contact exists or create a new one","description":"Ensure a contact with the given parameters exists or create a new one.\n","tags":["Contact"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"type":"object","properties":{"fingerprint":{"description":"The fingerprint of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"phone":{"description":"The phone number of the contact","type":"string"},"nick":{"description":"The nickname of the contact","type":"string"},"preferences":{"description":"The preferences of the contact","type":"string"},"verifiedAt":{"description":"The timestamp (ms) when the contact was verified","type":"number"}},"required":["fingerprint"]}]}}}},"responses":{"200":{"description":"The contact was ensured successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the ensured contact","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/contact/export":{"get":{"operationId":"exportContacts","summary":"Export contacts","tags":["Contact"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of contacts was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"fingerprint":{"description":"The fingerprint of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"phone":{"description":"The phone number of the contact","type":"string"},"nick":{"description":"The nickname of the contact","type":"string"},"preferences":{"description":"The preferences of the contact","type":"string"},"verifiedAt":{"description":"The timestamp (ms) when the contact was verified","type":"number"}},"required":["fingerprint"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1contact~1export/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}},"text/csv":{"schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/contact/list":{"get":{"operationId":"listContacts","summary":"List contacts","tags":["Contact"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of contacts was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"fingerprint":{"description":"The fingerprint of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"phone":{"description":"The phone number of the contact","type":"string"},"nick":{"description":"The nickname of the contact","type":"string"},"preferences":{"description":"The preferences of the contact","type":"string"},"verifiedAt":{"description":"The timestamp (ms) when the contact was verified","type":"number"}},"required":["fingerprint"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1contact~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/attachment/upload":{"post":{"operationId":"uploadConversationAttachment","summary":"Upload a file as a conversation attachment","description":"Upload the specified file to the conversation. The file can be\nspecified either as a HTTP URL, a data URL, a multipart/form-data, or\nas a raw file stream. There is currently a limit of 4.5MB for files\nuploaded via all available methods except for direct-to-source uploads\nwhen using application/json request body with a file object.\n","tags":["Conversation Attachment"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"file":{"description":"The file to upload either as http: or data: URL","type":"string"}}},{"type":"object","properties":{"file":{"description":"The file definition to upload","type":"object","properties":{"type":{"description":"The file type","type":"string"},"size":{"description":"The file size","type":"number"},"name":{"description":"The file name","type":"string"}},"required":["type","size"]}}}],"required":["file"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"The file to upload","type":"string","format":"binary"}},"required":["file"]}},"*/*":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"The file was uploaded successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the upload file","type":"string"},"name":{"description":"The name of the uploaded file","type":"string"},"uploadRequest":{"description":"The request required to upload the file","type":"object","properties":{"method":{"description":"The HTTP method to use","type":"string"},"url":{"description":"The HTTP url to use","type":"string"},"headers":{"description":"The HTTP headers to use","type":"object"}},"required":["method","url","headers"]}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/compact":{"post":{"operationId":"compactConversation","summary":"Compact a conversation into a checkpoint","tags":["Conversation"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation to compact","type":"string"}}],"responses":{"200":{"description":"The conversation was compacted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created checkpoint message, or the conversation ID if there was nothing to compact","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/complete":{"post":{"operationId":"completeConversationMessage","summary":"Send and receive a conversation response","tags":["Conversation"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation to receive message from","type":"string"}},{"$ref":"#/components/parameters/TimezoneHeader"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"text":{"description":"The text of the message to send. Omit to continue receiving from the existing conversation state without sending a new user message.","type":"string"},"entities":{"description":"Known entities","type":"array","items":{"$ref":"#/components/schemas/Entity"}}}},{"type":"object","properties":{"functions":{"$ref":"#/components/schemas/FunctionsDefinition"},"extensions":{"$ref":"#/components/schemas/ExtensionsDefinition"}}},{"type":"object","properties":{"limits":{"$ref":"#/components/schemas/ExecutionLimits"}}}]}}}},"responses":{"200":{"description":"The next message in the conversation completed successfully","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"description":"The ID of the created message","type":"string"}},"required":["id"]},{"type":"object","properties":{"text":{"description":"The text of the message received","type":"string"},"usage":{"$ref":"#/components/schemas/Usage"},"end":{"$ref":"#/components/schemas/CompleteEnd"}},"required":["text","usage","end"]}]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["result"]},"data":{"$ref":"#/paths/~1conversation~1{conversationId}~1complete/post/responses/200/content/application~1json/schema"}},"required":["type","data"]},{"$ref":"#/components/schemas/CompleteStreamingResponseItem"}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/contact/upsert":{"post":{"operationId":"upsertConversationContact","summary":"Upsert contact","tags":["Conversation Contact"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"type":"object","properties":{"fingerprint":{"description":"The fingerprint of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"phone":{"description":"The phone number of the contact","type":"string"},"nick":{"description":"The nickname of the contact","type":"string"}}}]}}}},"responses":{"200":{"description":"The contact was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created contact","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/delete":{"post":{"operationId":"deleteConversation","summary":"Delete conversation","tags":["Conversation"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The conversation was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted conversation","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/dispatch":{"post":{"operationId":"dispatchStatefulConversation","summary":"Dispatch a stateful conversation completion to run in the background","description":"Dispatch a stateful conversation completion to run asynchronously in the\nbackground. This endpoint accepts the same parameters as the complete\nendpoint but instead of streaming the response directly, it returns a\nchannel ID that can be used to subscribe to the completion progress.\n\nThe completion will be processed in the background and events will be\npublished to the channel as the completion progresses. This is useful\nfor long-running completions that may take several minutes to complete.\n\nTo monitor the progress, subscribe to the channel using:\n`POST /api/v1/channel/{channelId}/subscribe`\n","tags":["Conversation"],"parameters":[{"$ref":"#/components/parameters/ConversationId"},{"$ref":"#/components/parameters/TimezoneHeader"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1conversation~1{conversationId}~1complete/post/requestBody/content/application~1json/schema"},{"type":"object","properties":{"channelId":{"description":"A unique ID to deduplicate dispatch requests","type":"string","minLength":24}}}]}}}},"responses":{"200":{"description":"The dispatch was queued successfully","content":{"application/json":{"schema":{"type":"object","properties":{"channelId":{"description":"The channel ID to subscribe to for completion events","type":"string"}},"required":["channelId"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/downvote":{"post":{"operationId":"downvoteConversation","summary":"Downvote conversation","tags":["Conversation"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"description":"The value of the downvote","type":"integer","minimum":-100,"maximum":-1,"default":-100},"reason":{"description":"The reason for the downvote","type":"string"}}}}}},"responses":{"200":{"description":"The message was downvoted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The conversation ID of the downvoted conversation","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/fetch":{"get":{"operationId":"fetchConversation","summary":"Fetch conversation","tags":["Conversation"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation to retrieve","type":"string"}}],"responses":{"200":{"description":"The conversation was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRefOrConfig"},{"type":"object","properties":{"contactId":{"description":"The contact id assigned to this conversation","type":"string"},"taskId":{"description":"The task id assigned to this conversation","type":"string"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/message/{messageId}/delete":{"post":{"operationId":"deleteConversationMessage","summary":"Delete a message","tags":["Conversation Message"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation containing the message","type":"string"}},{"in":"path","name":"messageId","required":true,"schema":{"description":"The ID of the message to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The message was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted message","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/message/{messageId}/downvote":{"post":{"operationId":"downvoteConversationMessage","summary":"Downvote conversation message","tags":["Conversation Message"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation","type":"string"}},{"in":"path","name":"messageId","required":true,"schema":{"description":"The ID of the message","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"description":"The value of the downvote","type":"integer","minimum":-100,"maximum":-1,"default":-100},"reason":{"description":"The reason for the downvote","type":"string"}}}}}},"responses":{"200":{"description":"The message was downvoted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the downvoted message","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/message/{messageId}/fetch":{"get":{"operationId":"fetchConversationMessage","summary":"Fetch conversation message","tags":["Conversation Message"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation containing the message","type":"string"}},{"in":"path","name":"messageId","required":true,"schema":{"description":"The ID of the message to retrieve","type":"string"}}],"responses":{"200":{"description":"The message was fetched successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/MessageType"},"text":{"description":"The text of the fetched message","type":"string"}},"required":["type","text"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/message/{messageId}/synthesize":{"post":{"operationId":"synthesizeConversationMessage","summary":"Synthesize conversation message","tags":["Conversation Message"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation","type":"string"}},{"in":"path","name":"messageId","required":true,"schema":{"description":"The ID of the message","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The message was synthesized successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the synthesized message","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/message/{messageId}/update":{"post":{"operationId":"updateConversationMessage","summary":"Update conversation message","tags":["Conversation Message"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation","type":"string"}},{"in":"path","name":"messageId","required":true,"schema":{"description":"The ID of the message","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/MessageType"},"text":{"description":"The updated text of the message","type":"string"},"entities":{"description":"Known entities","type":"array","items":{"$ref":"#/components/schemas/Entity"}}}}]}}}},"responses":{"200":{"description":"The message was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the updated message","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/message/{messageId}/upvote":{"post":{"operationId":"upvoteConversationMessage","summary":"Upvote conversation message","tags":["Conversation Message"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation","type":"string"}},{"in":"path","name":"messageId","required":true,"schema":{"description":"The ID of the message","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"description":"The value of the upvote","type":"integer","minimum":1,"maximum":100,"default":100},"reason":{"description":"The reason for the upvote","type":"string"}}}}}},"responses":{"200":{"description":"The message was upvoted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the upvoted message","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/message/create":{"post":{"operationId":"createConversationMessage","summary":"Create message","tags":["Conversation Message"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/MessageType"},"text":{"description":"The text of the message","type":"string"},"entities":{"description":"Known entities","type":"array","items":{"$ref":"#/components/schemas/Entity"}}},"required":["type","text"]}]}}}},"responses":{"200":{"description":"The message was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created message","type":"string"},"entities":{"description":"Extracted entities from the message","type":"array","items":{"$ref":"#/components/schemas/Entity"}}},"required":["id","entities"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/message/list":{"get":{"operationId":"listConversationMessages","summary":"List conversation messages","tags":["Conversation Message"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation to list messages for","type":"string"}},{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}}],"responses":{"200":{"description":"The messages were listed successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/MessageType"},"text":{"description":"The text of the message","type":"string"}},"required":["type","text"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1conversation~1{conversationId}~1message~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/receive":{"post":{"operationId":"receiveConversationMessage","summary":"Receive a conversation response","tags":["Conversation"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation to receive message from","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{}},{"type":"object","properties":{"functions":{"$ref":"#/components/schemas/FunctionsDefinition"},"extensions":{"$ref":"#/components/schemas/ExtensionsDefinition"}}}]}}}},"responses":{"200":{"description":"The message was received successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created message","type":"string"},"text":{"description":"The text of the message received","type":"string"},"usage":{"$ref":"#/components/schemas/Usage"}},"required":["id","text","usage"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["result"]},"data":{"$ref":"#/paths/~1conversation~1{conversationId}~1receive/post/responses/200/content/application~1json/schema"}}},{"$ref":"#/components/schemas/CompleteStreamingResponseItem"}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/send":{"post":{"operationId":"sendConversationMessage","summary":"Send a message to a conversation","tags":["Conversation"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation to send the message to","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"text":{"description":"The text of the message to send","type":"string"},"entities":{"description":"Known entities","type":"array","items":{"$ref":"#/components/schemas/Entity"}}},"required":["text"]},{"type":"object","properties":{"functions":{"$ref":"#/components/schemas/FunctionsDefinition"},"extensions":{"$ref":"#/components/schemas/ExtensionsDefinition"}}}]}}}},"responses":{"200":{"description":"The message was sent successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the sent message","type":"string"},"entities":{"description":"Extracted entities from the message","type":"array","items":{"$ref":"#/components/schemas/Entity"}}},"required":["id","entities"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["result"]},"data":{"$ref":"#/paths/~1conversation~1{conversationId}~1send/post/responses/200/content/application~1json/schema"}},"required":["type","data"]},{"$ref":"#/components/schemas/CompleteStreamingResponseItem"}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/session/create":{"post":{"operationId":"createConversationSession","summary":"Create conversation session","description":"Conversation tokens allow client-side applications to create a unique,\nauthenticated credential for each conversation. This token can be used\nto interact with the conversation/{conversationId}/send,\nconversation/{conversationId}/receive, and\nconversation/{conversationId}/message/create routes. By creating an\nindividual token for each conversation, a client-side application is\nable to directly access and manipulate the conversation through these\nroutes. Without conversation tokens, a client-side application would\nneed to authenticate and access conversation routes through a\nserver-side application, which can be more complex and require\nadditional infrastructure. By providing a way for client-side\napplications to authenticate and access the conversation routes\ndirectly, the token route simplifies the process of integrating with\nthe API and makes it more convenient for developers to build AI\napplications.\n","tags":["Conversation Session"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"type":"string","description":"The ID of the conversation"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"durationInSeconds":{"description":"The maximum amount of time this session will stay open","type":"number"}}}}}},"responses":{"200":{"description":"The session was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the conversation","type":"string"},"token":{"description":"The token for this conversation","type":"string"},"expiresAt":{"description":"The time the token will expire in milliseconds","type":"number"}},"required":["id","token","expiresAt"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/update":{"post":{"operationId":"updateConversation","summary":"Update conversation","tags":["Conversation"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BotRefOrConfig"},{"type":"object","properties":{"contactId":{"description":"The contact id assigned to this conversation","type":"string"},"taskId":{"description":"The task id assigned to this conversation","type":"string"},"spaceId":{"description":"The space id assigned to this conversation","type":"string"}}}]}}}},"responses":{"200":{"description":"The conversation was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the updated conversation","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/upvote":{"post":{"operationId":"upvoteConversation","summary":"Upvote conversation","tags":["Conversation"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"value":{"description":"The value of the upvote","type":"integer","minimum":1,"maximum":100,"default":100},"reason":{"description":"The reason for the upvote","type":"string"}}}}}},"responses":{"200":{"description":"The conversation was upvoted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the upvoted conversation","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/{conversationId}/usage/fetch":{"get":{"operationId":"fetchConversationUsage","summary":"Fetch conversation usage statistics","description":"Retrieve usage statistics for a specific conversation, including total tokens\n(BASE type only) and total messages. Optionally filter by date range.\n","tags":["Conversation"],"parameters":[{"in":"path","name":"conversationId","required":true,"schema":{"description":"The ID of the conversation","type":"string"}},{"in":"query","name":"from","schema":{"description":"Start date for the period (ISO 8601 format)","type":"string","format":"date-time"}},{"in":"query","name":"to","schema":{"description":"End date for the period (ISO 8601 format)","type":"string","format":"date-time"}}],"responses":{"200":{"description":"Conversation usage statistics retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"tokens":{"description":"Total number of BASE tokens used","type":"integer"},"messages":{"description":"Total number of messages","type":"integer"}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/complete":{"post":{"operationId":"completeConversation","summary":"Complete the next message in a conversation","tags":["Conversation"],"parameters":[{"$ref":"#/components/parameters/TimezoneHeader"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/BotRefOrConfig"},{"type":"object","properties":{"messages":{"description":"An array of messages to be added to the conversation","type":"array","items":{"$ref":"#/components/schemas/Message"}},"attachments":{"description":"An array of attachments to be added to the conversation","type":"array","items":{"type":"object","properties":{"url":{"description":"The URL of the attachment","type":"string"}}}}},"required":["messages"]},{"type":"object","properties":{"contactId":{"description":"The contact ID to associate with this conversation","oneOf":[{"type":"string","description":"An existing contact ID"},{"type":"object","description":"A contact object to create or retrieve a trusted contact","properties":{"fingerprint":{"description":"A unique fingerprint to identify the contact","type":"string"},"name":{"description":"The name of the contact","type":"string"},"description":{"description":"A description of the contact","type":"string"},"email":{"description":"The email address of the contact","type":"string"},"phone":{"description":"The phone number of the contact","type":"string"},"nick":{"description":"A nickname for the contact","type":"string"},"meta":{"description":"Additional metadata for the contact","type":"object","additionalProperties":true}},"required":["fingerprint"]}]}}},{"type":"object","properties":{"functions":{"$ref":"#/components/schemas/FunctionsDefinition"},"extensions":{"$ref":"#/components/schemas/ExtensionsDefinition"}}},{"type":"object","properties":{"limits":{"$ref":"#/components/schemas/ExecutionLimits"}}}]}}}},"responses":{"200":{"description":"The next message in the conversation completed successfully","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"text":{"description":"The text of the message received","type":"string"},"usage":{"$ref":"#/components/schemas/Usage"},"end":{"$ref":"#/components/schemas/CompleteEnd"}},"required":["text","usage","end"]}]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["result"]},"data":{"$ref":"#/paths/~1conversation~1complete/post/responses/200/content/application~1json/schema"}},"required":["type","data"]},{"$ref":"#/components/schemas/CompleteStreamingResponseItem"}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/create":{"post":{"operationId":"createConversation","summary":"Create a new conversation","description":"Create a new conversation with the given parameters and optional\nmessages. The conversation will be initialized with the the backstory,\nmodel, dataset, skillset and other configuration options of the bot.\nAlternatively the conversation can be initialized directly with the\nbackstory, model, dataset, skillset and other configuration options.\n\nAn array of messages can be included in the request body to add to the\nconversation.\n","tags":["Conversation"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BotRefOrConfig"},{"type":"object","properties":{"contactId":{"description":"The contact id assigned to this conversation","type":"string"},"taskId":{"description":"The task id assigned to this conversation","type":"string"},"spaceId":{"description":"The space id assigned to this conversation","type":"string"},"messages":{"description":"An array of messages to be added to the conversation","type":"array","items":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/MessageType"},"text":{"description":"The text of the message","type":"string"}},"required":["type","text"]}}}}]}}}},"responses":{"200":{"description":"The conversation was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created conversation","type":"string"},"messages":{"description":"An array of messages included in the conversation","type":"array","items":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/MessageType"},"text":{"description":"The text of the message","type":"string"}},"required":["type","text"]}}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/dispatch":{"post":{"operationId":"dispatchConversation","summary":"Dispatch a conversation completion to run in the background","description":"Dispatch a conversation completion to run asynchronously in the\nbackground. This endpoint accepts the same parameters as the complete\nendpoint but instead of streaming the response directly, it returns a\nchannel ID that can be used to subscribe to the completion progress.\n\nThe completion will be processed in the background and events will be\npublished to the channel as the completion progresses. This is useful\nfor long-running completions that may take several minutes to complete.\n\nTo monitor the progress, subscribe to the channel using:\n`POST /api/v1/channel/{channelId}/subscribe`\n","tags":["Conversation"],"parameters":[{"$ref":"#/components/parameters/TimezoneHeader"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/paths/~1conversation~1complete/post/requestBody/content/application~1json/schema"},{"type":"object","properties":{"channelId":{"description":"A unique channel ID to subscribe to for completion events","type":"string","minLength":24}}}]}}}},"responses":{"200":{"description":"The dispatch was queued successfully","content":{"application/json":{"schema":{"type":"object","properties":{"channelId":{"description":"The channel ID to subscribe to for completion events","type":"string"}},"required":["channelId"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/export":{"get":{"operationId":"exportConversations","summary":"Export conversations","tags":["Conversation"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of conversations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRefOrConfig"},{"type":"object","properties":{"contactId":{"description":"The contact id assigned to this conversation","type":"string"},"taskId":{"description":"The task id assigned to this conversation","type":"string"},"spaceId":{"description":"The space id assigned to this conversation","type":"string"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1conversation~1export/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}},"text/csv":{"schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/conversation/list":{"get":{"operationId":"listConversations","summary":"List conversations","tags":["Conversation"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of conversations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRefOrConfig"},{"type":"object","properties":{"contactId":{"description":"The contact id assigned to this conversation","type":"string"},"taskId":{"description":"The task id assigned to this conversation","type":"string"},"spaceId":{"description":"The space id assigned to this conversation","type":"string"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1conversation~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/dataset/{datasetId}/delete":{"post":{"operationId":"deleteDataset","summary":"Delete a dataset","tags":["Dataset"],"parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"description":"The ID of the dataset to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The dataset was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted dataset","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/dataset/{datasetId}/fetch":{"get":{"operationId":"fetchDataset","summary":"Fetch a dataset","tags":["Dataset"],"parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"description":"The ID of the dataset to retrieve","type":"string"}}],"responses":{"200":{"description":"The dataset was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"store":{"description":"The storage class for the dataset","type":"string"},"reranker":{"description":"The reranker class for the dataset","type":"string"},"recordMaxTokens":{"description":"The total number of tokens for each record","type":"number"},"searchMinScore":{"description":"The minimum score to filter search results by","type":"number"},"searchMaxRecords":{"description":"The total number of records to return during search","type":"number"},"searchMaxTokens":{"description":"The total number of tokens to use during search","type":"number"},"matchInstruction":{"description":"An instruction to include before found records","type":"string"},"mismatchInstruction":{"description":"An instruction to include if no records where found","type":"string"},"separators":{"description":"A list of separators to use when tokenizing text","type":"string"},"visibility":{"$ref":"#/components/schemas/DatasetVisibility"}},"required":["store"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/dataset/{datasetId}/file/{fileId}/attach":{"post":{"operationId":"attachDatasetFile","summary":"Attach dataset file","tags":["Dataset File"],"parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"description":"The ID of the dataset","type":"string"}},{"in":"path","name":"fileId","required":true,"schema":{"description":"The ID of the file","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DatasetFileAttachmentType"}}}}}},"responses":{"200":{"description":"The dataset file that was attached successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the dataset file","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/dataset/{datasetId}/file/{fileId}/detach":{"post":{"operationId":"detachDatasetFile","summary":"Detach dataset file","tags":["Dataset File"],"parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"description":"The ID of the dataset","type":"string"}},{"in":"path","name":"fileId","required":true,"schema":{"description":"The ID of the file","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"deleteRecords":{"type":"boolean","description":"Delete records associated with the file"}}}}}},"responses":{"200":{"description":"The dataset file that was detached successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the dataset file","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/dataset/{datasetId}/file/{fileId}/sync":{"post":{"operationId":"syncDatasetFile","summary":"Sync dataset file","tags":["Dataset File"],"parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"description":"The ID of the dataset","type":"string"}},{"in":"path","name":"fileId","required":true,"schema":{"description":"The ID of the file","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The dataset file that was synced successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the dataset file","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/dataset/{datasetId}/file/list":{"get":{"operationId":"listDatasetFiles","summary":"Retrieve a list of dataset files","tags":["Dataset File"],"parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"description":"The ID of the dataset","type":"string"}},{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}}],"responses":{"200":{"description":"The list of files was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"visibility":{"$ref":"#/components/schemas/FileVisibility"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1file~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/dataset/{datasetId}/record/{recordId}/delete":{"post":{"operationId":"deleteDatasetRecord","summary":"Delete a record from a dataset","tags":["Dataset Record"],"parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"description":"The ID of the dataset","type":"string"}},{"in":"path","name":"recordId","required":true,"schema":{"description":"The ID of the record to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The record was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted record","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/dataset/{datasetId}/record/{recordId}/fetch":{"get":{"operationId":"fetchDatasetRecord","summary":"Fetch a record from a dataset","tags":["Dataset Record"],"parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"description":"The ID of the dataset","type":"string"}},{"in":"path","name":"recordId","required":true,"schema":{"description":"The ID of the record to retrieve","type":"string"}}],"responses":{"200":{"description":"The dataset was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceMetaProps"},{"type":"object","properties":{"text":{"description":"The text of the dataset record","type":"string"},"source":{"description":"The source of the dataset record","type":"string"}},"required":["text"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/dataset/{datasetId}/record/{recordId}/update":{"post":{"operationId":"updateDatasetRecord","summary":"Update a dataset record","tags":["Dataset Record"],"parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"in":"path","name":"recordId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"description":"The text to update the record with","type":"string"},"source":{"description":"The source to update the record with","type":"string"},"meta":{"$ref":"#/components/schemas/Meta"}}}}}},"responses":{"200":{"description":"The record was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the updated record","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/dataset/{datasetId}/record/create":{"post":{"operationId":"createDatasetRecord","summary":"Create record","tags":["Dataset Record"],"parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"description":"The text of the record","type":"string"},"source":{"description":"The source of the record","type":"string"},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["text"]}}}},"responses":{"200":{"description":"The record was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created record","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/dataset/{datasetId}/record/export":{"get":{"operationId":"exportDatasetRecords","summary":"Export dataset records","tags":["Dataset Record"],"parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"description":"The ID of the dataset to export","type":"string"}},{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}}],"responses":{"200":{"description":"The export of dataset records was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceMetaProps"},{"type":"object","properties":{"text":{"type":"string"},"source":{"type":"string"}},"required":["text"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1dataset~1{datasetId}~1record~1export/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}},"text/csv":{"schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/dataset/{datasetId}/record/list":{"get":{"operationId":"listDatasetRecords","summary":"Retrieve a list of dataset records","tags":["Dataset Record"],"parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"description":"The ID of the dataset","type":"string"}},{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}}],"responses":{"200":{"description":"The list of records was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceMetaProps"},{"type":"object","properties":{"text":{"type":"string"},"source":{"type":"string"}},"required":["text"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1dataset~1{datasetId}~1record~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/dataset/{datasetId}/search":{"post":{"operationId":"searchDataset","summary":"Search a dataset for records matching a given search query","tags":["Dataset"],"parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"description":"The ID of the dataset to search","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"description":"The keyword/phrase to search for","type":"string"},"filter":{"$ref":"#/components/schemas/DatasetFilter"}},"required":["search"]}}}},"responses":{"200":{"description":"The search was successful","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the dataset that was searched","type":"string"},"records":{"description":"An array of records matching the search query","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"source":{"type":"string"},"meta":{"type":"object"},"score":{"type":"number"}},"required":["id","text","score"]}}},"required":["id","records"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/dataset/{datasetId}/update":{"post":{"operationId":"updateDataset","summary":"Update dataset","tags":["Dataset"],"parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceRefProperties"},{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"reranker":{"description":"The reranker class for the dataset","type":"string"},"recordMaxTokens":{"description":"The total number of tokens to for each record","type":"number"},"searchMinScore":{"description":"The minimum score to filter search results by","type":"number"},"searchMaxRecords":{"description":"The total number of records to return during search","type":"number"},"searchMaxTokens":{"description":"The total number of tokens to use during search","type":"number"},"matchInstruction":{"description":"An instruction to include before found records","type":"string"},"mismatchInstruction":{"description":"An instruction to include if no records where found","type":"string"},"separators":{"description":"A list of separators to use when tokenizing text","type":"string"},"visibility":{"$ref":"#/components/schemas/DatasetVisibility"}}}]}}}},"responses":{"200":{"description":"The dataset was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the updated dataset","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/dataset/create":{"post":{"operationId":"createDataset","summary":"Create dataset","tags":["Dataset"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceRefProperties"},{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"store":{"description":"The storage class for the dataset","type":"string"},"reranker":{"description":"The reranker class for the dataset","type":"string"},"recordMaxTokens":{"description":"The total number of tokens for each record","type":"number"},"searchMinScore":{"description":"The minimum score to filter search results by","type":"number"},"searchMaxRecords":{"description":"The total number of records to return during search","type":"number"},"searchMaxTokens":{"description":"The total number of tokens to use during search","type":"number"},"matchInstruction":{"description":"An instruction to include before found records","type":"string"},"mismatchInstruction":{"description":"An instruction to include if no records where found","type":"string"},"separators":{"description":"A list of separators to use when tokenizing text","type":"string"},"visibility":{"$ref":"#/components/schemas/DatasetVisibility"}}}]}}}},"responses":{"200":{"description":"The dataset was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created dataset","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/dataset/list":{"get":{"operationId":"listDatasets","summary":"Retrieve a list of datasets","tags":["Dataset"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of datasets was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"store":{"description":"The storage class for the dataset","type":"string"},"reranker":{"description":"The reranker class for the dataset","type":"string"},"recordMaxTokens":{"description":"The total number of tokens for each record","type":"number"},"searchMinScore":{"description":"The minimum score to filter search results by","type":"number"},"searchMaxRecords":{"description":"The total number of records to return during search","type":"number"},"searchMaxTokens":{"description":"The total number of tokens to use during search","type":"number"},"matchInstruction":{"description":"An instruction to include before found records","type":"string"},"mismatchInstruction":{"description":"An instruction to include if no records where found","type":"string"},"separators":{"description":"A list of separators to use when tokenizing text","type":"string"},"visibility":{"$ref":"#/components/schemas/DatasetVisibility"}},"required":["store"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1dataset~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/event/log/export":{"get":{"operationId":"exportEventLogs","summary":"Export event logs","tags":["Event"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of events was exported successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"type":{"description":"The type of event (e.g., 'conversation.create')","type":"string"},"conversationId":{"description":"Related conversation ID if applicable","type":"string"},"taskId":{"description":"Related task ID if applicable","type":"string"},"contactId":{"description":"Related contact ID if applicable","type":"string"},"blueprintId":{"description":"Related blueprint ID if applicable","type":"string"},"botId":{"description":"Related bot ID if applicable","type":"string"},"datasetId":{"description":"Related dataset ID if applicable","type":"string"},"recordId":{"description":"Related record ID if applicable","type":"string"},"skillsetId":{"description":"Related skillset ID if applicable","type":"string"},"abilityId":{"description":"Related ability ID if applicable","type":"string"},"fileId":{"description":"Related file ID if applicable","type":"string"},"secretId":{"description":"Related secret ID if applicable","type":"string"},"portalId":{"description":"Related portal ID if applicable","type":"string"},"widgetIntegrationId":{"description":"Related widget integration ID if applicable","type":"string"},"slackIntegrationId":{"description":"Related Slack integration ID if applicable","type":"string"},"discordIntegrationId":{"description":"Related Discord integration ID if applicable","type":"string"},"whatsappIntegrationId":{"description":"Related WhatsApp integration ID if applicable","type":"string"},"messengerIntegrationId":{"description":"Related Messenger integration ID if applicable","type":"string"},"telegramIntegrationId":{"description":"Related Telegram integration ID if applicable","type":"string"},"twilioIntegrationId":{"description":"Related Twilio integration ID if applicable","type":"string"},"emailIntegrationId":{"description":"Related email integration ID if applicable","type":"string"},"sitemapIntegrationId":{"description":"Related sitemap integration ID if applicable","type":"string"},"notionIntegrationId":{"description":"Related Notion integration ID if applicable","type":"string"},"triggerIntegrationId":{"description":"Related trigger integration ID if applicable","type":"string"},"supportIntegrationId":{"description":"Related support integration ID if applicable","type":"string"},"extractIntegrationId":{"description":"Related extract integration ID if applicable","type":"string"},"mcpserverIntegrationId":{"description":"Related MCP server integration ID if applicable","type":"string"}},"required":["type"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1event~1log~1export/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}},"text/csv":{"schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/event/log/list":{"get":{"operationId":"listEventLogs","summary":"List event logs","tags":["Event"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of events was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"type":{"description":"The type of event (e.g., 'conversation.create')","type":"string"},"conversationId":{"description":"Related conversation ID if applicable","type":"string"},"taskId":{"description":"Related task ID if applicable","type":"string"},"contactId":{"description":"Related contact ID if applicable","type":"string"},"blueprintId":{"description":"Related blueprint ID if applicable","type":"string"},"botId":{"description":"Related bot ID if applicable","type":"string"},"datasetId":{"description":"Related dataset ID if applicable","type":"string"},"recordId":{"description":"Related record ID if applicable","type":"string"},"skillsetId":{"description":"Related skillset ID if applicable","type":"string"},"abilityId":{"description":"Related ability ID if applicable","type":"string"},"fileId":{"description":"Related file ID if applicable","type":"string"},"secretId":{"description":"Related secret ID if applicable","type":"string"},"portalId":{"description":"Related portal ID if applicable","type":"string"},"widgetIntegrationId":{"description":"Related widget integration ID if applicable","type":"string"},"slackIntegrationId":{"description":"Related Slack integration ID if applicable","type":"string"},"discordIntegrationId":{"description":"Related Discord integration ID if applicable","type":"string"},"whatsappIntegrationId":{"description":"Related WhatsApp integration ID if applicable","type":"string"},"messengerIntegrationId":{"description":"Related Messenger integration ID if applicable","type":"string"},"telegramIntegrationId":{"description":"Related Telegram integration ID if applicable","type":"string"},"twilioIntegrationId":{"description":"Related Twilio integration ID if applicable","type":"string"},"emailIntegrationId":{"description":"Related email integration ID if applicable","type":"string"},"sitemapIntegrationId":{"description":"Related sitemap integration ID if applicable","type":"string"},"notionIntegrationId":{"description":"Related Notion integration ID if applicable","type":"string"},"triggerIntegrationId":{"description":"Related trigger integration ID if applicable","type":"string"},"supportIntegrationId":{"description":"Related support integration ID if applicable","type":"string"},"extractIntegrationId":{"description":"Related extract integration ID if applicable","type":"string"},"mcpserverIntegrationId":{"description":"Related MCP server integration ID if applicable","type":"string"}},"required":["type"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1event~1log~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/event/log/subscribe":{"post":{"operationId":"subscribeEventLogs","summary":"Subscribe to live event logs","description":"Subscribe to receive real-time event logs as they are generated. This\nendpoint returns a streaming response that continuously delivers events\nas they occur in your account. The connection remains open until the\nclient closes it or an error occurs.\n\nThis is useful for:\n- Real-time monitoring dashboards\n- Live debugging and troubleshooting\n- Building reactive integrations\n- Streaming event data to external systems\n\nFor historical event data, use the `/event/log/list` endpoint instead.\n","tags":["Event"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"historyLength":{"description":"Number of recent historical events to replay before\nsubscribing to live updates. When provided, the subscriber\nwill first receive up to this many recent events that were\nlogged before the subscription started. This is useful for\ncatching up on events that may have occurred during\nconnection setup.\n","type":"integer","minimum":0,"maximum":10000}}}}}},"responses":{"200":{"description":"Successfully subscribed to event logs","content":{"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1event~1log~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/file/{fileId}/delete":{"post":{"operationId":"deleteFile","summary":"Delete a file","tags":["File"],"parameters":[{"in":"path","name":"fileId","required":true,"schema":{"description":"The ID of the file to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The file was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted file","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/file/{fileId}/download":{"get":{"operationId":"downloadFile","summary":"Download a file","description":"Download a file. If the file is not public, the user must be\nauthenticated.\n","tags":["File"],"parameters":[{"in":"path","name":"fileId","required":true,"schema":{"description":"The ID of the file to download","type":"string"}}],"responses":{"200":{"description":"The file was downloaded successfully","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"description":"The URL to download the file","type":"string"}},"required":["url"]}},"*/*":{"schema":{"type":"string","format":"binary"}}}},"204":{"description":"The file resource exists but has no content stored yet"},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/file/{fileId}/fetch":{"get":{"operationId":"fetchFile","summary":"Fetch a file","tags":["File"],"parameters":[{"in":"path","name":"fileId","required":true,"schema":{"description":"The ID of the file to retrieve","type":"string"}}],"responses":{"200":{"description":"The file was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"visibility":{"$ref":"#/components/schemas/FileVisibility"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/file/{fileId}/sync":{"post":{"operationId":"syncFile","summary":"Sync file","tags":["File"],"parameters":[{"in":"path","name":"fileId","required":true,"schema":{"description":"The ID of the file to sync","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The file was synced successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the file","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/file/{fileId}/update":{"post":{"operationId":"updateFile","summary":"Update file","tags":["File"],"parameters":[{"in":"path","name":"fileId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceRefProperties"},{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"visibility":{"$ref":"#/components/schemas/FileVisibility"}}}]}}}},"responses":{"200":{"description":"The file was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the updated file","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/file/{fileId}/upload":{"post":{"operationId":"uploadFile","summary":"Upload the specified file","description":"Upload the specified file to the file storage service. The file can be\nspecified either as a HTTP URL, a data URL, a multipart/form-data, or\nas a raw file stream. There is currently a limit of 4.5MB for files\nuploaded via all available methods except for direct-to-source uploads\nwhen using application/json request body with a file object.\n","tags":["File"],"parameters":[{"in":"path","name":"fileId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"file":{"description":"The file to upload either as http: or data: URL","type":"string"}}},{"type":"object","properties":{"file":{"description":"The file definition to upload","type":"object","properties":{"type":{"description":"The file type","type":"string"},"size":{"description":"The file size","type":"number"},"name":{"description":"The file name","type":"string"}},"required":["type","size"]}}}],"required":["file"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"The file to upload","type":"string","format":"binary"}},"required":["file"]}},"*/*":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"The file was upload successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the upload file","type":"string"},"uploadRequest":{"description":"The request required to upload the file","type":"object","properties":{"method":{"description":"The HTTP method to use","type":"string"},"url":{"description":"The HTTP url to use","type":"string"},"headers":{"description":"The HTTP headers to use","type":"object"}},"required":["method","url","headers"]}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/file/create":{"post":{"operationId":"createFile","summary":"Create file","tags":["File"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceRefProperties"},{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"visibility":{"$ref":"#/components/schemas/FileVisibility"}}}]}}}},"responses":{"200":{"description":"The file was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created file","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/file/list":{"get":{"operationId":"listFiles","summary":"Retrieve a list of files","tags":["File"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of files was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"visibility":{"$ref":"#/components/schemas/FileVisibility"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1file~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/discord/{discordIntegrationId}/delete":{"post":{"operationId":"deleteDiscordIntegration","summary":"Delete Discord integration","tags":["Discord Integration"],"parameters":[{"in":"path","name":"discordIntegrationId","required":true,"schema":{"description":"The ID of the Discord integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Discord integration was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted Discord integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/discord/{discordIntegrationId}/fetch":{"get":{"operationId":"fetchDiscordIntegration","summary":"Fetch a discordIntegration","tags":["Discord Integration"],"parameters":[{"in":"path","name":"discordIntegrationId","required":true,"schema":{"description":"The ID of the Discord integration to retrieve","type":"string"}}],"responses":{"200":{"description":"The Discord integration was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"appId":{"description":"The Discord application ID","type":"string"},"handle":{"description":"The Discord command handle","type":"string"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The chat session duration","type":"number"},"allowFrom":{"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.","type":"string"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/discord/{discordIntegrationId}/setup":{"post":{"operationId":"setupDiscordIntegration","summary":"Setup Discord integration","tags":["Discord Integration"],"parameters":[{"in":"path","name":"discordIntegrationId","required":true,"schema":{"description":"The ID of the Discord integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Discord integration was setup successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the setup Discord integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/discord/{discordIntegrationId}/update":{"post":{"operationId":"updateDiscordIntegration","summary":"Update a Discord integration","tags":["Discord Integration"],"parameters":[{"in":"path","name":"discordIntegrationId","required":true,"schema":{"description":"The ID of the Discord integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"appId":{"description":"The Discord application ID","type":"string"},"botToken":{"description":"The Discord bot token","type":"string"},"publicKey":{"description":"The Discord public key","type":"string"},"handle":{"description":"The Discord command handle","type":"string"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The chat session duration","type":"number"},"allowFrom":{"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.","type":"string"}}}]}}}},"responses":{"200":{"description":"The Discord integration was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Discord Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/discord/create":{"post":{"operationId":"createDiscordIntegration","summary":"Create Discord integration","tags":["Discord Integration"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"appId":{"description":"The Discord application ID","type":"string"},"botToken":{"description":"The Discord bot token","type":"string"},"publicKey":{"description":"The Discord public key","type":"string"},"handle":{"description":"The Discord command handle","type":"string"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The chat session duration","type":"number"},"allowFrom":{"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.","type":"string"}}}]}}}},"responses":{"200":{"description":"The Discord integration was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Discord Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/discord/list":{"get":{"operationId":"listDiscordIntegrations","summary":"List Discord integrations","tags":["Discord Integration"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of Discord integrations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"appId":{"description":"The Discord application ID","type":"string"},"handle":{"description":"The Discord command handle","type":"string"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The chat session duration","type":"number"},"allowFrom":{"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.","type":"string"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1integration~1discord~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/email/{emailIntegrationId}/delete":{"post":{"operationId":"deleteEmailIntegration","summary":"Delete Email integration","tags":["Email Integration"],"parameters":[{"in":"path","name":"emailIntegrationId","required":true,"schema":{"description":"The ID of the Email integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Email integration was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted Email integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/email/{emailIntegrationId}/fetch":{"get":{"operationId":"fetchEmailIntegration","summary":"Fetch a emailIntegration","tags":["Email Integration"],"parameters":[{"in":"path","name":"emailIntegrationId","required":true,"schema":{"description":"The ID of the Email integration to retrieve","type":"string"}}],"responses":{"200":{"description":"The Email integration was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Weather the bot supports attachments","type":"boolean"},"allowFrom":{"description":"Newline-separated list of email patterns allowed to send messages to this integration","type":"string"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/email/{emailIntegrationId}/setup":{"post":{"operationId":"setupEmailIntegration","summary":"Setup a Email integration","tags":["Email Integration"],"parameters":[{"in":"path","name":"emailIntegrationId","required":true,"schema":{"description":"The ID of the Email integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Email integration was successfully setup","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Email Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/email/{emailIntegrationId}/update":{"post":{"operationId":"updateEmailIntegration","summary":"Update a Email integration","tags":["Email Integration"],"parameters":[{"in":"path","name":"emailIntegrationId","required":true,"schema":{"description":"The ID of the Email integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Weather the bot supports attachments","type":"boolean"},"allowFrom":{"description":"Newline-separated list of email patterns allowed to send messages to this integration","type":"string"}}}]}}}},"responses":{"200":{"description":"The Email integration was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Email Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/email/create":{"post":{"operationId":"createEmailIntegration","summary":"Create Email integration","tags":["Email Integration"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Weather the bot supports attachments","type":"boolean"},"allowFrom":{"description":"Newline-separated list of email patterns allowed to send messages to this integration","type":"string"}}}]}}}},"responses":{"200":{"description":"The Email integration was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Email Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/email/list":{"get":{"operationId":"listEmailIntegrations","summary":"List Email integrations","tags":["Email Integration"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of Email integrations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Weather the bot supports attachments","type":"boolean"},"allowFrom":{"description":"Newline-separated list of email patterns allowed to send messages to this integration","type":"string"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1integration~1email~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/extract/{extractIntegrationId}/delete":{"post":{"operationId":"deleteExtractIntegration","summary":"Delete Extract integration","tags":["Extract Integration"],"parameters":[{"in":"path","name":"extractIntegrationId","required":true,"schema":{"description":"The ID of the Extract integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Extract integration was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted Extract integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/extract/{extractIntegrationId}/fetch":{"get":{"operationId":"fetchExtractIntegration","summary":"Fetch a extractIntegration","tags":["Extract Integration"],"parameters":[{"in":"path","name":"extractIntegrationId","required":true,"schema":{"description":"The ID of the Extract integration to retrieve","type":"string"}}],"responses":{"200":{"description":"The Extract integration was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"botId":{"description":"The ID of the Bot to use","type":"string"},"schema":{"description":"The configured extraction schema","type":"object","additionalProperties":true},"request":{"description":"Optional webhook to receive the extracted data","type":"string"}},"required":["botId"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/extract/{extractIntegrationId}/trigger":{"post":{"operationId":"triggerExtractIntegration","summary":"Trigger extract integration on historic conversations","tags":["Extract Integration"],"parameters":[{"in":"path","name":"extractIntegrationId","required":true,"schema":{"description":"The ID of the Extract integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"conversationIds":{"description":"Array of conversation IDs to process","type":"array","items":{"type":"string"}},"sample":{"description":"Number of recent conversations to process (default 20)","type":"integer","minimum":1,"maximum":100}}}}}},"responses":{"200":{"description":"Extract integration trigger initiated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"ID of the extract integration","type":"string"},"triggered":{"description":"Number of conversations queued for processing","type":"number"}},"required":["id","triggered"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/extract/{extractIntegrationId}/update":{"post":{"operationId":"updateExtractIntegration","summary":"Update a Extract integration","tags":["Extract Integration"],"parameters":[{"in":"path","name":"extractIntegrationId","required":true,"schema":{"description":"The ID of the Extract integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"botId":{"description":"The ID of the Bot to use","type":"string"},"schema":{"description":"The configured extraction schema","type":"object","additionalProperties":true},"request":{"description":"Optional webhook to receive the extracted data","type":"string"},"model":{"description":"The language model to use for data extraction","type":"string"}}}]}}}},"responses":{"200":{"description":"The Extract integration was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Extract Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/extract/create":{"post":{"operationId":"createExtractIntegration","summary":"Create Extract integration","tags":["Extract Integration"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"botId":{"description":"The ID of the Bot to use","type":"string"},"schema":{"description":"The configured extraction schema","type":"object","additionalProperties":true},"request":{"description":"Optional webhook to receive the extracted data","type":"string"},"model":{"description":"The language model to use for data extraction","type":"string"}}}]}}}},"responses":{"200":{"description":"The Extract integration was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Extract Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/extract/list":{"get":{"operationId":"listExtractIntegrations","summary":"List Extract integrations","tags":["Extract Integration"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of Extract integrations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"botId":{"description":"The ID of the Bot to use","type":"string"},"schema":{"description":"The configured extraction schema","type":"object","additionalProperties":true},"request":{"description":"Optional webhook to receive the extracted data","type":"string"}},"required":["botId"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1integration~1extract~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/googlechat/{googlechatIntegrationId}/delete":{"post":{"operationId":"deleteGooglechatIntegration","summary":"Delete Google Chat integration","tags":["Google Chat Integration"],"parameters":[{"in":"path","name":"googlechatIntegrationId","required":true,"schema":{"description":"The ID of the Google Chat integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Google Chat integration was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted Google Chat integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/googlechat/{googlechatIntegrationId}/fetch":{"get":{"operationId":"fetchGooglechatIntegration","summary":"Fetch a Google Chat integration","tags":["Google Chat Integration"],"parameters":[{"in":"path","name":"googlechatIntegrationId","required":true,"schema":{"description":"The ID of the Google Chat integration to retrieve","type":"string"}}],"responses":{"200":{"description":"The Google Chat integration was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"serviceAccountKey":{"description":"The service account key (returned as '********' if configured, null otherwise)","type":"string"},"projectNumber":{"description":"The Google Cloud project number for JWT verification","type":"string"},"contactCollection":{"description":"Whether to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration for the integration","type":"number"},"autoRespond":{"description":"The auto-respond configuration","type":"string"},"allowFrom":{"description":"The allowed senders for this integration","type":"string"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/googlechat/{googlechatIntegrationId}/setup":{"post":{"operationId":"setupGooglechatIntegration","summary":"Setup Google Chat integration","tags":["Google Chat Integration"],"parameters":[{"in":"path","name":"googlechatIntegrationId","required":true,"schema":{"description":"The ID of the Google Chat integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Google Chat integration was set up successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Google Chat Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/googlechat/{googlechatIntegrationId}/update":{"post":{"operationId":"updateGooglechatIntegration","summary":"Update a Google Chat integration","tags":["Google Chat Integration"],"parameters":[{"in":"path","name":"googlechatIntegrationId","required":true,"schema":{"description":"The ID of the Google Chat integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"serviceAccountKey":{"description":"The Google service account JSON key for sending messages","type":"string"},"projectNumber":{"description":"The Google Cloud project number for JWT verification","type":"string"},"contactCollection":{"description":"Whether to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration for the integration","type":"number"},"autoRespond":{"description":"The auto-respond configuration","type":"string"},"allowFrom":{"description":"The allowed senders for this integration","type":"string"}}}]}}}},"responses":{"200":{"description":"The Google Chat integration was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Google Chat Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/googlechat/create":{"post":{"operationId":"createGooglechatIntegration","summary":"Create Google Chat integration","tags":["Google Chat Integration"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"serviceAccountKey":{"description":"The Google service account JSON key for sending messages via the Chat REST API","type":"string"},"projectNumber":{"description":"The Google Cloud project number used to verify incoming event JWT audience claims","type":"string"},"contactCollection":{"description":"Whether to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration for the Google Chat integration","type":"number"},"autoRespond":{"description":"Configure automatic response behavior. Use '@all' to respond to all messages, '@agent <instructions>' for agent-powered decisions, or custom instructions for lightweight LLM filtering. Null/empty defaults to DMs and direct messages only.","type":"string"},"allowFrom":{"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.","type":"string"}}}]}}}},"responses":{"200":{"description":"The Google Chat integration was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Google Chat Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/googlechat/list":{"get":{"operationId":"listGooglechatIntegrations","summary":"List Google Chat integrations","tags":["Google Chat Integration"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of Google Chat integrations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"serviceAccountKey":{"description":"The service account key (returned as '********' if configured, null otherwise)","type":"string"},"projectNumber":{"description":"The Google Cloud project number for JWT verification","type":"string"},"contactCollection":{"description":"Whether to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration for the integration","type":"number"},"autoRespond":{"description":"The auto-respond configuration","type":"string"},"allowFrom":{"description":"The allowed senders for this integration","type":"string"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1integration~1googlechat~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/instagram/{instagramIntegrationId}/delete":{"post":{"operationId":"deleteInstagramIntegration","summary":"Delete Instagram integration","tags":["Instagram Integration"],"parameters":[{"in":"path","name":"instagramIntegrationId","required":true,"schema":{"description":"The ID of the Instagram integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Instagram integration was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted Instagram integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/instagram/{instagramIntegrationId}/fetch":{"get":{"operationId":"fetchInstagramIntegration","summary":"Fetch an Instagram integration","tags":["Instagram Integration"],"parameters":[{"in":"path","name":"instagramIntegrationId","required":true,"schema":{"description":"The ID of the Instagram integration to retrieve","type":"string"}}],"responses":{"200":{"description":"The Instagram integration was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"verifyToken":{"description":"The Instagram integration verify token","type":"string"},"accessToken":{"description":"The Instagram integration access token (returned as '********' if configured, null otherwise)","type":"string"},"contactCollection":{"description":"Whether to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Whether the bot supports attachments","type":"boolean"}},"required":["verifyToken"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/instagram/{instagramIntegrationId}/setup":{"post":{"operationId":"setupInstagramIntegration","summary":"Setup an Instagram integration","tags":["Instagram Integration"],"parameters":[{"in":"path","name":"instagramIntegrationId","required":true,"schema":{"description":"The ID of the Instagram integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Instagram integration was successfully setup","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Instagram Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/instagram/{instagramIntegrationId}/update":{"post":{"operationId":"updateInstagramIntegration","summary":"Update an Instagram integration","tags":["Instagram Integration"],"parameters":[{"in":"path","name":"instagramIntegrationId","required":true,"schema":{"description":"The ID of the Instagram integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"accessToken":{"description":"The Instagram integration access token","type":"string"},"contactCollection":{"description":"Whether to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Whether the bot supports attachments","type":"boolean"}}}]}}}},"responses":{"200":{"description":"The Instagram integration was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Instagram Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/instagram/create":{"post":{"operationId":"createInstagramIntegration","summary":"Create Instagram integration","tags":["Instagram Integration"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"accessToken":{"description":"The Instagram integration access token","type":"string"},"contactCollection":{"description":"Whether to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Whether the bot supports attachments","type":"boolean"}}}]}}}},"responses":{"200":{"description":"The Instagram integration was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Instagram Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/instagram/list":{"get":{"operationId":"listInstagramIntegrations","summary":"List Instagram integrations","tags":["Instagram Integration"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of Instagram integrations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"verifyToken":{"description":"The Instagram integration verify token","type":"string"},"accessToken":{"description":"The Instagram integration access token (returned as '********' if configured, null otherwise)","type":"string"},"contactCollection":{"description":"Whether to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Whether the bot supports attachments","type":"boolean"}},"required":["verifyToken"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1integration~1instagram~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/mcpserver/{mcpserverIntegrationId}/delete":{"post":{"operationId":"deleteMcpServerIntegration","summary":"Delete McpServer integration","tags":["McpServer Integration"],"parameters":[{"in":"path","name":"mcpserverIntegrationId","required":true,"schema":{"description":"The ID of the McpServer integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The McpServer integration was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted McpServer integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/mcpserver/{mcpserverIntegrationId}/fetch":{"get":{"operationId":"fetchMcpServerIntegration","summary":"Fetch a mcpserverIntegration","tags":["McpServer Integration"],"parameters":[{"in":"path","name":"mcpserverIntegrationId","required":true,"schema":{"description":"The ID of the McpServer integration to retrieve","type":"string"}}],"responses":{"200":{"description":"The McpServer integration was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"skillsetId":{"description":"The ID of the skillset","type":"string"},"oAuthConnectionId":{"description":"The ID of the OAuth connection for IdP-based authentication","type":"string"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/mcpserver/{mcpserverIntegrationId}/update":{"post":{"operationId":"updateMcpServerIntegration","summary":"Update a McpServer integration","tags":["McpServer Integration"],"parameters":[{"in":"path","name":"mcpserverIntegrationId","required":true,"schema":{"description":"The ID of the McpServer integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"skillsetId":{"description":"The ID of the skillset","type":"string"},"oAuthConnectionId":{"description":"The ID of the OAuth connection for IdP-based authentication","type":"string"}}}]}}}},"responses":{"200":{"description":"The McpServer integration was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the McpServer Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/mcpserver/create":{"post":{"operationId":"createMcpServerIntegration","summary":"Create McpServer integration","tags":["McpServer Integration"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"skillsetId":{"description":"The ID of the skillset","type":"string"},"oAuthConnectionId":{"description":"The ID of the OAuth connection for IdP-based authentication","type":"string"}}}]}}}},"responses":{"200":{"description":"The McpServer integration was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the McpServer Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/mcpserver/list":{"get":{"operationId":"listMcpServerIntegrations","summary":"List McpServer integrations","tags":["McpServer Integration"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of McpServer integrations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"skillsetId":{"description":"The ID of the skillset","type":"string"},"oAuthConnectionId":{"description":"The ID of the OAuth connection for IdP-based authentication","type":"string"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1integration~1mcpserver~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/messenger/{messengerIntegrationId}/delete":{"post":{"operationId":"deleteMessengerIntegration","summary":"Delete Messenger integration","tags":["Messenger Integration"],"parameters":[{"in":"path","name":"messengerIntegrationId","required":true,"schema":{"description":"The ID of the Messenger integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Messenger integration was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted Messenger integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/messenger/{messengerIntegrationId}/fetch":{"get":{"operationId":"fetchMessengerIntegration","summary":"Fetch a messengerIntegration","tags":["Messenger Integration"],"parameters":[{"in":"path","name":"messengerIntegrationId","required":true,"schema":{"description":"The ID of the Messenger integration to retrieve","type":"string"}}],"responses":{"200":{"description":"The Messenger integration was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"verifyToken":{"description":"The Messenger integration verify token","type":"string"},"accessToken":{"description":"The Messenger integration access token (returned as '********' if configured, null otherwise)","type":"string"},"contactCollection":{"description":"Whether to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Weather the bot supports attachments","type":"boolean"}},"required":["verifyToken"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/messenger/{messengerIntegrationId}/setup":{"post":{"operationId":"setupMessengerIntegration","summary":"Setup a Messenger integration","tags":["Messenger Integration"],"parameters":[{"in":"path","name":"messengerIntegrationId","required":true,"schema":{"description":"The ID of the Messenger integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Messenger integration was successfully setup","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Messenger Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/messenger/{messengerIntegrationId}/update":{"post":{"operationId":"updateMessengerIntegration","summary":"Update a Messenger integration","tags":["Messenger Integration"],"parameters":[{"in":"path","name":"messengerIntegrationId","required":true,"schema":{"description":"The ID of the Messenger integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"accessToken":{"description":"The Messenger integration access token","type":"string"},"contactCollection":{"description":"Whether to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Weather the bot supports attachments","type":"boolean"}}}]}}}},"responses":{"200":{"description":"The Messenger integration was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Messenger Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/messenger/create":{"post":{"operationId":"createMessengerIntegration","summary":"Create Messenger integration","tags":["Messenger Integration"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"accessToken":{"description":"The Messenger integration access token","type":"string"},"contactCollection":{"description":"Whether to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Weather the bot supports attachments","type":"boolean"}}}]}}}},"responses":{"200":{"description":"The Messenger integration was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Messenger Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/messenger/list":{"get":{"operationId":"listMessengerIntegrations","summary":"List Messenger integrations","tags":["Messenger Integration"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of Messenger integrations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"verifyToken":{"description":"The Messenger integration verify token","type":"string"},"accessToken":{"description":"The Messenger integration access token (returned as '********' if configured, null otherwise)","type":"string"},"contactCollection":{"description":"Whether to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Weather the bot supports attachments","type":"boolean"}},"required":["verifyToken"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1integration~1messenger~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/notion/{notionIntegrationId}/delete":{"post":{"operationId":"deleteNotionIntegration","summary":"Delete Notion integration","tags":["Notion Integration"],"parameters":[{"in":"path","name":"notionIntegrationId","required":true,"schema":{"description":"The ID of the Notion integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Notion integration was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted Notion integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/notion/{notionIntegrationId}/fetch":{"get":{"operationId":"fetchNotionIntegration","summary":"Fetch a notionIntegration","tags":["Notion Integration"],"parameters":[{"in":"path","name":"notionIntegrationId","required":true,"schema":{"description":"The ID of the Notion integration to retrieve","type":"string"}}],"responses":{"200":{"description":"The Notion integration was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"datasetId":{"description":"The ID of the dataset to sync into","type":"string"},"token":{"description":"The Notion API token (returned as '********' if configured, null otherwise)","type":"string"},"syncStatus":{"$ref":"#/components/schemas/SyncStatus"},"syncSchedule":{"description":"The sync schedule","type":"string"},"lastSyncedAt":{"description":"The timestamp of the last successful sync","type":"string","format":"date-time"},"expiresIn":{"description":"The time in milliseconds until records expire","type":"number"}},"required":["datasetId"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/notion/{notionIntegrationId}/sync":{"post":{"operationId":"syncNotionIntegration","summary":"Sync Notion integration","tags":["Notion Integration"],"parameters":[{"in":"path","name":"notionIntegrationId","required":true,"schema":{"description":"The ID of the Notion integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Notion integration was synced successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the synced Notion integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/notion/{notionIntegrationId}/update":{"post":{"operationId":"updateNotionIntegration","summary":"Update a Notion integration","tags":["Notion Integration"],"parameters":[{"in":"path","name":"notionIntegrationId","required":true,"schema":{"description":"The ID of the Notion integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"datasetId":{"description":"The ID of the dataset to sync into","type":"string"},"token":{"description":"The Notion API token","type":"string"},"syncSchedule":{"description":"The sync schedule","type":"string"},"expiresIn":{"description":"The time in milliseconds until records expire","type":"number"}}}]}}}},"responses":{"200":{"description":"The Notion integration was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Notion Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/notion/create":{"post":{"operationId":"createNotionIntegration","summary":"Create Notion integration","tags":["Notion Integration"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"datasetId":{"description":"The ID of the dataset to sync into","type":"string"},"token":{"description":"The Notion API token","type":"string"},"syncSchedule":{"description":"The sync schedule","type":"string"},"expiresIn":{"description":"The time in milliseconds until records expire","type":"number"}}}]}}}},"responses":{"200":{"description":"The Notion integration was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Notion Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/notion/list":{"get":{"operationId":"listNotionIntegrations","summary":"List Notion integrations","tags":["Notion Integration"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of Notion integrations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"datasetId":{"description":"The ID of the dataset to sync into","type":"string"},"token":{"description":"The Notion API token (returned as '********' if configured, null otherwise)","type":"string"},"syncStatus":{"$ref":"#/components/schemas/SyncStatus"},"syncSchedule":{"description":"The sync schedule","type":"string"},"lastSyncedAt":{"description":"The timestamp of the last successful sync","type":"string","format":"date-time"},"expiresIn":{"description":"The time in milliseconds until records expire","type":"number"}},"required":["datasetId"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1integration~1notion~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/sitemap/{sitemapIntegrationId}/delete":{"post":{"operationId":"deleteSitemapIntegration","summary":"Delete Sitemap integration","tags":["Sitemap Integration"],"parameters":[{"in":"path","name":"sitemapIntegrationId","required":true,"schema":{"description":"The ID of the Sitemap integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Sitemap integration was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted Sitemap integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/sitemap/{sitemapIntegrationId}/fetch":{"get":{"operationId":"fetchSitemapIntegration","summary":"Fetch a sitemapIntegration","tags":["Sitemap Integration"],"parameters":[{"in":"path","name":"sitemapIntegrationId","required":true,"schema":{"description":"The ID of the Sitemap integration to retrieve","type":"string"}}],"responses":{"200":{"description":"The Sitemap integration was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"datasetId":{"description":"The ID of the dataset used in the Sitemap integration","type":"string"},"url":{"description":"The URL to use for this Sitemap integration","type":"string"},"glob":{"description":"The glob rules to use for this Sitemap integration","type":"string"},"selectors":{"description":"The selector rules to use for this Sitemap integration","type":"string"},"javascript":{"description":"Indicates if the Sitemap integration should use JavaScript during the spidering process","type":"boolean"},"syncStatus":{"$ref":"#/components/schemas/SyncStatus"},"syncSchedule":{"description":"The sync schedule to use for this Sitemap integration","type":"string"},"lastSyncedAt":{"description":"The timestamp of the last successful sync","type":"string","format":"date-time"},"expiresIn":{"description":"Record expiry in milliseconds","type":"number"}},"required":["datasetId"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/sitemap/{sitemapIntegrationId}/sync":{"post":{"operationId":"syncSitemapIntegration","summary":"Sync a Sitemap integration","tags":["Sitemap Integration"],"parameters":[{"in":"path","name":"sitemapIntegrationId","required":true,"schema":{"description":"The ID of the Sitemap integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Sitemap integration was scheduled for syncing successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Sitemap Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/sitemap/{sitemapIntegrationId}/update":{"post":{"operationId":"updateSitemapIntegration","summary":"Update a Sitemap integration","tags":["Sitemap Integration"],"parameters":[{"in":"path","name":"sitemapIntegrationId","required":true,"schema":{"description":"The ID of the Sitemap integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"datasetId":{"description":"The ID of the dataset to use for this Sitemap integration","type":"string"},"url":{"description":"The URL to use for this Sitemap integration","type":"string"},"glob":{"description":"The glob rules to use for this Sitemap integration","type":"string"},"selectors":{"description":"The selector rules to use for this Sitemap integration","type":"string"},"javascript":{"description":"Indicates if the Sitemap integration should use JavaScript during the spidering process","type":"boolean"},"syncSchedule":{"description":"The sync schedule to use for this Sitemap integration","type":"string"},"expiresIn":{"description":"Record expiry in milliseconds","type":"number"}}}]}}}},"responses":{"200":{"description":"The Sitemap integration was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Sitemap Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/sitemap/create":{"post":{"operationId":"createSitemapIntegration","summary":"Create Sitemap integration","tags":["Sitemap Integration"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"datasetId":{"description":"The ID of the dataset to use for this Sitemap integration","type":"string"},"url":{"description":"The URL to use for this Sitemap integration","type":"string"},"glob":{"description":"The glob rules to use for this Sitemap integration","type":"string"},"selectors":{"description":"The selector rules to use for this Sitemap integration","type":"string"},"javascript":{"description":"Indicates if the Sitemap integration should use JavaScript during the spidering process","type":"boolean"},"syncSchedule":{"description":"The sync schedule to use for this Sitemap integration","type":"string"},"expiresIn":{"description":"Record expiry in milliseconds","type":"number"}}}]}}}},"responses":{"200":{"description":"The Sitemap integration was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Sitemap Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/sitemap/list":{"get":{"operationId":"listSitemapIntegrations","summary":"List Sitemap integrations","tags":["Sitemap Integration"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of Sitemap integrations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"datasetId":{"description":"The ID of the dataset used in the Sitemap integration","type":"string"},"url":{"description":"The URL to use for this Sitemap integration","type":"string"},"glob":{"description":"The glob rules to use for this Sitemap integration","type":"string"},"selectors":{"description":"The selector rules to use for this Sitemap integration","type":"string"},"javascript":{"description":"Indicates if the Sitemap integration should use JavaScript during the spidering process","type":"boolean"},"syncStatus":{"$ref":"#/components/schemas/SyncStatus"},"syncSchedule":{"description":"The sync schedule to use for this Sitemap integration","type":"string"},"lastSyncedAt":{"description":"The timestamp of the last successful sync","type":"string","format":"date-time"},"expiresIn":{"description":"Record expiry in milliseconds","type":"number"}},"required":["datasetId"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1integration~1sitemap~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/slack/{slackIntegrationId}/delete":{"post":{"operationId":"deleteSlackIntegration","summary":"Delete Slack integration","tags":["Slack Integration"],"parameters":[{"in":"path","name":"slackIntegrationId","required":true,"schema":{"description":"The ID of the Slack integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Slack integration was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted Slack integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/slack/{slackIntegrationId}/fetch":{"get":{"operationId":"fetchSlackIntegration","summary":"Fetch a slackIntegration","tags":["Slack Integration"],"parameters":[{"in":"path","name":"slackIntegrationId","required":true,"schema":{"description":"The ID of the Slack integration to retrieve","type":"string"}}],"responses":{"200":{"description":"The Slack integration was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"signingSecret":{"description":"The signing secret (returned as '********' if configured, null otherwise)","type":"string"},"botToken":{"description":"The bot token (returned as '********' if configured, null otherwise)","type":"string"},"userToken":{"description":"The user token (returned as '********' if configured, null otherwise)","type":"string"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration for the Slack integration","type":"number"},"references":{"description":"Whether to enable references feature","type":"boolean"},"ratings":{"description":"Whether to enable ratings buttons feature","type":"boolean"},"visibleMessages":{"description":"The number of visible messages outside of the new thread","type":"number"},"autoRespond":{"description":"Configure automatic response behavior. Use '@all' to respond to all messages, '@agent <instructions>' for agent-powered decisions, or custom instructions for lightweight LLM filtering. Null/empty defaults to current behavior (DMs, mentions, threads only).","type":"string"},"allowFrom":{"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","type":"string"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/slack/{slackIntegrationId}/setup":{"post":{"operationId":"setupSlackIntegration","summary":"Setup Slack integration","tags":["Slack Integration"],"parameters":[{"in":"path","name":"slackIntegrationId","required":true,"schema":{"description":"The ID of the Slack integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Slack integration was setup successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the setup Slack integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/slack/{slackIntegrationId}/update":{"post":{"operationId":"updateSlackIntegration","summary":"Update a Slack integration","tags":["Slack Integration"],"parameters":[{"in":"path","name":"slackIntegrationId","required":true,"schema":{"description":"The ID of the Slack integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"signingSecret":{"description":"The signing secret for the Slack integration","type":"string"},"botToken":{"description":"The bot token for the Slack integration","type":"string"},"userToken":{"description":"The user token for the Slack integration","type":"string"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration for the Slack integration","type":"number"},"references":{"description":"Whether to enable references feature","type":"boolean"},"ratings":{"description":"Whether to enable ratings buttons feature","type":"boolean"},"visibleMessages":{"description":"The number of visible messages outside of the new thread","type":"number"},"autoRespond":{"description":"Configure automatic response behavior. Use '@all' to respond to all messages, '@agent <instructions>' for agent-powered decisions, or custom instructions for lightweight LLM filtering. Null/empty defaults to current behavior (DMs, mentions, threads only).","type":"string"},"allowFrom":{"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","type":"string"}}}]}}}},"responses":{"200":{"description":"The Slack integration was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Slack Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/slack/create":{"post":{"operationId":"createSlackIntegration","summary":"Create Slack integration","tags":["Slack Integration"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"signingSecret":{"description":"The signing secret for the Slack integration","type":"string"},"botToken":{"description":"The bot token for the Slack integration","type":"string"},"userToken":{"description":"The user token for the Slack integration","type":"string"},"sessionDuration":{"description":"The session duration for the Slack integration","type":"number"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"references":{"description":"Whether to enable references feature","type":"boolean"},"ratings":{"description":"Whether to enable ratings buttons feature","type":"boolean"},"visibleMessages":{"description":"The number of visible messages outside of the new thread","type":"number"},"autoRespond":{"description":"Configure automatic response behavior. Use '@all' to respond to all messages, '@agent <instructions>' for agent-powered decisions, or custom instructions for lightweight LLM filtering. Null/empty defaults to current behavior (DMs, mentions, threads only).","type":"string"},"allowFrom":{"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","type":"string"}}}]}}}},"responses":{"200":{"description":"The Slack integration was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Slack Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/slack/list":{"get":{"operationId":"listSlackIntegrations","summary":"List Slack integrations","tags":["Slack Integration"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of Slack integrations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"signingSecret":{"description":"The signing secret (returned as '********' if configured, null otherwise)","type":"string"},"botToken":{"description":"The bot token (returned as '********' if configured, null otherwise)","type":"string"},"userToken":{"description":"The user token (returned as '********' if configured, null otherwise)","type":"string"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration for the Slack integration","type":"number"},"references":{"description":"Whether to enable references feature","type":"boolean"},"ratings":{"description":"Whether to enable ratings buttons feature","type":"boolean"},"visibleMessages":{"description":"The number of visible messages outside of the new thread","type":"number"},"autoRespond":{"description":"Configure automatic response behavior. Use '@all' to respond to all messages, '@agent <instructions>' for agent-powered decisions, or custom instructions for lightweight LLM filtering. Null/empty defaults to current behavior (DMs, mentions, threads only).","type":"string"},"allowFrom":{"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","type":"string"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1integration~1slack~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/support/{supportIntegrationId}/delete":{"post":{"operationId":"deleteSupportIntegration","summary":"Delete Support integration","tags":["Support Integration"],"parameters":[{"in":"path","name":"supportIntegrationId","required":true,"schema":{"description":"The ID of the Support integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Support integration was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted Support integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/support/{supportIntegrationId}/fetch":{"get":{"operationId":"fetchSupportIntegration","summary":"Fetch a supportIntegration","tags":["Support Integration"],"parameters":[{"in":"path","name":"supportIntegrationId","required":true,"schema":{"description":"The ID of the Support integration to retrieve","type":"string"}}],"responses":{"200":{"description":"The Support integration was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"email":{"description":"The email to use","type":"string"}},"required":["botId"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/support/{supportIntegrationId}/trigger":{"post":{"operationId":"triggerSupportIntegration","summary":"Trigger support integration on historic conversations","tags":["Support Integration"],"parameters":[{"in":"path","name":"supportIntegrationId","required":true,"schema":{"description":"The ID of the Support integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"conversationIds":{"description":"Array of conversation IDs to process","type":"array","items":{"type":"string"}},"sample":{"description":"Number of recent conversations to process (default 20)","type":"integer","minimum":1,"maximum":1000}}}}}},"responses":{"200":{"description":"Support integration trigger initiated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"ID of the support integration","type":"string"},"triggered":{"description":"Number of conversations queued for processing","type":"number"}},"required":["id","triggered"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/support/{supportIntegrationId}/update":{"post":{"operationId":"updateSupportIntegration","summary":"Update a Support integration","tags":["Support Integration"],"parameters":[{"in":"path","name":"supportIntegrationId","required":true,"schema":{"description":"The ID of the Support integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"email":{"description":"The email to use","type":"string"}}}]}}}},"responses":{"200":{"description":"The Support integration was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Support Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/support/create":{"post":{"operationId":"createSupportIntegration","summary":"Create Support integration","tags":["Support Integration"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"email":{"description":"The email to use","type":"string"}}}]}}}},"responses":{"200":{"description":"The Support integration was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Support Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/support/list":{"get":{"operationId":"listSupportIntegrations","summary":"List Support integrations","tags":["Support Integration"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of Support integrations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"email":{"description":"The email to use","type":"string"}},"required":["botId"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1integration~1support~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/teams/{teamsIntegrationId}/delete":{"post":{"operationId":"deleteTeamsIntegration","summary":"Delete Teams integration","tags":["Teams Integration"],"parameters":[{"in":"path","name":"teamsIntegrationId","required":true,"schema":{"description":"The ID of the Teams integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Teams integration was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted Teams integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/teams/{teamsIntegrationId}/fetch":{"get":{"operationId":"fetchTeamsIntegration","summary":"Fetch a teamsIntegration","tags":["Teams Integration"],"parameters":[{"in":"path","name":"teamsIntegrationId","required":true,"schema":{"description":"The ID of the Teams integration to retrieve","type":"string"}}],"responses":{"200":{"description":"The Teams integration was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"botFrameworkAppId":{"description":"The Microsoft Bot Framework Application ID","type":"string"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The chat session duration","type":"number"},"allowFrom":{"description":"The allowed senders for this integration","type":"string"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/teams/{teamsIntegrationId}/setup":{"post":{"operationId":"setupTeamsIntegration","summary":"Setup Teams integration","tags":["Teams Integration"],"parameters":[{"in":"path","name":"teamsIntegrationId","required":true,"schema":{"description":"The ID of the Teams integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Teams integration was setup successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the setup Teams integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/teams/{teamsIntegrationId}/update":{"post":{"operationId":"updateTeamsIntegration","summary":"Update a Teams integration","tags":["Teams Integration"],"parameters":[{"in":"path","name":"teamsIntegrationId","required":true,"schema":{"description":"The ID of the Teams integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"botFrameworkAppId":{"description":"The Microsoft Bot Framework Application ID","type":"string"},"botFrameworkAppSecret":{"description":"The Microsoft Bot Framework Application Secret","type":"string"},"tenantId":{"description":"The Microsoft Entra tenant ID","type":"string"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The chat session duration","type":"number"},"allowFrom":{"description":"The allowed senders for this integration","type":"string"}}}]}}}},"responses":{"200":{"description":"The Teams integration was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Teams Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/teams/create":{"post":{"operationId":"createTeamsIntegration","summary":"Create Teams integration","tags":["Teams Integration"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"botFrameworkAppId":{"description":"The Microsoft Bot Framework Application ID","type":"string"},"botFrameworkAppSecret":{"description":"The Microsoft Bot Framework Application Secret","type":"string"},"tenantId":{"description":"The Microsoft Entra tenant ID","type":"string"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The chat session duration","type":"number"},"allowFrom":{"description":"The allowed senders for this integration","type":"string"}}}]}}}},"responses":{"200":{"description":"The Teams integration was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Teams Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/teams/list":{"get":{"operationId":"listTeamsIntegrations","summary":"List Teams integrations","tags":["Teams Integration"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of Teams integrations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"botFrameworkAppId":{"description":"The Microsoft Bot Framework Application ID","type":"string"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The chat session duration","type":"number"},"allowFrom":{"description":"The allowed senders for this integration","type":"string"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1integration~1teams~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/telegram/{telegramIntegrationId}/delete":{"post":{"operationId":"deleteTelegramIntegration","summary":"Delete Telegram integration","tags":["Telegram Integration"],"parameters":[{"in":"path","name":"telegramIntegrationId","required":true,"schema":{"description":"The ID of the Telegram integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Telegram integration was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted Telegram integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/telegram/{telegramIntegrationId}/fetch":{"get":{"operationId":"fetchTelegramIntegration","summary":"Fetch a telegramIntegration","tags":["Telegram Integration"],"parameters":[{"in":"path","name":"telegramIntegrationId","required":true,"schema":{"description":"The ID of the Telegram integration to retrieve","type":"string"}}],"responses":{"200":{"description":"The Telegram integration was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Weather the bot supports attachments","type":"boolean"},"allowFrom":{"description":"Newline-or-comma-separated list of allowed senders","type":"string"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/telegram/{telegramIntegrationId}/setup":{"post":{"operationId":"setupTelegramIntegration","summary":"Setup a Telegram integration","tags":["Telegram Integration"],"parameters":[{"in":"path","name":"telegramIntegrationId","required":true,"schema":{"description":"The ID of the Telegram integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Telegram integration was successfully setup","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Telegram Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/telegram/{telegramIntegrationId}/update":{"post":{"operationId":"updateTelegramIntegration","summary":"Update a Telegram integration","tags":["Telegram Integration"],"parameters":[{"in":"path","name":"telegramIntegrationId","required":true,"schema":{"description":"The ID of the Telegram integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"botToken":{"description":"The Telegram integration bot token","type":"string"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Weather the bot supports attachments","type":"boolean"},"allowFrom":{"description":"Newline-or-comma-separated list of allowed senders. Use @username or @numericId for users,","type":"string"}}}]}}}},"responses":{"200":{"description":"The Telegram integration was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Telegram Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/telegram/create":{"post":{"operationId":"createTelegramIntegration","summary":"Create Telegram integration","tags":["Telegram Integration"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"botToken":{"description":"The Telegram integration bot token","type":"string"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Weather the bot supports attachments","type":"boolean"},"allowFrom":{"description":"Newline-or-comma-separated list of allowed senders. Use @username or @numericId for users,","type":"string"}}}]}}}},"responses":{"200":{"description":"The Telegram integration was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Telegram Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/telegram/list":{"get":{"operationId":"listTelegramIntegrations","summary":"List Telegram integrations","tags":["Telegram Integration"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of Telegram integrations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Weather the bot supports attachments","type":"boolean"},"allowFrom":{"description":"Newline-or-comma-separated list of allowed senders. Use @username or @numericId for users,","type":"string"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1integration~1telegram~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/trigger/{triggerIntegrationId}/delete":{"post":{"operationId":"deleteTriggerIntegration","summary":"Delete Trigger integration","tags":["Trigger Integration"],"parameters":[{"in":"path","name":"triggerIntegrationId","required":true,"schema":{"description":"The ID of the Trigger integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Trigger integration was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted Trigger integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/trigger/{triggerIntegrationId}/fetch":{"get":{"operationId":"fetchTriggerIntegration","summary":"Fetch a triggerIntegration","tags":["Trigger Integration"],"parameters":[{"in":"path","name":"triggerIntegrationId","required":true,"schema":{"description":"The ID of the Trigger integration to retrieve","type":"string"}}],"responses":{"200":{"description":"The Trigger integration was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"secret":{"description":"The Trigger integration secret","type":"string"},"authenticate":{"description":"When enabled the integration requires authentication","type":"boolean"},"triggerSchedule":{"description":"The schedule for the trigger integration (interval, cron expression, ISO date, or null)","type":"string","nullable":true},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"maxIterations":{"description":"The maximum number of iterations per trigger execution","type":"number"},"maxTime":{"description":"The maximum time per trigger execution (in milliseconds)","type":"number"}},"required":["secret"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/trigger/{triggerIntegrationId}/invoke":{"post":{"operationId":"invokeTriggerIntegration","summary":"Invoke Trigger integration","tags":["Trigger Integration"],"parameters":[{"in":"path","name":"triggerIntegrationId","required":true,"schema":{"description":"The ID of the Trigger integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Trigger integration was trigged successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the trigged Trigger integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/trigger/{triggerIntegrationId}/setup":{"post":{"operationId":"setupTriggerIntegration","summary":"Setup a Trigger integration","tags":["Trigger Integration"],"parameters":[{"in":"path","name":"triggerIntegrationId","required":true,"schema":{"description":"The ID of the Trigger integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Trigger integration was successfully setup","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Trigger Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/trigger/{triggerIntegrationId}/update":{"post":{"operationId":"updateTriggerIntegration","summary":"Update a Trigger integration","tags":["Trigger Integration"],"parameters":[{"in":"path","name":"triggerIntegrationId","required":true,"schema":{"description":"The ID of the Trigger integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"authenticate":{"description":"When enabled the integration requires authentication","type":"boolean"},"triggerSchedule":{"description":"The schedule for the trigger integration (interval, cron expression, or ISO date)","type":"string","nullable":true},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"maxIterations":{"description":"The maximum number of iterations per trigger execution","type":"number"},"maxTime":{"description":"The maximum time per trigger execution in milliseconds","type":"number"}}}]}}}},"responses":{"200":{"description":"The Trigger integration was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Trigger Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/trigger/create":{"post":{"operationId":"createTriggerIntegration","summary":"Create Trigger integration","tags":["Trigger Integration"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"authenticate":{"description":"When enabled the integration requires authentication","type":"boolean"},"triggerSchedule":{"description":"The schedule for the trigger integration (interval, cron expression, or ISO date)","type":"string","nullable":true},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"maxIterations":{"description":"The maximum number of iterations per trigger execution","type":"number"},"maxTime":{"description":"The maximum time per trigger execution in milliseconds","type":"number"}}}]}}}},"responses":{"200":{"description":"The Trigger integration was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Trigger Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/trigger/list":{"get":{"operationId":"listTriggerIntegrations","summary":"List Trigger integrations","tags":["Trigger Integration"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of Trigger integrations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"secret":{"description":"The Trigger integration secret","type":"string"},"authenticate":{"description":"When enabled the integration requires authentication","type":"boolean"},"triggerSchedule":{"description":"The schedule for the trigger integration (interval, cron expression, ISO date, or null)","type":"string","nullable":true},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"maxIterations":{"description":"The maximum number of iterations per trigger execution","type":"number"},"maxTime":{"description":"The maximum time per trigger execution (in milliseconds)","type":"number"}},"required":["secret"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1integration~1trigger~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/twilio/{twilioIntegrationId}/delete":{"post":{"operationId":"deleteTwilioIntegration","summary":"Delete Twilio integration","tags":["Twilio Integration"],"parameters":[{"in":"path","name":"twilioIntegrationId","required":true,"schema":{"description":"The ID of the Twilio integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Twilio integration was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted Twilio integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/twilio/{twilioIntegrationId}/fetch":{"get":{"operationId":"fetchTwilioIntegration","summary":"Fetch a twilioIntegration","tags":["Twilio Integration"],"parameters":[{"in":"path","name":"twilioIntegrationId","required":true,"schema":{"description":"The ID of the Twilio integration to retrieve","type":"string"}}],"responses":{"200":{"description":"The Twilio integration was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/twilio/{twilioIntegrationId}/setup":{"post":{"operationId":"setupTwilioIntegration","summary":"Setup a Twilio integration","tags":["Twilio Integration"],"parameters":[{"in":"path","name":"twilioIntegrationId","required":true,"schema":{"description":"The ID of the Twilio integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Twilio integration was successfully setup","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Twilio Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/twilio/{twilioIntegrationId}/update":{"post":{"operationId":"updateTwilioIntegration","summary":"Update a Twilio integration","tags":["Twilio Integration"],"parameters":[{"in":"path","name":"twilioIntegrationId","required":true,"schema":{"description":"The ID of the Twilio integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"}}}]}}}},"responses":{"200":{"description":"The Twilio integration was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Twilio Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/twilio/create":{"post":{"operationId":"createTwilioIntegration","summary":"Create Twilio integration","tags":["Twilio Integration"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"}}}]}}}},"responses":{"200":{"description":"The Twilio integration was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Twilio Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/twilio/list":{"get":{"operationId":"listTwilioIntegrations","summary":"List Twilio integrations","tags":["Twilio Integration"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of Twilio integrations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1integration~1twilio~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/whatsapp/{whatsappIntegrationId}/delete":{"post":{"operationId":"deleteWhatsAppIntegration","summary":"Delete WhatsApp integration","tags":["WhatsApp Integration"],"parameters":[{"in":"path","name":"whatsappIntegrationId","required":true,"schema":{"description":"The ID of the WhatsApp integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The WhatsApp integration was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted WhatsApp integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/whatsapp/{whatsappIntegrationId}/fetch":{"get":{"operationId":"fetchWhatsAppIntegration","summary":"Fetch a whatsappIntegration","tags":["WhatsApp Integration"],"parameters":[{"in":"path","name":"whatsappIntegrationId","required":true,"schema":{"description":"The ID of the WhatsApp integration to retrieve","type":"string"}}],"responses":{"200":{"description":"The WhatsApp integration was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"verifyToken":{"description":"The WhatsApp integration verify token","type":"string"},"phoneNumberId":{"description":"The WhatsApp integration phone number ID","type":"string"},"accessToken":{"description":"The WhatsApp integration access token (returned as '********' if configured, null otherwise)","type":"string"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Weather the bot supports attachments","type":"boolean"},"allowFrom":{"description":"Newline-or-comma-separated list of allowed senders","type":"string"}},"required":["verifyToken"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/whatsapp/{whatsappIntegrationId}/setup":{"post":{"operationId":"setupWhatsAppIntegration","summary":"Setup a WhatsApp integration","tags":["WhatsApp Integration"],"parameters":[{"in":"path","name":"whatsappIntegrationId","required":true,"schema":{"description":"The ID of the WhatsApp integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The WhatsApp integration was successfully setup","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the WhatsApp Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/whatsapp/{whatsappIntegrationId}/update":{"post":{"operationId":"updateWhatsAppIntegration","summary":"Update a WhatsApp integration","tags":["WhatsApp Integration"],"parameters":[{"in":"path","name":"whatsappIntegrationId","required":true,"schema":{"description":"The ID of the WhatsApp integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"phoneNumberId":{"description":"The WhatsApp integration phone number ID","type":"string"},"accessToken":{"description":"The WhatsApp integration access token","type":"string"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Weather the bot supports attachments","type":"boolean"},"allowFrom":{"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.","type":"string"}}}]}}}},"responses":{"200":{"description":"The WhatsApp integration was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the WhatsApp Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/whatsapp/create":{"post":{"operationId":"createWhatsAppIntegration","summary":"Create WhatsApp integration","tags":["WhatsApp Integration"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"phoneNumberId":{"description":"The WhatsApp integration phone number ID","type":"string"},"accessToken":{"description":"The WhatsApp integration access token","type":"string"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Weather the bot supports attachments","type":"boolean"},"allowFrom":{"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.","type":"string"}}}]}}}},"responses":{"200":{"description":"The WhatsApp integration was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the WhatsApp Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/whatsapp/list":{"get":{"operationId":"listWhatsAppIntegrations","summary":"List WhatsApp integrations","tags":["WhatsApp Integration"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of WhatsApp integrations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BotRef"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"verifyToken":{"description":"The WhatsApp integration verify token","type":"string"},"phoneNumberId":{"description":"The WhatsApp integration phone number ID","type":"string"},"accessToken":{"description":"The WhatsApp integration access token (returned as '********' if configured, null otherwise)","type":"string"},"contactCollection":{"description":"Weather to collect contacts","type":"boolean"},"sessionDuration":{"description":"The session duration (in milliseconds)","type":"number"},"attachments":{"description":"Weather the bot supports attachments","type":"boolean"},"allowFrom":{"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.","type":"string"}},"required":["verifyToken"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1integration~1whatsapp~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/widget/{widgetIntegrationId}/clone":{"post":{"operationId":"cloneWidgetIntegration","summary":"Clone Widget integration","tags":["Widget Integration"],"parameters":[{"in":"path","name":"widgetIntegrationId","required":true,"schema":{"description":"The ID of the Widget integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Widget integration was cloned successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the cloned Widget integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/widget/{widgetIntegrationId}/delete":{"post":{"operationId":"deleteWidgetIntegration","summary":"Delete Widget integration","tags":["Widget Integration"],"parameters":[{"in":"path","name":"widgetIntegrationId","required":true,"schema":{"description":"The ID of the Widget integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Widget integration was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted Widget integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/widget/{widgetIntegrationId}/fetch":{"get":{"operationId":"fetchWidgetIntegration","summary":"Fetch a widgetIntegration","tags":["Widget Integration"],"parameters":[{"in":"path","name":"widgetIntegrationId","required":true,"schema":{"description":"The ID of the Widget integration to retrieve","type":"string"}}],"responses":{"200":{"description":"The Widget integration was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"theme":{"description":"The theme of the Widget integration","type":"string"},"layout":{"description":"The default layout of the Widget integration","type":"string"},"title":{"description":"The title of the Widget integration","type":"string"},"intro":{"description":"The intro of the Widget integration","type":"string"},"initial":{"description":"The initial message of the Widget integration","type":"string"},"placeholder":{"description":"The input placeholder of the Widget integration","type":"string"},"origin":{"description":"The origin URLs of the Widget integration","type":"string"},"sessionDuration":{"description":"The session duration of the Widget integration","type":"number"},"language":{"description":"The language of the Widget integration","type":"string"},"plugins":{"description":"The plugins of the Widget integration","type":"string"},"stream":{"description":"Whether the Widget integration is streaming","type":"boolean"},"verbose":{"description":"Whether the Widget integration is verbose","type":"boolean"},"tools":{"description":"Whether the Widget integration has tools","type":"boolean"},"unfurl":{"description":"Whether the Widget integration unfurls links","type":"boolean"},"math":{"description":"Whether the Widget integration supports math","type":"boolean"},"carousel":{"description":"Whether the Widget integration supports carousels","type":"boolean"},"form":{"description":"Whether the Widget integration supports forms","type":"boolean"},"attachments":{"description":"Whether the Widget integration supports attachments","type":"boolean"},"autoScroll":{"description":"Whether the Widget integration auto scrolls","type":"boolean"},"startFirst":{"description":"Whether the Widget integration starts first","type":"boolean"},"contactCollection":{"description":"Whether the Widget integration collects contacts","type":"boolean"},"exportConversation":{"description":"Controls whether the Widget allows exporting the current conversation","type":"boolean"},"restartConversation":{"description":"Controls whether the Widget allows restarting the conversation","type":"boolean"},"maximize":{"description":"Controls whether the Widget allows maximizing the conversation","type":"boolean"},"messagePeek":{"description":"Controls whether the Widget allows peeking at the initial messages","type":"boolean"},"voiceIn":{"description":"Whether the Widget integration supports voice input","type":"boolean"},"voiceOut":{"description":"Whether the Widget integration supports voice output","type":"boolean"},"poweredBy":{"description":"Whether the Widget integration displays powered by","type":"boolean"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/widget/{widgetIntegrationId}/setup":{"post":{"operationId":"setupWidgetIntegration","summary":"Setup Widget integration","tags":["Widget Integration"],"parameters":[{"in":"path","name":"widgetIntegrationId","required":true,"schema":{"description":"The ID of the Widget integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The Widget integration was setup successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Widget integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/widget/{widgetIntegrationId}/update":{"post":{"operationId":"updateWidgetIntegration","summary":"Update a Widget integration","tags":["Widget Integration"],"parameters":[{"in":"path","name":"widgetIntegrationId","required":true,"schema":{"description":"The ID of the Widget integration","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"theme":{"description":"The theme of the Widget integration","type":"string"},"layout":{"description":"The default layout of the Widget integration","type":"string"},"title":{"description":"The title of the Widget integration","type":"string"},"intro":{"description":"The intro of the Widget integration","type":"string"},"initial":{"description":"The initial message of the Widget integration","type":"string"},"placeholder":{"description":"The input placeholder of the Widget integration","type":"string"},"origin":{"description":"The origin URLs of the Widget integration","type":"string"},"sessionDuration":{"description":"The session duration of the Widget integration","type":"number"},"language":{"description":"The language of the Widget integration","type":"string"},"plugins":{"description":"The plugins of the Widget integration","type":"string"},"stream":{"description":"Whether the Widget integration is streaming","type":"boolean"},"verbose":{"description":"Whether the Widget integration is verbose","type":"boolean"},"tools":{"description":"Whether the Widget integration has tools","type":"boolean"},"unfurl":{"description":"Whether the Widget integration unfurls links","type":"boolean"},"math":{"description":"Whether the Widget integration supports math","type":"boolean"},"carousel":{"description":"Whether the Widget integration supports carousels","type":"boolean"},"form":{"description":"Whether the Widget integration supports forms","type":"boolean"},"attachments":{"description":"Whether the Widget integration supports attachments","type":"boolean"},"autoScroll":{"description":"Whether the Widget integration auto scrolls","type":"boolean"},"startFirst":{"description":"Whether the Widget integration starts first","type":"boolean"},"contactCollection":{"description":"Whether the Widget integration collects contacts","type":"boolean"},"exportConversation":{"description":"Controls whether the Widget allows exporting the current conversation","type":"boolean"},"restartConversation":{"description":"Controls whether the Widget allows restarting the conversation","type":"boolean"},"maximize":{"description":"Controls whether the Widget allows maximizing the conversation","type":"boolean"},"messagePeek":{"description":"Controls whether the Widget allows peeking at the initial messages","type":"boolean"},"voiceIn":{"description":"Controls whether the Widget allows voice input","type":"boolean"},"voiceOut":{"description":"Controls whether the Widget allows voice output","type":"boolean"},"poweredBy":{"description":"Whether the Widget integration displays powered by","type":"boolean"}}}]}}}},"responses":{"200":{"description":"The Widget integration was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Widget Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/widget/create":{"post":{"operationId":"createWidgetIntegration","summary":"Create Widget integration","tags":["Widget Integration"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"theme":{"description":"The theme of the Widget integration","type":"string"},"layout":{"description":"The default layout of the Widget integration","type":"string"},"title":{"description":"The title of the Widget integration","type":"string"},"intro":{"description":"The intro of the Widget integration","type":"string"},"initial":{"description":"The initial message of the Widget integration","type":"string"},"placeholder":{"description":"The input placeholder of the Widget integration","type":"string"},"origin":{"description":"The origin URLs of the Widget integration","type":"string"},"sessionDuration":{"description":"The session duration of the Widget integration","type":"number"},"language":{"description":"The language of the Widget integration","type":"string"},"plugins":{"description":"The plugins of the Widget integration","type":"string"},"stream":{"description":"Whether the Widget integration is streaming","type":"boolean"},"verbose":{"description":"Whether the Widget integration is verbose","type":"boolean"},"tools":{"description":"Whether the Widget integration has tools","type":"boolean"},"unfurl":{"description":"Whether the Widget integration unfurls links","type":"boolean"},"math":{"description":"Weather the Widget integration supports math","type":"boolean"},"carousel":{"description":"Weather the Widget integration supports carousels","type":"boolean"},"form":{"description":"Weather the Widget integration supports forms","type":"boolean"},"attachments":{"description":"Weather the Widget integration supports attachments","type":"boolean"},"autoScroll":{"description":"Whether the Widget integration auto scrolls","type":"boolean"},"startFirst":{"description":"Whether the Widget integration starts first","type":"boolean"},"contactCollection":{"description":"Whether the Widget integration collects contacts","type":"boolean"},"exportConversation":{"description":"Controls whether the Widget allows exporting the current conversation","type":"boolean"},"restartConversation":{"description":"Controls whether the Widget allows restarting the conversation","type":"boolean"},"maximize":{"description":"Controls whether the Widget allows maximizing the conversation","type":"boolean"},"messagePeek":{"description":"Controls whether the Widget allows peeking at the initial messages","type":"boolean"},"voiceIn":{"description":"Controls whether the Widget allows voice input","type":"boolean"},"voiceOut":{"description":"Controls whether the Widget allows voice output","type":"boolean"},"poweredBy":{"description":"Whether the Widget integration displays powered by","type":"boolean"}}}]}}}},"responses":{"200":{"description":"The Widget integration was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the Widget Integration","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/integration/widget/list":{"get":{"operationId":"listWidgetIntegrations","summary":"List Widget integrations","tags":["Widget Integration"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of Widget integrations was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"$ref":"#/components/schemas/BotRef"},{"type":"object","properties":{"theme":{"description":"The theme of the Widget integration","type":"string"},"layout":{"description":"The default layout of the Widget integration","type":"string"},"title":{"description":"The title of the Widget integration","type":"string"},"intro":{"description":"The intro of the Widget integration","type":"string"},"initial":{"description":"The initial message of the Widget integration","type":"string"},"placeholder":{"description":"The input placeholder of the Widget integration","type":"string"},"origin":{"description":"The origin URLs of the Widget integration","type":"string"},"sessionDuration":{"description":"The session duration of the Widget integration","type":"number"},"language":{"description":"The language of the Widget integration","type":"string"},"plugins":{"description":"The plugins of the Widget integration","type":"string"},"stream":{"description":"Whether the Widget integration is streaming","type":"boolean"},"verbose":{"description":"Whether the Widget integration is verbose","type":"boolean"},"tools":{"description":"Whether the Widget integration has tools","type":"boolean"},"unfurl":{"description":"Whether the Widget integration unfurls links","type":"boolean"},"math":{"description":"Weather the Widget integration supports math","type":"boolean"},"carousel":{"description":"Weather the Widget integration supports carousels","type":"boolean"},"form":{"description":"Weather the Widget integration supports forms","type":"boolean"},"attachments":{"description":"Weather the Widget integration supports attachments","type":"boolean"},"autoScroll":{"description":"Whether the Widget integration auto scrolls","type":"boolean"},"startFirst":{"description":"Whether the Widget integration starts first","type":"boolean"},"contactCollection":{"description":"Whether the Widget integration collects contacts","type":"boolean"},"exportConversation":{"description":"Controls whether the Widget allows exporting the current conversation","type":"boolean"},"restartConversation":{"description":"Controls whether the Widget allows restarting the conversation","type":"boolean"},"maximize":{"description":"Controls whether the Widget allows maximizing the conversation","type":"boolean"},"messagePeek":{"description":"Controls whether the Widget allows peeking at the initial messages","type":"boolean"},"voiceIn":{"description":"Whether the Widget integration supports voice input","type":"boolean"},"voiceOut":{"description":"Whether the Widget integration supports voice output","type":"boolean"},"poweredBy":{"description":"Whether the Widget integration displays powered by","type":"boolean"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1integration~1widget~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/magic/{promptId}/generate":{"post":{"operationId":"generateMagicFromPrompt","summary":"Generate text (description, records, abilities and more) based on input.","tags":["Magic"],"parameters":[{"in":"path","name":"promptId","required":true,"schema":{"description":"The ID of the prompt to use for generation","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"description":"The text to use as input","type":"string"},"props":{"description":"Additional properties to pass to the prompt","type":"object"},"model":{"description":"Optional language model to use for generation","type":"string"}},"required":["text"]}}}},"responses":{"200":{"description":"The magic prompt completed successfully","content":{"application/json":{"schema":{"type":"object","properties":{"text":{"description":"The input text","type":"string"},"usage":{"$ref":"#/components/schemas/Usage"}},"required":["text","usage"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The generated text","type":"string","enum":["result"]},"data":{"$ref":"#/paths/~1magic~1{promptId}~1generate/post/responses/200/content/application~1json/schema"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/magic/list":{"get":{"operationId":"listMagicPrompts","summary":"Retrieve a list of magic prompts","tags":["Magic"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of magic prompts was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"alias":{"description":"The alias of the item","type":"string"}},"required":["alias"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1magic~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/memory/{memoryId}/delete":{"post":{"operationId":"deleteMemory","summary":"Delete memory","tags":["Memory"],"parameters":[{"in":"path","name":"memoryId","required":true,"schema":{"description":"The ID of the memory to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The memory was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted memory","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/memory/{memoryId}/fetch":{"get":{"operationId":"fetchMemory","summary":"Fetch memory","tags":["Memory"],"parameters":[{"in":"path","name":"memoryId","required":true,"schema":{"description":"The ID of the memory to retrieve","type":"string"}}],"responses":{"200":{"description":"The memory was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"contactId":{"type":"string","description":"The contact associated with the memory"},"botId":{"type":"string","description":"The bot associated with the memory"},"text":{"type":"string","description":"The text of the memory"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/memory/{memoryId}/update":{"post":{"operationId":"updateMemory","summary":"Update memory","tags":["Memory"],"parameters":[{"in":"path","name":"memoryId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"type":"object","properties":{"contactId":{"type":"string","description":"The contact associated with the memory"},"botId":{"type":"string","description":"The bot associated with the memory"},"text":{"type":"string","description":"The text of the memory"}}}]}}}},"responses":{"200":{"description":"The memory was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the updated memory","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/memory/create":{"post":{"operationId":"createMemory","summary":"Create a new memory","description":"Create a new memory with the given parameters.\n","tags":["Memory"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"type":"object","properties":{"contactId":{"type":"string","description":"The contact associated with the memory"},"botId":{"type":"string","description":"The bot associated with the memory"},"text":{"type":"string","description":"The text of the memory"}},"required":["text"]}]}}}},"responses":{"200":{"description":"The memory was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created memory","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/memory/export":{"get":{"operationId":"exportMemories","summary":"Export memories","tags":["Memory"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of memories was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"contactId":{"type":"string","description":"The contact associated with the memory"},"botId":{"type":"string","description":"The bot associated with the memory"},"text":{"type":"string","description":"The text of the memory"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1memory~1export/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}},"text/csv":{"schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/memory/list":{"get":{"operationId":"listMemories","summary":"List memories","tags":["Memory"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of memories was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"contactId":{"type":"string","description":"The contact associated with the memory"},"botId":{"type":"string","description":"The bot associated with the memory"},"text":{"type":"string","description":"The text of the memory"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1memory~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/memory/search":{"post":{"operationId":"searchMemory","summary":"Search memories for records matching a given search query","tags":["Memory"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"description":"The keyword/phrase to search for","type":"string"},"contactId":{"description":"The ID of the contact to filter memories by","type":"string"},"botId":{"description":"The ID of the bot to filter memories by","type":"string"}},"required":["search"]}}}},"responses":{"200":{"description":"The search was successful","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"description":"An array of memories matching the search query","type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"meta":{"type":"object"}},"required":["id","text"]}}},"required":["items"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/partner/user/{userId}/delete":{"post":{"operationId":"deletePartnerUser","summary":"Delete a partner user","tags":["Partner"],"parameters":[{"in":"path","name":"userId","required":true,"schema":{"description":"The ID of the user to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The user was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted user","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/partner/user/{userId}/fetch":{"get":{"operationId":"fetchPartnerUser","summary":"Fetch a partner user","tags":["Partner"],"parameters":[{"in":"path","name":"userId","required":true,"schema":{"description":"The ID of the partner user to retrieve","type":"string"}}],"responses":{"200":{"description":"The partner user was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"image":{"description":"The image of the partner user","type":"string"},"email":{"description":"The email of the partner user","type":"string"},"limits":{"$ref":"#/components/schemas/Limits"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/partner/user/{userId}/token/{tokenId}/delete":{"post":{"operationId":"deletePartnerUserToken","summary":"Delete a partner user token","tags":["Partner"],"parameters":[{"in":"path","name":"userId","required":true,"schema":{"description":"The ID of the user","type":"string"}},{"in":"path","name":"tokenId","required":true,"schema":{"description":"The ID of the user token to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The user token was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted user token","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/partner/user/{userId}/token/create":{"post":{"operationId":"createPartnerUserToken","summary":"Create partner user token","tags":["Partner"],"parameters":[{"in":"path","name":"userId","required":true,"schema":{"description":"The ID of the user","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The user token was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created user token","type":"string"},"token":{"description":"The token of the created user token","type":"string"},"createdAt":{"description":"The timestamp for when the user token was created (in milliseconds)","type":"number"}},"required":["id","token","createdAt"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/partner/user/{userId}/token/list":{"get":{"operationId":"listPartnerUserTokens","summary":"List partner user tokens","tags":["Partner"],"parameters":[{"in":"path","name":"userId","required":true,"schema":{"description":"The ID of the user","type":"string"}},{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}}],"responses":{"200":{"description":"The list of user tokens was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1partner~1user~1{userId}~1token~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/partner/user/{userId}/update":{"post":{"operationId":"updatePartnerUser","summary":"Update a partner user","tags":["Partner"],"parameters":[{"in":"path","name":"userId","required":true,"schema":{"description":"The ID of the partner user","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"type":"object","properties":{"image":{"description":"The image of the partner user","type":"string"},"email":{"description":"The email of the partner user","type":"string"},"limits":{"$ref":"#/components/schemas/Limits"}}}]}}}},"responses":{"200":{"description":"The message was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the updated partner user","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/partner/user/create":{"post":{"operationId":"createPartnerUser","summary":"Create partner user","tags":["Partner"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"type":"object","properties":{"image":{"description":"The image of the partner user","type":"string"},"email":{"description":"The email of the partner user","type":"string"},"limits":{"$ref":"#/components/schemas/Limits"}}}]}}}},"responses":{"200":{"description":"The user was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created user","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/partner/user/list":{"get":{"operationId":"listPartnerUsers","summary":"List partner users","tags":["Partner"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of users was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"image":{"description":"The image of the partner user","type":"string"},"email":{"description":"The email of the partner user","type":"string"},"limits":{"$ref":"#/components/schemas/Limits"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1partner~1user~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/ability/list":{"get":{"operationId":"listPlatformAbilities","summary":"Retrieve a list of platform abilities","tags":["Platform"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of abilities was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"template":{"type":"string","description":"The original template identifier for the ability"},"instruction":{"type":"string"},"schema":{"allOf":[{"$ref":"#/components/schemas/JsonSchemaObject"}]},"bot":{"type":"string","description":"The ID of the bot associated with the ability"},"file":{"type":"string","description":"The ID of the file associated with the ability"},"secret":{"type":"string","description":"The ID of the secret associated with the ability"},"space":{"type":"string","description":"The ID of the space associated with the ability"},"provider":{"type":"string","description":"The provider of the ability"},"icon":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"setup":{"type":"string"},"commentary":{"type":"string"}},"required":["instruction","schema","icon"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1platform~1ability~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/ability/search":{"post":{"operationId":"searchPlatformAbilities","summary":"Search platform abilities using semantic similarity","tags":["Platform"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"description":"The search query to find relevant abilities","type":"string"},"take":{"description":"The maximum number of results to return (1-100, default 10)","type":"integer","minimum":1,"maximum":100,"default":10}},"required":["search"]}}}},"responses":{"200":{"description":"The search was successful","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"template":{"type":"string","description":"The original template identifier for the ability"},"instruction":{"type":"string"},"schema":{"allOf":[{"$ref":"#/components/schemas/JsonSchemaObject"}]},"bot":{"type":"string"},"file":{"type":"string"},"secret":{"type":"string"},"space":{"type":"string"},"provider":{"type":"string"},"icon":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"setup":{"type":"string"},"commentary":{"type":"string"},"score":{"description":"The similarity score of the search result","type":"number"},"excerpt":{"description":"An excerpt from the most relevant part of the ability","type":"string"},"link":{"description":"The URL to the official ability page","type":"string"}},"required":["name","description","instruction","schema","icon","score","excerpt"]}]}}},"required":["items"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/action/list":{"get":{"operationId":"listPlatformActions","summary":"Retrieve a list of platform actions","tags":["Platform"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of actions was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"description":{"description":"The description of the action","type":"string"},"examples":{"description":"Example demonstrating the action usage","type":"array","items":{"type":"string"}}},"required":["description","examples"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1platform~1action~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/doc/{docId}/fetch":{"get":{"operationId":"fetchPlatformDoc","summary":"Fetch a specific platform doc","description":"Retrieves the complete content and metadata of a specific doc. This\nincludes the markdown content and all associated frontmatter.\n","tags":["Platform"],"parameters":[{"in":"path","name":"docId","required":true,"schema":{"description":"The ID of the doc to fetch (e.g., \"datasets\", \"skillsets\")","type":"string"}}],"responses":{"200":{"description":"The doc was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"category":{"description":"The category of the manual","type":"string"},"tags":{"description":"Tags associated with the doc","type":"array","items":{"type":"string"}},"index":{"description":"The display order index","type":"number"},"content":{"description":"The markdown content of the doc","type":"string"},"link":{"description":"The URL to the official documentation page","type":"string"}},"required":["id","name","content"]}]}}}},"404":{"description":"Doc not found"},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/doc/list":{"get":{"operationId":"listPlatformDocs","summary":"Retrieve a list of platform docs","description":"Returns a list of available documentation docs with their metadata.\n","tags":["Platform"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of docs was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"category":{"description":"The category of the doc","type":"string"},"tags":{"description":"Tags associated with the doc","type":"array","items":{"type":"string"}},"index":{"description":"The display order index","type":"number"},"link":{"description":"The URL to the official documentation page","type":"string"}},"required":["name","description","tags","index","link"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1platform~1doc~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/doc/search":{"post":{"operationId":"searchPlatformDocs","summary":"Search platform docs using semantic similarity","tags":["Platform"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"description":"The search query to find relevant docs","type":"string"},"take":{"description":"The maximum number of results to return (1-100, default 10)","type":"integer","minimum":1,"maximum":100,"default":10}},"required":["search"]}}}},"responses":{"200":{"description":"The search was successful","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"category":{"description":"The category of the doc","type":"string"},"tags":{"description":"Tags associated with the doc","type":"array","items":{"type":"string"}},"index":{"description":"The display order index","type":"number"},"score":{"description":"The similarity score of the search result","type":"number"},"excerpt":{"description":"An excerpt from the most relevant part of the doc","type":"string"},"link":{"description":"The URL to the official documentation page","type":"string"}},"required":["name","description","tags","index","score","excerpt","link"]}]}}},"required":["items"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/example/{exampleId}/clone":{"post":{"operationId":"clonePlatformExample","summary":"Clone a platform example","tags":["Platform"],"parameters":[{"in":"path","name":"exampleId","required":true,"schema":{"description":"The ID (slug) of the example to clone","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The example was cloned successfully","content":{"application/json":{"schema":{"type":"object","properties":{"resources":{"description":"A map of resource types to arrays of created resources","type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The unique identifier of the resource","type":"string"},"name":{"description":"The name of the resource","type":"string"},"description":{"description":"The description of the resource","type":"string"}},"required":["id"]}}}},"required":["resources"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/example/{exampleId}/fetch":{"get":{"operationId":"fetchPlatformExample","summary":"Fetch a specific platform example with full details","tags":["Platform"],"parameters":[{"in":"path","name":"exampleId","required":true,"schema":{"description":"The ID (slug) of the example","type":"string"}}],"responses":{"200":{"description":"The example was fetched successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID (slug) of the example","type":"string"},"name":{"description":"The name of the example","type":"string"},"description":{"description":"The description of the example","type":"string"},"type":{"description":"The type of the example","type":"string","enum":["blueprint","project","widget","slack","discord","whatsapp","messenger","telegram","twilio","email","trigger"]},"config":{"description":"The full configuration details of the example","type":"object","properties":{},"additionalProperties":true},"link":{"description":"The URL to the official example page","type":"string"},"tags":{"description":"Tags associated with the example","type":"array","items":{"type":"string"}},"createdAt":{"description":"The creation timestamp","type":"number"},"updatedAt":{"description":"The last update timestamp","type":"number"}},"required":["id","name","description","type","config","link"]}}}},"404":{"description":"The example was not found"},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/example/list":{"get":{"operationId":"listPlatformExamples","summary":"Retrieve a list of platform examples","tags":["Platform"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of examples was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"type":{"description":"The type of the example","type":"string","enum":["blueprint","project","widget","slack","discord","whatsapp","messenger","telegram","twilio","email","trigger"]},"tags":{"description":"Tags associated with the example","type":"array","items":{"type":"string"}},"link":{"description":"The URL to the official example page","type":"string"}},"required":["name","description","type","link"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1platform~1example~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/example/search":{"post":{"operationId":"searchPlatformExamples","summary":"Search platform examples using semantic similarity","tags":["Platform"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"description":"The search query to find relevant examples","type":"string"},"take":{"description":"The maximum number of results to return (1-100, default 10)","type":"integer","minimum":1,"maximum":100,"default":10}},"required":["search"]}}}},"responses":{"200":{"description":"The search was successful","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"type":{"description":"The type of the example","type":"string","enum":["blueprint","project","widget","slack","discord","whatsapp","messenger","telegram","twilio","email","trigger"]},"tags":{"description":"Tags associated with the example","type":"array","items":{"type":"string"}},"link":{"description":"The URL to the official example page","type":"string"}},"required":["name","description","type","link"]}]}}},"required":["items"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/guide/{guideId}/fetch":{"get":{"operationId":"fetchPlatformGuide","summary":"Fetch a specific platform guide","description":"Retrieves the complete content and metadata of a specific guide. This\nincludes the markdown content and all associated frontmatter.\n","tags":["Platform"],"parameters":[{"in":"path","name":"guideId","required":true,"schema":{"description":"The ID of the guide to fetch","type":"string"}}],"responses":{"200":{"description":"The guide was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"category":{"description":"The category of the guide","type":"string"},"tags":{"description":"Tags associated with the guide","type":"array","items":{"type":"string"}},"index":{"description":"The display order index","type":"number"},"content":{"description":"The markdown content of the guide","type":"string"},"link":{"description":"The URL to the official guide page","type":"string"}},"required":["id","name","content"]}]}}}},"404":{"description":"Guide not found"},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/guide/list":{"get":{"operationId":"listPlatformGuides","summary":"Retrieve a list of platform guides","description":"Returns a list of available guides with their metadata.\n","tags":["Platform"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of guides was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"category":{"description":"The category of the guide","type":"string"},"tags":{"description":"Tags associated with the guide","type":"array","items":{"type":"string"}},"index":{"description":"The display order index","type":"number"},"link":{"description":"The URL to the official guide page","type":"string"}},"required":["name","description","tags","index","link"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1platform~1guide~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/guide/search":{"post":{"operationId":"searchPlatformGuides","summary":"Search platform guides using semantic similarity","tags":["Platform"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"description":"The search query to find relevant guides","type":"string"},"take":{"description":"The maximum number of results to return (1-100, default 10)","type":"integer","minimum":1,"maximum":100,"default":10}},"required":["search"]}}}},"responses":{"200":{"description":"The search was successful","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"category":{"description":"The category of the guide","type":"string"},"tags":{"description":"Tags associated with the guide","type":"array","items":{"type":"string"}},"index":{"description":"The display order index","type":"number"},"score":{"description":"The similarity score of the search result","type":"number"},"excerpt":{"description":"An excerpt from the most relevant part of the guide","type":"string"},"link":{"description":"The URL to the official guide page","type":"string"}},"required":["name","description","tags","index","score","excerpt","link"]}]}}},"required":["items"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/manual/{manualId}/fetch":{"get":{"operationId":"fetchPlatformManual","summary":"Fetch a specific platform manual","description":"Retrieves the complete content and metadata of a specific manual. This\nincludes the markdown content and all associated frontmatter.\n","tags":["Platform"],"parameters":[{"in":"path","name":"manualId","required":true,"schema":{"description":"The ID of the manual to fetch (e.g., \"datasets\", \"skillsets\")","type":"string"}}],"responses":{"200":{"description":"The manual was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"category":{"description":"The category of the manual","type":"string"},"tags":{"description":"Tags associated with the manual","type":"array","items":{"type":"string"}},"index":{"description":"The display order index","type":"number"},"content":{"description":"The markdown content of the manual","type":"string"},"link":{"description":"The URL to the official documentation page","type":"string"}},"required":["id","name","content"]}]}}}},"404":{"description":"Manual not found"},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/manual/list":{"get":{"operationId":"listPlatformManuals","summary":"Retrieve a list of platform manuals","description":"Returns a list of available documentation manuals with their metadata.\n","tags":["Platform"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of manuals was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"category":{"description":"The category of the manual","type":"string"},"tags":{"description":"Tags associated with the manual","type":"array","items":{"type":"string"}},"index":{"description":"The display order index","type":"number"},"link":{"description":"The URL to the official documentation page","type":"string"}},"required":["name","description","tags","index","link"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1platform~1manual~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/manual/search":{"post":{"operationId":"searchPlatformManuals","summary":"Search platform manuals using semantic similarity","tags":["Platform"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"description":"The search query to find relevant manuals","type":"string"},"take":{"description":"The maximum number of results to return (1-100, default 10)","type":"integer","minimum":1,"maximum":100,"default":10}},"required":["search"]}}}},"responses":{"200":{"description":"The search was successful","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"category":{"description":"The category of the manual","type":"string"},"tags":{"description":"Tags associated with the manual","type":"array","items":{"type":"string"}},"index":{"description":"The display order index","type":"number"},"score":{"description":"The similarity score of the search result","type":"number"},"excerpt":{"description":"An excerpt from the most relevant part of the manual","type":"string"},"link":{"description":"The URL to the official documentation page","type":"string"}},"required":["name","description","tags","index","score","excerpt","link"]}]}}},"required":["items"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/model/list":{"get":{"operationId":"listPlatformModels","summary":"Retrieve a list of platform models","tags":["Platform"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of models was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"provider":{"description":"The backstory of the model","type":"string"},"family":{"description":"The model of the model","type":"string"},"maxTokens":{"description":"The maximum number of tokens the model can use","type":"number"},"maxInputTokens":{"description":"The maximum number of tokens the model can accept","type":"number"},"maxOutputTokens":{"description":"The maximum number of tokens the model can generate","type":"number"}},"required":["provider","family","maxTokens","maxInputTokens","maxOutputTokens"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1platform~1model~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/secret/list":{"get":{"operationId":"listPlatformSecrets","summary":"Retrieve a list of platform secrets","tags":["Platform"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of secrets was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"template":{"type":"string","description":"The original template identifier for the secret"},"type":{"$ref":"#/components/schemas/SecretType"},"kind":{"$ref":"#/components/schemas/SecretKind"},"config":{"type":"object","additionalProperties":true},"icon":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"setup":{"type":"string"},"commentary":{"type":"string"}},"required":["type"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1platform~1secret~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/secret/search":{"post":{"operationId":"searchPlatformSecrets","summary":"Search platform secrets using semantic similarity","tags":["Platform"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"description":"The search query to find relevant secrets","type":"string"},"take":{"description":"The maximum number of results to return (1-100, default 10)","type":"integer","minimum":1,"maximum":100,"default":10}},"required":["search"]}}}},"responses":{"200":{"description":"The search was successful","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"template":{"type":"string","description":"The original template identifier for the secret"},"type":{"$ref":"#/components/schemas/SecretType"},"kind":{"$ref":"#/components/schemas/SecretKind"},"config":{"type":"object","additionalProperties":true},"icon":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"setup":{"type":"string"},"commentary":{"type":"string"},"score":{"description":"The similarity score of the search result","type":"number"},"excerpt":{"description":"An excerpt from the most relevant part of the secret","type":"string"},"link":{"description":"The URL to the official secret page","type":"string"}},"required":["type","score","excerpt"]}]}}},"required":["items"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/tutorial/{tutorialId}/fetch":{"get":{"operationId":"fetchPlatformTutorial","summary":"Fetch a specific platform tutorial","description":"Retrieves the complete content and metadata of a specific tutorial. This\nincludes the markdown content and all associated frontmatter.\n","tags":["Platform"],"parameters":[{"in":"path","name":"tutorialId","required":true,"schema":{"description":"The ID of the tutorial to fetch (e.g., \"how-to-get-started-with-chatbotkit\")","type":"string"}}],"responses":{"200":{"description":"The tutorial was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"category":{"description":"The category of the tutorial","type":"string"},"tags":{"description":"Tags associated with the tutorial","type":"array","items":{"type":"string"}},"index":{"description":"The display order index","type":"number"},"content":{"description":"The markdown content of the tutorial","type":"string"},"link":{"description":"The URL to the official tutorial page","type":"string"}},"required":["id","name","content"]}]}}}},"404":{"description":"Tutorial not found"},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/tutorial/list":{"get":{"operationId":"listPlatformTutorials","summary":"Retrieve a list of platform tutorials","description":"Returns a list of available tutorials with their metadata.\n","tags":["Platform"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of tutorials was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"category":{"description":"The category of the tutorial","type":"string"},"tags":{"description":"Tags associated with the tutorial","type":"array","items":{"type":"string"}},"index":{"description":"The display order index","type":"number"},"link":{"description":"The URL to the official tutorial page","type":"string"}},"required":["name","description","tags","index","link"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1platform~1tutorial~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/platform/tutorial/search":{"post":{"operationId":"searchPlatformTutorials","summary":"Search platform tutorials using semantic similarity","tags":["Platform"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"search":{"description":"The search query to find relevant tutorials","type":"string"},"take":{"description":"The maximum number of results to return (1-100, default 10)","type":"integer","minimum":1,"maximum":100,"default":10}},"required":["search"]}}}},"responses":{"200":{"description":"The search was successful","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"category":{"description":"The category of the tutorial","type":"string"},"tags":{"description":"Tags associated with the tutorial","type":"array","items":{"type":"string"}},"index":{"description":"The display order index","type":"number"},"score":{"description":"The similarity score of the search result","type":"number"},"excerpt":{"description":"An excerpt from the most relevant part of the tutorial","type":"string"},"link":{"description":"The URL to the official tutorial page","type":"string"}},"required":["name","description","tags","index","score","excerpt","link"]}]}}},"required":["items"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/policy/{policyId}/delete":{"post":{"operationId":"deletePolicy","summary":"Delete policy","tags":["Policy"],"parameters":[{"in":"path","name":"policyId","required":true,"schema":{"description":"The ID of the policy to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The policy was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted policy","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/policy/{policyId}/fetch":{"get":{"operationId":"fetchPolicy","summary":"Fetch a policy","tags":["Policy"],"parameters":[{"in":"path","name":"policyId","required":true,"schema":{"description":"The ID of the policy to retrieve","type":"string"}}],"responses":{"200":{"description":"The policy was fetched successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PolicyType"},"config":{"description":"The policy configuration as JSON","type":"object","additionalProperties":true}},"required":["type"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/policy/{policyId}/update":{"post":{"operationId":"updatePolicy","summary":"Update policy","tags":["Policy"],"parameters":[{"in":"path","name":"policyId","required":true,"schema":{"description":"The ID of the policy to update","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PolicyType"},"config":{"description":"The policy configuration as JSON","type":"object","additionalProperties":true}}}]}}}},"responses":{"200":{"description":"The policy was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the updated policy","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/policy/create":{"post":{"operationId":"createPolicy","summary":"Create policy","tags":["Policy"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PolicyType"},"config":{"description":"The policy configuration as JSON","type":"object","additionalProperties":true}},"required":["type"]}]}}}},"responses":{"200":{"description":"The policy was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created policy","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/policy/list":{"get":{"operationId":"listPolicies","summary":"Retrieve a list of policies","tags":["Policy"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of policies was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PolicyType"},"config":{"description":"The policy configuration as JSON","type":"object","additionalProperties":true}},"required":["type"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1policy~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/portal/{portalId}/delete":{"post":{"operationId":"deletePortal","summary":"Delete a portal","tags":["Portal"],"parameters":[{"in":"path","name":"portalId","required":true,"schema":{"description":"The ID of the portal to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The portal was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted portal","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/portal/{portalId}/fetch":{"get":{"operationId":"fetchPortal","summary":"Fetch a portal","tags":["Portal"],"parameters":[{"in":"path","name":"portalId","required":true,"schema":{"description":"The ID of the portal to retrieve","type":"string"}}],"responses":{"200":{"description":"The portal was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"slug":{"description":"The slug of the portal","type":"string"},"config":{"description":"The config of the portal","type":"object","additionalProperties":true}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/portal/{portalId}/update":{"post":{"operationId":"updatePortal","summary":"Update portal","tags":["Portal"],"parameters":[{"in":"path","name":"portalId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceRefProperties"},{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"slug":{"description":"The slug for the portal","type":"string"},"config":{"description":"The config for the portal","type":"object","additionalProperties":true}}}]}}}},"responses":{"200":{"description":"The portal was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the updated portal","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/portal/create":{"post":{"operationId":"createPortal","summary":"Create portal","tags":["Portal"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceRefProperties"},{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"slug":{"description":"The slug of the portal","type":"string"},"config":{"description":"The config of the portal","type":"object","additionalProperties":true}}}]}}}},"responses":{"200":{"description":"The portal was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created portal","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/portal/list":{"get":{"operationId":"listPortals","summary":"Retrieve a list of portals","tags":["Portal"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of portals was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"slug":{"description":"The slug of the portal","type":"string"},"config":{"description":"The config of the portal","type":"object","additionalProperties":true}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1portal~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/secret/{secretId}/authenticate":{"post":{"operationId":"authenticateSecret","summary":"Authenticate secret","tags":["Secret"],"parameters":[{"in":"path","name":"secretId","required":true,"schema":{"type":"string","description":"The ID of the secret to authenticate"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The secret is about to be authenticated","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the secret to authenticate","type":"string"},"url":{"description":"The URL to authenticate the secret","type":"string"}},"required":["id","url"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/secret/{secretId}/delete":{"post":{"operationId":"deleteSecret","summary":"Delete a secret","tags":["Secret"],"parameters":[{"in":"path","name":"secretId","required":true,"schema":{"description":"The ID of the secret to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The secret was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted secret","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/secret/{secretId}/fetch":{"get":{"operationId":"fetchSecret","summary":"Fetch a secret","tags":["Secret"],"parameters":[{"in":"path","name":"secretId","required":true,"schema":{"description":"The ID of the secret to retrieve","type":"string"}}],"responses":{"200":{"description":"The secret was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/SecretKind"},"type":{"$ref":"#/components/schemas/SecretType"},"config":{"description":"The config of the secret","type":"object","additionalProperties":true},"visibility":{"$ref":"#/components/schemas/SecretVisibility"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/secret/{secretId}/revoke":{"post":{"operationId":"revokeSecret","summary":"Revoke secret","tags":["Secret"],"parameters":[{"in":"path","name":"secretId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The secret was revoked successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the revoked secret","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/secret/{secretId}/update":{"post":{"operationId":"updateSecret","summary":"Update secret","tags":["Secret"],"parameters":[{"in":"path","name":"secretId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceRefProperties"},{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/SecretKind"},"type":{"$ref":"#/components/schemas/SecretType"},"value":{"description":"The value of the secret","type":"string"},"config":{"description":"The config of the secret","type":"object","additionalProperties":true},"visibility":{"$ref":"#/components/schemas/SecretVisibility"}}}]}}}},"responses":{"200":{"description":"The secret was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the updated secret","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/secret/{secretId}/verify":{"post":{"operationId":"verifySecret","summary":"Verify secret","tags":["Secret"],"parameters":[{"in":"path","name":"secretId","required":true,"schema":{"type":"string","description":"The ID of the secret to be verified"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The secret was verified successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the verified secret","type":"string"},"status":{"description":"The status of the secret","type":"string","enum":["unauthenticated","authenticated"]},"action":{"oneOf":[{"description":"The action to take next","type":"object","properties":{"type":{"description":"The type of action to take","type":"string","enum":["authenticate"]},"url":{"description":"The URL to authenticate the secret","type":"string"}},"required":["type","url"]}]}},"required":["id","status"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/secret/create":{"post":{"operationId":"createSecret","summary":"Create secret","tags":["Secret"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceRefProperties"},{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/SecretKind"},"type":{"$ref":"#/components/schemas/SecretType"},"value":{"description":"The value of the secret","type":"string"},"config":{"description":"The config of the secret","type":"object","additionalProperties":true},"visibility":{"$ref":"#/components/schemas/SecretVisibility"}}}]}}}},"responses":{"200":{"description":"The secret was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created secret","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/secret/list":{"get":{"operationId":"listSecrets","summary":"Retrieve a list of secrets","tags":["Secret"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of secrets was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/SecretKind"},"type":{"$ref":"#/components/schemas/SecretType"},"config":{"description":"The config of the secret","type":"object","additionalProperties":true},"visibility":{"$ref":"#/components/schemas/SecretVisibility"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1secret~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/skillset/{skillsetId}/ability/{abilityId}/delete":{"post":{"operationId":"deleteSkillsetAbility","summary":"Delete a ability from a skillset","tags":["Skillset Ability"],"parameters":[{"in":"path","name":"skillsetId","required":true,"schema":{"description":"The ID of the skillset","type":"string"}},{"in":"path","name":"abilityId","required":true,"schema":{"description":"The ID of the ability to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The ability was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted ability","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/skillset/{skillsetId}/ability/{abilityId}/execute":{"post":{"operationId":"executeSkillsetAbility","summary":"Execute a skillset ability","description":"Executes a specific ability from a skillset with the provided input.\nThis endpoint processes the ability's instruction template using the\ngiven input and returns the execution result along with usage statistics.\nThe response is streamed as JSON lines (JSONL) to support real-time\nprogress updates during execution.\n","tags":["Skillset Ability"],"parameters":[{"in":"path","name":"skillsetId","required":true,"schema":{"description":"The ID of the skillset containing the ability","type":"string"}},{"in":"path","name":"abilityId","required":true,"schema":{"description":"The ID of the ability to execute","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"input":{"description":"The input to process with the ability. This can be structured\ntext such as JSON or YAML for precise parameter control, or\nunstructured natural language text. When unstructured text is\nprovided, the system will automatically detect and extract the\nrelevant parameters from the input.\n","type":"string"},"contactId":{"description":"The ID of the contact to associate with the execution","type":"string"}}}}}},"responses":{"200":{"description":"The ability was executed successfully","content":{"application/json":{"schema":{"type":"object","properties":{"usage":{"$ref":"#/components/schemas/Usage"},"error":{"description":"Error message if execution failed","type":"string"},"result":{"description":"The result of the ability execution"},"messages":{"description":"Messages generated during execution","type":"array","items":{"$ref":"#/components/schemas/Message"}}},"required":["usage"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["result"]},"data":{"$ref":"#/paths/~1skillset~1{skillsetId}~1ability~1{abilityId}~1execute/post/responses/200/content/application~1json/schema"}},"required":["type","data"]},{"$ref":"#/components/schemas/CompleteStreamingResponseItem"}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/skillset/{skillsetId}/ability/{abilityId}/fetch":{"get":{"operationId":"fetchSkillsetAbility","summary":"Fetch a ability from a skillset","tags":["Skillset Ability"],"parameters":[{"in":"path","name":"skillsetId","required":true,"schema":{"description":"The ID of the skillset","type":"string"}},{"in":"path","name":"abilityId","required":true,"schema":{"description":"The ID of the ability to retrieve","type":"string"}}],"responses":{"200":{"description":"The skillset was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"secretId":{"description":"The ID of the secret associated with the ability","type":"string"},"fileId":{"description":"The ID of the file associated with the ability","type":"string"},"botId":{"description":"The ID of the bot associated with the ability","type":"string"},"spaceId":{"description":"The ID of the space associated with the ability","type":"string"},"instruction":{"description":"The instruction of the skillset ability","type":"string"}},"required":["name","description","instruction"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/skillset/{skillsetId}/ability/{abilityId}/update":{"post":{"operationId":"updateSkillsetAbility","summary":"Update a skillset ability","tags":["Skillset Ability"],"parameters":[{"in":"path","name":"skillsetId","required":true,"schema":{"type":"string"}},{"in":"path","name":"abilityId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"secretId":{"description":"The ID of the secret associated with the ability","type":"string"},"fileId":{"description":"The ID of the file associated with the ability","type":"string"},"botId":{"description":"The ID of the bot associated with the ability","type":"string"},"spaceId":{"description":"The ID of the space associated with the ability","type":"string"},"instruction":{"description":"The text to update the ability with","type":"string"}}}]}}}},"responses":{"200":{"description":"The ability was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the updated ability","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/skillset/{skillsetId}/ability/create":{"post":{"operationId":"createSkillsetAbility","summary":"Create ability","tags":["Skillset Ability"],"parameters":[{"in":"path","name":"skillsetId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"secretId":{"description":"The ID of the secret associated with the ability","type":"string"},"fileId":{"description":"The ID of the file associated with the ability","type":"string"},"botId":{"description":"The ID of the bot associated with the ability","type":"string"},"spaceId":{"description":"The ID of the space associated with the ability","type":"string"},"instruction":{"description":"The instruction of the ability","type":"string"}}}]}}}},"responses":{"200":{"description":"The ability was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created ability","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/skillset/{skillsetId}/ability/export":{"get":{"operationId":"exportSkillsetAbilities","summary":"Export skillset abilities","tags":["Skillset Ability"],"parameters":[{"in":"path","name":"skillsetId","required":true,"schema":{"description":"The ID of the skillset to export","type":"string"}},{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}}],"responses":{"200":{"description":"The export of skillset abilities was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"secretId":{"description":"The ID of the secret associated with the ability","type":"string"},"fileId":{"description":"The ID of the file associated with the ability","type":"string"},"botId":{"description":"The ID of the bot associated with the ability","type":"string"},"spaceId":{"description":"The ID of the space associated with the ability","type":"string"},"instruction":{"type":"string"}},"required":["name","description","instruction"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1skillset~1{skillsetId}~1ability~1export/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}},"text/csv":{"schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/skillset/{skillsetId}/ability/list":{"get":{"operationId":"listSkillsetAbilities","summary":"Retrieve a list of skillset abilities","tags":["Skillset Ability"],"parameters":[{"in":"path","name":"skillsetId","required":true,"schema":{"type":"string","description":"The ID of the skillset"}},{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}}],"responses":{"200":{"description":"The list of abilities was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"secretId":{"description":"The ID of the secret associated with the ability","type":"string"},"fileId":{"description":"The ID of the file associated with the ability","type":"string"},"botId":{"description":"The ID of the bot associated with the ability","type":"string"},"spaceId":{"description":"The ID of the space associated with the ability","type":"string"},"instruction":{"type":"string"}},"required":["name","description","instruction"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1skillset~1{skillsetId}~1ability~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/skillset/{skillsetId}/delete":{"post":{"operationId":"deleteSkillset","summary":"Delete a skillset","tags":["Skillset"],"parameters":[{"in":"path","name":"skillsetId","required":true,"schema":{"description":"The ID of the skillset to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The skillset was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted skillset","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/skillset/{skillsetId}/fetch":{"get":{"operationId":"fetchSkillset","summary":"Fetch a skillset","tags":["Skillset"],"parameters":[{"in":"path","name":"skillsetId","required":true,"schema":{"description":"The ID of the skillset to retrieve","type":"string"}}],"responses":{"200":{"description":"The skillset was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"visibility":{"$ref":"#/components/schemas/SkillsetVisibility"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/skillset/{skillsetId}/update":{"post":{"operationId":"updateSkillset","summary":"Update skillset","tags":["Skillset"],"parameters":[{"in":"path","name":"skillsetId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceRefProperties"},{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"visibility":{"$ref":"#/components/schemas/SkillsetVisibility"}}}]}}}},"responses":{"200":{"description":"The skillset was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the updated skillset","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/skillset/create":{"post":{"operationId":"createSkillset","summary":"Create skillset","tags":["Skillset"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceRefProperties"},{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"visibility":{"$ref":"#/components/schemas/SkillsetVisibility"}}}]}}}},"responses":{"200":{"description":"The skillset was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created skillset","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/skillset/list":{"get":{"operationId":"listSkillsets","summary":"Retrieve a list of skillsets","tags":["Skillset"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of skillsets was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"visibility":{"$ref":"#/components/schemas/SkillsetVisibility"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1skillset~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/space/{spaceId}/delete":{"post":{"operationId":"deleteSpace","summary":"Delete a space","tags":["Space"],"parameters":[{"in":"path","name":"spaceId","required":true,"schema":{"description":"The ID of the space to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The space was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted space","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/space/{spaceId}/fetch":{"get":{"operationId":"fetchSpace","summary":"Fetch a space","tags":["Space"],"parameters":[{"in":"path","name":"spaceId","required":true,"schema":{"description":"The ID of the space to retrieve","type":"string"}}],"responses":{"200":{"description":"The space was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"contactId":{"description":"The contact associated with the space","type":"string"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/space/{spaceId}/storage/copy/{path}":{"post":{"operationId":"copySpaceStoragePath","summary":"Copy a file in space storage","description":"Copy a file from one location to another within space storage. The\nsource file path is specified in the URL after /copy/. The\ndestinationPath in the request body specifies where to copy the file.\n","tags":["Space Storage"],"parameters":[{"in":"path","name":"spaceId","required":true,"schema":{"description":"The ID of the space","type":"string"}},{"in":"path","name":"path","required":true,"schema":{"description":"The source file path","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destinationPath":{"description":"The destination file path","type":"string"}},"required":["destinationPath"]}}}},"responses":{"200":{"description":"The file was copied successfully","content":{"application/json":{"schema":{"type":"object","properties":{"path":{"description":"The destination file path","type":"string"}},"required":["path"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/space/{spaceId}/storage/delete/{path}":{"post":{"operationId":"deleteSpaceStoragePath","summary":"Delete a file or directory from space storage","description":"Delete a file or directory from space storage. The path is specified\nin the URL after /delete/. If recursive is true and the path is a\ndirectory, all files within it will be deleted.\n","tags":["Space Storage"],"parameters":[{"in":"path","name":"spaceId","required":true,"schema":{"description":"The ID of the space","type":"string"}},{"in":"path","name":"path","required":true,"schema":{"description":"The file or directory path","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"recursive":{"description":"Whether to delete directory contents recursively","type":"boolean","default":false}}}}}},"responses":{"200":{"description":"The file or directory was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"path":{"description":"The deleted file or directory path","type":"string"}},"required":["path"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/space/{spaceId}/storage/download/{path}":{"get":{"operationId":"downloadSpaceStoragePath","summary":"Download a file from space storage","description":"Download a file from space storage. The file path is specified in the\nURL after /download/. Can return either the direct file content\n(default) or a presigned download URL (when Accept: application/json).\n","tags":["Space Storage"],"parameters":[{"in":"path","name":"spaceId","required":true,"schema":{"description":"The ID of the space","type":"string"}},{"in":"path","name":"path","required":true,"schema":{"description":"The file path","type":"string"}}],"responses":{"200":{"description":"The file was downloaded successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the file","type":"string"},"url":{"description":"The presigned URL to download the file","type":"string"}},"required":["id","url"]}},"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/space/{spaceId}/storage/list/{path}":{"get":{"operationId":"listSpaceStoragePath","summary":"List files and directories in space storage","description":"List files and directories in the space's storage. Supports both flat\nand recursive listing. The path is specified in the URL after /list/.\nOmit the path to list the root directory.\n","tags":["Space Storage"],"parameters":[{"in":"path","name":"spaceId","required":true,"schema":{"description":"The ID of the space","type":"string"}},{"in":"path","name":"path","required":false,"schema":{"description":"The directory path (defaults to root)","type":"string"}},{"in":"query","name":"recursive","schema":{"description":"Whether to list files recursively","type":"boolean","default":false}}],"responses":{"200":{"description":"The list of files was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"description":"The ID of the file or directory","type":"string"},"path":{"description":"The relative path of the file or directory","type":"string"},"size":{"description":"The size of the file in bytes (0 for directories)","type":"number"},"updatedAt":{"description":"The timestamp (ms) when the file was last modified","type":"number"},"isDirectory":{"description":"Whether this is a directory","type":"boolean"}}}},"nextToken":{"description":"Token to use for next page of results","type":"string"}},"required":["items"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/space/{spaceId}/storage/move/{path}":{"post":{"operationId":"moveSpaceStoragePath","summary":"Move (rename) a file in space storage","description":"Move a file from one location to another within space storage, or\nrename a file by moving it to a new path. The source file path is\nspecified in the URL after /move/. The destinationPath in the request\nbody is the target location for the file.\n","tags":["Space Storage"],"parameters":[{"in":"path","name":"spaceId","required":true,"schema":{"description":"The ID of the space","type":"string"}},{"in":"path","name":"path","required":true,"schema":{"description":"The source file path","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destinationPath":{"description":"The destination file path","type":"string"}},"required":["destinationPath"]}}}},"responses":{"200":{"description":"The file was moved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"path":{"description":"The destination file path","type":"string"}},"required":["path"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/space/{spaceId}/storage/upload/{path}":{"post":{"operationId":"uploadSpaceStoragePath","summary":"Upload a file to space storage","description":"Upload a file to space storage. The file path is specified in the URL\nafter /upload/. The file can be specified either as a HTTP URL, a data\nURL, a multipart/form-data, or as a raw file stream. The maximum file\nsize for uploads is determined dynamically based on user limits and\nconfiguration, and may vary.\n","tags":["Space Storage"],"parameters":[{"in":"path","name":"spaceId","required":true,"schema":{"type":"string"}},{"in":"path","name":"path","required":true,"schema":{"description":"The file path","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"file":{"description":"The file to upload either as http: or data: URL","type":"string"}}},{"type":"object","properties":{"file":{"description":"The file definition to upload","type":"object","properties":{"type":{"description":"The file type","type":"string"},"size":{"description":"The file size","type":"number"},"meta":{"description":"Optional metadata","type":"object"}},"required":["type","size"]}}}],"required":["file"]}},"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"description":"The file to upload","type":"string","format":"binary"}},"required":["file"]}},"*/*":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"The file was uploaded successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the uploaded file","type":"string"},"path":{"type":"string","description":"The path where the file is stored"},"uploadRequest":{"description":"The request required to upload the file","type":"object","properties":{"method":{"description":"The HTTP method to use","type":"string"},"url":{"description":"The HTTP url to use","type":"string"},"headers":{"description":"The HTTP headers to use","type":"object"}},"required":["method","url","headers"]}},"required":["id","path"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/space/{spaceId}/update":{"post":{"operationId":"updateSpace","summary":"Update space","tags":["Space"],"parameters":[{"in":"path","name":"spaceId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceRefProperties"},{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"contactId":{"type":"string","description":"The contact associated with the space"}}}]}}}},"responses":{"200":{"description":"The space was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the updated space","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/space/create":{"post":{"operationId":"createSpace","summary":"Create space","tags":["Space"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceRefProperties"},{"$ref":"#/components/schemas/InstanceCrudProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"contactId":{"type":"string","description":"The contact associated with the space"}}}]}}}},"responses":{"200":{"description":"The space was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created space","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/space/export":{"get":{"operationId":"exportSpaces","summary":"Export spaces","tags":["Space"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of spaces was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"contactId":{"description":"The contact associated with the space","type":"string"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1space~1export/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}},"text/csv":{"schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/space/list":{"get":{"operationId":"listSpaces","summary":"List spaces","tags":["Space"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of spaces was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"$ref":"#/components/schemas/BlueprintProps"},{"type":"object","properties":{"contactId":{"description":"The contact associated with the space","type":"string"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1space~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/task/{taskId}/delete":{"post":{"operationId":"deleteTask","summary":"Delete task","tags":["Task"],"parameters":[{"in":"path","name":"taskId","required":true,"schema":{"description":"The ID of the task to delete","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"The task was deleted successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the deleted task","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/task/{taskId}/fetch":{"get":{"operationId":"fetchTask","summary":"Fetch task","tags":["Task"],"parameters":[{"in":"path","name":"taskId","required":true,"schema":{"description":"The ID of the task to retrieve","type":"string"}}],"responses":{"200":{"description":"The task was retrieved successfully","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"contactId":{"type":"string","description":"The contact associated with the task"},"botId":{"type":"string","description":"The bot associated with the task"},"schedule":{"type":"string","description":"The schedule of the task"},"status":{"$ref":"#/components/schemas/TaskStatus"},"outcome":{"$ref":"#/components/schemas/TaskOutcome"},"maxIterations":{"description":"The maximum number of iterations per task execution","type":"number"},"maxTime":{"description":"The maximum time per task execution (in milliseconds)","type":"number"}}}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/task/{taskId}/trigger":{"post":{"operationId":"triggerTask","summary":"Trigger a task","description":"Manually trigger a task to execute immediately.\n","tags":["Task"],"parameters":[{"in":"path","name":"taskId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"The request body for triggering a task","properties":{}}}}},"responses":{"200":{"description":"The task was triggered successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the triggered task","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/task/{taskId}/update":{"post":{"operationId":"updateTask","summary":"Update task","tags":["Task"],"parameters":[{"in":"path","name":"taskId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"type":"object","properties":{"contactId":{"type":"string","description":"The contact associated with the task"},"botId":{"type":"string","description":"The bot associated with the task"},"schedule":{"type":"string","description":"The schedule of the task"},"sessionDuration":{"description":"The session duration of the Widget integration","type":"number"},"maxIterations":{"description":"The maximum number of iterations per task execution","type":"number"},"maxTime":{"description":"The maximum time per task execution in milliseconds","type":"number"}}}]}}}},"responses":{"200":{"description":"The task was updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the updated task","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/task/create":{"post":{"operationId":"createTask","summary":"Create a new task","description":"Create a new task with the given parameters.\n","tags":["Task"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/InstanceCrudProps"},{"type":"object","properties":{"contactId":{"type":"string","description":"The contact associated with the task"},"botId":{"type":"string","description":"The bot associated with the task"},"schedule":{"type":"string","description":"The schedule of the task"},"sessionDuration":{"description":"The session duration of the Widget integration","type":"number"},"maxIterations":{"description":"The maximum number of iterations per task execution","type":"number"},"maxTime":{"description":"The maximum time per task execution in milliseconds","type":"number"}}}]}}}},"responses":{"200":{"description":"The task was created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The ID of the created task","type":"string"}},"required":["id"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/task/export":{"get":{"operationId":"exportTasks","summary":"Export tasks","tags":["Task"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of tasks was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"contactId":{"type":"string","description":"The contact associated with the task"},"botId":{"type":"string","description":"The bot associated with the task"},"schedule":{"type":"string","description":"The schedule of the task"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1task~1export/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}},"text/csv":{"schema":{"type":"string"}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/task/list":{"get":{"operationId":"listTasks","summary":"List tasks","tags":["Task"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"botId","schema":{"description":"Filter by associated bot","type":"string"}},{"in":"query","name":"contactId","schema":{"description":"Filter by associated contact","type":"string"}},{"in":"query","name":"status","schema":{"description":"Filter by task status","type":"string","enum":["idle","running"]}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of tasks was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"contactId":{"type":"string","description":"The contact associated with the task"},"botId":{"type":"string","description":"The bot associated with the task"},"schedule":{"type":"string","description":"The schedule of the task"},"status":{"$ref":"#/components/schemas/TaskStatus"},"outcome":{"$ref":"#/components/schemas/TaskOutcome"},"maxIterations":{"description":"The maximum number of iterations per task execution","type":"number"},"maxTime":{"description":"The maximum time per task execution (in milliseconds)","type":"number"}}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1task~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/team/list":{"get":{"operationId":"listTeams","summary":"Retrieve a list of teams","tags":["Team"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter the partner users by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of teams was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{}}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}},"application/jsonl":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"description":"The type of event","type":"string","enum":["item"]},"data":{"$ref":"#/paths/~1team~1list/get/responses/200/content/application~1json/schema/properties/items/items"}},"required":["type","data"]}]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/usage/fetch":{"get":{"operationId":"fetchUsage","summary":"Fetch usage","description":"Fetches the usage data for the user in the current billing period.","tags":["Usage"],"responses":{"200":{"description":"The usage information was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"tokens":{"description":"The number of tokens the user has used","type":"number"},"conversations":{"description":"The number of conversations the user has created","type":"number"},"messages":{"description":"The number of messages the user has sent","type":"number"},"database":{"description":"Database usage information","type":"object","properties":{"datasets":{"description":"The number of datasets the user has created","type":"number"},"records":{"description":"The number of records the user has created","type":"number"},"skillsets":{"description":"The number of skillsets the user has created","type":"number"},"abilities":{"description":"The number of abilities the user has created","type":"number"},"files":{"description":"The number of files the user has created","type":"number"},"users":{"description":"The number of users the user has created","type":"number"}},"required":["datasets","records","skillsets","abilities","files","users"]}},"required":["tokens","conversations","messages","database"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/usage/list":{"get":{"operationId":"listUsageRecords","summary":"List usage records","tags":["Usage"],"parameters":[{"in":"query","name":"cursor","schema":{"description":"The cursor to use for pagination","type":"string"}},{"in":"query","name":"order","schema":{"description":"The order of the paginated items","type":"string","enum":["asc","desc"],"default":"desc"}},{"in":"query","name":"take","schema":{"description":"The number of items to retrieve","type":"integer"}},{"in":"query","name":"meta","schema":{"description":"Key-value pairs to filter usage records by metadata","type":"object","additionalProperties":{"type":"string"}},"style":"deepObject","explode":true}],"responses":{"200":{"description":"The list of usage records was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/InstanceListProps"},{"type":"object","properties":{"type":{"description":"The usage type","type":"string"},"count":{"description":"The usage count","type":"integer"},"conversationId":{"description":"Related conversation ID if applicable","type":"string"},"messageId":{"description":"Related message ID if applicable","type":"string"},"taskId":{"description":"Related task ID if applicable","type":"string"},"contactId":{"description":"Related contact ID if applicable","type":"string"},"blueprintId":{"description":"Related blueprint ID if applicable","type":"string"},"botId":{"description":"Related bot ID if applicable","type":"string"},"datasetId":{"description":"Related dataset ID if applicable","type":"string"},"skillsetId":{"description":"Related skillset ID if applicable","type":"string"},"abilityId":{"description":"Related ability ID if applicable","type":"string"}},"required":["type","count"]}]}},"cursor":{"description":"Cursor for fetching the next page","type":"string"}},"required":["items","cursor"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}},"/usage/series/fetch":{"get":{"operationId":"fetchUsageSeries","summary":"Fetch usage series","description":"Fetches a series of usage data points for the user for the last 90 days.","tags":["Usage"],"responses":{"200":{"description":"The usage series information was retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"tokens":{"description":"The number of tokens the user has used","type":"array","items":{"type":"object","properties":{"date":{"description":"The date of the data point","type":"number"},"total":{"description":"The total number of tokens the user has used","type":"number"}},"required":["date","total"]}},"conversations":{"description":"The number of conversations the user has created","type":"array","items":{"type":"object","properties":{"date":{"description":"The date of the data point","type":"number"},"total":{"description":"The total number of conversations the user has used","type":"number"}},"required":["date","total"]}},"messages":{"description":"The number of messages the user has created","type":"array","items":{"type":"object","properties":{"date":{"description":"The date of the data point","type":"number"},"total":{"description":"The total number of messages the user has used","type":"number"}},"required":["date","total"]}}},"required":["tokens","conversations","messages"]}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}}}}},"tags":[]}