{ "openapi": "3.0.3", "info": { "title": "Chat API", "version": "1.0.0" }, "servers": [ { "url": "https://typebot.io/api/v1" } ], "paths": { "/sendMessage": { "post": { "operationId": "query.sendMessage", "summary": "Send a message", "description": "To initiate a chat, do not provide a `sessionId` nor a `message`.\n\nContinue the conversation by providing the `sessionId` and the `message` that should answer the previous question.\n\nSet the `isPreview` option to `true` to chat with the non-published version of the typebot.", "security": [ { "Authorization": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "The answer to the previous chat input. Do not provide it if you are starting a new chat." }, "sessionId": { "type": "string", "description": "Session ID that you get from the initial chat request to a bot. If not provided, it will create a new session." }, "startParams": { "type": "object", "properties": { "typebot": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "graphCoordinates": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "x", "y" ], "additionalProperties": false }, "blocks": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "start" ] }, "label": { "type": "string" } }, "required": [ "id", "groupId", "type", "label" ], "additionalProperties": false }, { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "text" ] }, "content": { "type": "object", "properties": { "html": { "type": "string" }, "richText": { "type": "array" }, "plainText": { "type": "string" } }, "required": [ "html", "richText", "plainText" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "content" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "image" ] }, "content": { "type": "object", "properties": { "url": { "type": "string" }, "clickLink": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "id", "groupId", "type", "content" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "video" ] }, "content": { "type": "object", "properties": { "url": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string", "enum": [ "url", "youtube", "vimeo" ] } }, "additionalProperties": false } }, "required": [ "id", "groupId", "type", "content" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "embed" ] }, "content": { "type": "object", "properties": { "url": { "type": "string" }, "height": { "anyOf": [ { "type": "number" }, {} ] } }, "required": [ "height" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "content" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "audio" ] }, "content": { "type": "object", "properties": { "url": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "groupId", "type", "content" ], "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "text input" ] }, "options": { "type": "object", "properties": { "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "variableId": { "type": "string" }, "isLong": { "type": "boolean" } }, "required": [ "labels", "isLong" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "choice input" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 0 ] }, "content": { "type": "string" } }, "required": [ "id", "blockId", "type" ], "additionalProperties": false } }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isMultipleChoice": { "type": "boolean" }, "buttonLabel": { "type": "string" }, "dynamicVariableId": { "type": "string" } }, "required": [ "isMultipleChoice", "buttonLabel" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "items", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "email input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "retryMessageContent": { "type": "string" } }, "required": [ "labels", "retryMessageContent" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "number input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "min": { "type": "number" }, "max": { "type": "number" }, "step": { "type": "number" } }, "required": [ "labels" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "url input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "retryMessageContent": { "type": "string" } }, "required": [ "labels", "retryMessageContent" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "phone number input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "retryMessageContent": { "type": "string" }, "defaultCountryCode": { "type": "string" } }, "required": [ "labels", "retryMessageContent" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "date input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "labels": { "type": "object", "properties": { "button": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "button", "from", "to" ], "additionalProperties": false }, "hasTime": { "type": "boolean" }, "isRange": { "type": "boolean" } }, "required": [ "labels", "hasTime", "isRange" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "payment input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "provider": { "type": "string", "enum": [ "Stripe" ] }, "labels": { "type": "object", "properties": { "button": { "type": "string" }, "success": { "type": "string" } }, "required": [ "button" ], "additionalProperties": false }, "additionalInformation": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" } }, "additionalProperties": false }, "credentialsId": { "type": "string" }, "currency": { "type": "string" }, "amount": { "type": "string" } }, "required": [ "provider", "labels", "currency" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "rating input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "buttonType": { "anyOf": [ { "type": "string", "enum": [ "Icons" ] }, { "type": "string", "enum": [ "Numbers" ] } ] }, "length": { "type": "number" }, "labels": { "type": "object", "properties": { "left": { "type": "string" }, "right": { "type": "string" }, "button": { "type": "string" } }, "required": [ "button" ], "additionalProperties": false }, "customIcon": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "svg": { "type": "string" } }, "required": [ "isEnabled" ], "additionalProperties": false }, "isOneClickSubmitEnabled": { "type": "boolean" } }, "required": [ "buttonType", "length", "labels", "customIcon" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "file input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isRequired": { "type": "boolean" }, "isMultipleAllowed": { "type": "boolean" }, "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" }, "clear": { "type": "string" }, "skip": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "sizeLimit": { "type": "number" } }, "required": [ "isMultipleAllowed", "labels" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Code" ] }, "options": { "type": "object", "properties": { "name": { "type": "string" }, "content": { "type": "string" }, "shouldExecuteInParentContext": { "type": "boolean" } }, "required": [ "name" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Condition" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 1 ] }, "content": { "type": "object", "properties": { "logicalOperator": { "type": "string", "enum": [ "OR", "AND" ] }, "comparisons": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "variableId": { "type": "string" }, "comparisonOperator": { "type": "string", "enum": [ "Equal to", "Not equal", "Contains", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "logicalOperator", "comparisons" ], "additionalProperties": false } }, "required": [ "id", "blockId", "type", "content" ], "additionalProperties": false } } }, "required": [ "id", "groupId", "type", "items" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Redirect" ] }, "options": { "type": "object", "properties": { "url": { "type": "string" }, "isNewTab": { "type": "boolean" } }, "required": [ "isNewTab" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Set variable" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "expressionToEvaluate": { "type": "string" }, "isCode": { "type": "boolean" } }, "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Typebot link" ] }, "options": { "type": "object", "properties": { "typebotId": { "type": "string" }, "groupId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Wait" ] }, "options": { "type": "object", "properties": { "secondsToWaitFor": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Jump" ] }, "options": { "type": "object", "properties": { "groupId": { "type": "string" }, "blockId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false } ] }, { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Chatwoot" ] }, "options": { "type": "object", "properties": { "task": { "type": "string", "enum": [ "Show widget", "Close widget" ] }, "baseUrl": { "type": "string" }, "websiteToken": { "type": "string" }, "user": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "phoneNumber": { "type": "string" } }, "additionalProperties": false } }, "required": [ "baseUrl", "websiteToken" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Google Analytics" ] }, "options": { "type": "object", "properties": { "trackingId": { "type": "string" }, "category": { "type": "string" }, "action": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Google Sheets" ] }, "options": { "anyOf": [ { "type": "object", "properties": { "credentialsId": { "type": "string" }, "sheetId": { "type": "string" }, "spreadsheetId": { "type": "string" }, "action": { "type": "string", "enum": [ "Get data from sheet" ] }, "referenceCell": { "type": "object", "properties": { "column": { "type": "string" }, "value": { "type": "string" }, "id": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, "filter": { "type": "object", "properties": { "comparisons": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "column": { "type": "string" }, "comparisonOperator": { "type": "string", "enum": [ "Equal to", "Not equal", "Contains", "Does not contain", "Greater than", "Less than", "Is set", "Is empty", "Starts with", "Ends with" ] }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "logicalOperator": { "type": "string", "enum": [ "OR", "AND" ] } }, "required": [ "comparisons", "logicalOperator" ], "additionalProperties": false }, "cellsToExtract": { "type": "array", "items": { "type": "object", "properties": { "column": { "type": "string" }, "id": { "type": "string" }, "variableId": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "action", "cellsToExtract" ], "additionalProperties": false }, { "type": "object", "properties": { "credentialsId": { "type": "string" }, "sheetId": { "type": "string" }, "spreadsheetId": { "type": "string" }, "action": { "type": "string", "enum": [ "Insert a row" ] }, "cellsToInsert": { "type": "array", "items": { "type": "object", "properties": { "column": { "type": "string" }, "value": { "type": "string" }, "id": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "action", "cellsToInsert" ], "additionalProperties": false }, { "type": "object", "properties": { "credentialsId": { "type": "string" }, "sheetId": { "type": "string" }, "spreadsheetId": { "type": "string" }, "action": { "type": "string", "enum": [ "Update a row" ] }, "cellsToUpsert": { "type": "array", "items": { "type": "object", "properties": { "column": { "type": "string" }, "value": { "type": "string" }, "id": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "referenceCell": { "type": "object", "properties": { "column": { "type": "string" }, "value": { "type": "string" }, "id": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "action", "cellsToUpsert" ], "additionalProperties": false }, { "type": "object", "properties": { "credentialsId": { "type": "string" }, "sheetId": { "type": "string" }, "spreadsheetId": { "type": "string" }, "action": { "not": {} } }, "additionalProperties": false } ] } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Make.com" ] }, "options": { "type": "object", "properties": { "variablesForTest": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "variableId": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "responseVariableMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "variableId": { "type": "string" }, "bodyPath": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "isAdvancedConfig": { "type": "boolean" }, "isCustomBody": { "type": "boolean" } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string" } }, "required": [ "id", "groupId", "type", "options", "webhookId" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "OpenAI" ] }, "options": { "anyOf": [ { "type": "object", "properties": { "task": { "not": {} }, "credentialsId": { "type": "string" } }, "additionalProperties": false }, { "type": "object", "properties": { "task": { "type": "string", "enum": [ "Create chat completion" ] }, "model": { "type": "string", "enum": [ "gpt-4", "gpt-4-0314", "gpt-4-32k", "gpt-4-32k-0314", "gpt-3.5-turbo", "gpt-3.5-turbo-0301" ] }, "messages": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string", "enum": [ "system", "user", "assistant" ] }, "content": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "role": { "type": "string", "enum": [ "Messages sequence ✨" ] }, "content": { "type": "object", "properties": { "assistantMessagesVariableId": { "type": "string" }, "userMessagesVariableId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "role" ], "additionalProperties": false } ] } }, "advancedSettings": { "type": "object", "properties": { "temperature": { "anyOf": [ { "type": "number" }, {} ] } }, "additionalProperties": false }, "responseMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueToExtract": { "type": "string", "enum": [ "Message content", "Total tokens" ] }, "variableId": { "type": "string" } }, "required": [ "id", "valueToExtract" ], "additionalProperties": false } }, "credentialsId": { "type": "string" } }, "required": [ "task", "model", "messages", "responseMapping" ], "additionalProperties": false }, { "type": "object", "properties": { "task": { "type": "string", "enum": [ "Create image" ] }, "prompt": { "type": "string" }, "advancedOptions": { "type": "object", "properties": { "size": { "type": "string", "enum": [ "256x256", "512x512", "1024x1024" ] } }, "additionalProperties": false }, "responseMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueToExtract": { "type": "string", "enum": [ "Image URL" ] }, "variableId": { "type": "string" } }, "required": [ "id", "valueToExtract" ], "additionalProperties": false } }, "credentialsId": { "type": "string" } }, "required": [ "task", "advancedOptions", "responseMapping" ], "additionalProperties": false } ] } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Pabbly" ] }, "options": { "type": "object", "properties": { "variablesForTest": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "variableId": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "responseVariableMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "variableId": { "type": "string" }, "bodyPath": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "isAdvancedConfig": { "type": "boolean" }, "isCustomBody": { "type": "boolean" } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string" } }, "required": [ "id", "groupId", "type", "options", "webhookId" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Email" ] }, "options": { "type": "object", "properties": { "credentialsId": { "type": "string" }, "isCustomBody": { "type": "boolean" }, "isBodyCode": { "type": "boolean" }, "recipients": { "type": "array", "items": { "type": "string" } }, "subject": { "type": "string" }, "body": { "type": "string" }, "replyTo": { "type": "string" }, "cc": { "type": "array", "items": { "type": "string" } }, "bcc": { "type": "array", "items": { "type": "string" } }, "attachmentsVariableId": { "type": "string" } }, "required": [ "credentialsId", "recipients" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Webhook" ] }, "options": { "type": "object", "properties": { "variablesForTest": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "variableId": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "responseVariableMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "variableId": { "type": "string" }, "bodyPath": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "isAdvancedConfig": { "type": "boolean" }, "isCustomBody": { "type": "boolean" } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string" } }, "required": [ "id", "groupId", "type", "options", "webhookId" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "Zapier" ] }, "options": { "type": "object", "properties": { "variablesForTest": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "variableId": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "responseVariableMapping": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "variableId": { "type": "string" }, "bodyPath": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false } }, "isAdvancedConfig": { "type": "boolean" }, "isCustomBody": { "type": "boolean" } }, "required": [ "variablesForTest", "responseVariableMapping" ], "additionalProperties": false }, "webhookId": { "type": "string" } }, "required": [ "id", "groupId", "type", "options", "webhookId" ], "additionalProperties": false } ] } ] } } }, "required": [ "id", "title", "graphCoordinates", "blocks" ], "additionalProperties": false } }, "edges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "from": { "type": "object", "properties": { "groupId": { "type": "string" }, "blockId": { "type": "string" }, "itemId": { "type": "string" } }, "required": [ "groupId", "blockId" ], "additionalProperties": false }, "to": { "type": "object", "properties": { "groupId": { "type": "string" }, "blockId": { "type": "string" } }, "required": [ "groupId" ], "additionalProperties": false } }, "required": [ "id", "from", "to" ], "additionalProperties": false } }, "variables": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string", "nullable": true } } ], "nullable": true } }, "required": [ "id", "name" ], "additionalProperties": false } }, "settings": { "type": "object", "properties": { "general": { "type": "object", "properties": { "isBrandingEnabled": { "type": "boolean" }, "isTypingEmulationEnabled": { "type": "boolean" }, "isInputPrefillEnabled": { "type": "boolean" }, "isHideQueryParamsEnabled": { "type": "boolean" }, "isNewResultOnRefreshEnabled": { "type": "boolean" } }, "required": [ "isBrandingEnabled" ], "additionalProperties": false }, "typingEmulation": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "speed": { "type": "number" }, "maxDelay": { "type": "number" } }, "required": [ "enabled", "speed", "maxDelay" ], "additionalProperties": false }, "metadata": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "imageUrl": { "type": "string" }, "favIconUrl": { "type": "string" }, "customHeadCode": { "type": "string" }, "googleTagManagerId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "general", "typingEmulation", "metadata" ], "additionalProperties": false }, "theme": { "type": "object", "properties": { "general": { "type": "object", "properties": { "font": { "type": "string" }, "background": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Color", "Image", "None" ] }, "content": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false } }, "required": [ "font", "background" ], "additionalProperties": false }, "chat": { "type": "object", "properties": { "hostAvatar": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "isEnabled" ], "additionalProperties": false }, "guestAvatar": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "isEnabled" ], "additionalProperties": false }, "hostBubbles": { "type": "object", "properties": { "backgroundColor": { "type": "string" }, "color": { "type": "string" } }, "required": [ "backgroundColor", "color" ], "additionalProperties": false }, "guestBubbles": { "type": "object", "properties": { "backgroundColor": { "type": "string" }, "color": { "type": "string" } }, "required": [ "backgroundColor", "color" ], "additionalProperties": false }, "buttons": { "type": "object", "properties": { "backgroundColor": { "type": "string" }, "color": { "type": "string" } }, "required": [ "backgroundColor", "color" ], "additionalProperties": false }, "inputs": { "type": "object", "properties": { "backgroundColor": { "type": "string" }, "color": { "type": "string" }, "placeholderColor": { "type": "string" } }, "required": [ "backgroundColor", "color", "placeholderColor" ], "additionalProperties": false }, "roundness": { "type": "string", "enum": [ "none", "medium", "large" ] } }, "required": [ "hostBubbles", "guestBubbles", "buttons", "inputs" ], "additionalProperties": false }, "customCss": { "type": "string" } }, "required": [ "general", "chat" ], "additionalProperties": false } }, "required": [ "id", "groups", "edges", "variables", "settings", "theme" ], "additionalProperties": false }, { "type": "string" } ], "description": "Either a Typebot ID or a Typebot object. If you provide a Typebot object, it will be executed in preview mode. ([How can I find my typebot ID?](https://docs.typebot.io/api#how-to-find-my-typebotid))." }, "isPreview": { "type": "boolean", "description": "If set to `true`, it will start a Preview session with the unpublished bot and it won't be saved in the Results tab. You need to be authenticated for this to work." }, "resultId": { "type": "string", "description": "Provide it if you'd like to overwrite an existing result." }, "startGroupId": { "type": "string", "description": "Start chat from a specific group." }, "prefilledVariables": { "type": "object", "additionalProperties": {}, "description": "[More info about prefilled variables.](https://docs.typebot.io/editor/variables#prefilled-variables)" } }, "required": [ "typebot" ], "additionalProperties": false } }, "additionalProperties": false } } } }, "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "messages": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text" ] }, "content": { "type": "object", "properties": { "html": { "type": "string" }, "plainText": { "type": "string" } }, "required": [ "html", "plainText" ], "additionalProperties": false } }, "required": [ "type", "content" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "image" ] }, "content": { "type": "object", "properties": { "url": { "type": "string" }, "clickLink": { "type": "object", "properties": { "url": { "type": "string" }, "alt": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } }, "required": [ "type", "content" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "video" ] }, "content": { "type": "object", "properties": { "url": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string", "enum": [ "url", "youtube", "vimeo" ] } }, "additionalProperties": false } }, "required": [ "type", "content" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "audio" ] }, "content": { "type": "object", "properties": { "url": { "type": "string" } }, "additionalProperties": false } }, "required": [ "type", "content" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "embed" ] }, "content": { "type": "object", "properties": { "url": { "type": "string" }, "height": { "type": "number" } }, "additionalProperties": false } }, "required": [ "type", "content" ], "additionalProperties": false } ] } ] } }, "input": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "text input" ] }, "options": { "type": "object", "properties": { "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "variableId": { "type": "string" }, "isLong": { "type": "boolean" } }, "required": [ "labels", "isLong" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "choice input" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "blockId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "number", "enum": [ 0 ] }, "content": { "type": "string" } }, "required": [ "id", "blockId", "type" ], "additionalProperties": false } }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isMultipleChoice": { "type": "boolean" }, "buttonLabel": { "type": "string" }, "dynamicVariableId": { "type": "string" } }, "required": [ "isMultipleChoice", "buttonLabel" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "items", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "email input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "retryMessageContent": { "type": "string" } }, "required": [ "labels", "retryMessageContent" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "number input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "min": { "type": "number" }, "max": { "type": "number" }, "step": { "type": "number" } }, "required": [ "labels" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "url input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "retryMessageContent": { "type": "string" } }, "required": [ "labels", "retryMessageContent" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "phone number input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "retryMessageContent": { "type": "string" }, "defaultCountryCode": { "type": "string" } }, "required": [ "labels", "retryMessageContent" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "date input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "labels": { "type": "object", "properties": { "button": { "type": "string" }, "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "button", "from", "to" ], "additionalProperties": false }, "hasTime": { "type": "boolean" }, "isRange": { "type": "boolean" } }, "required": [ "labels", "hasTime", "isRange" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "payment input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "provider": { "type": "string", "enum": [ "Stripe" ] }, "labels": { "type": "object", "properties": { "button": { "type": "string" }, "success": { "type": "string" } }, "required": [ "button" ], "additionalProperties": false }, "additionalInformation": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" } }, "additionalProperties": false }, "credentialsId": { "type": "string" }, "currency": { "type": "string" }, "amount": { "type": "string" } }, "required": [ "provider", "labels", "currency" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "rating input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "buttonType": { "anyOf": [ { "type": "string", "enum": [ "Icons" ] }, { "type": "string", "enum": [ "Numbers" ] } ] }, "length": { "type": "number" }, "labels": { "type": "object", "properties": { "left": { "type": "string" }, "right": { "type": "string" }, "button": { "type": "string" } }, "required": [ "button" ], "additionalProperties": false }, "customIcon": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "svg": { "type": "string" } }, "required": [ "isEnabled" ], "additionalProperties": false }, "isOneClickSubmitEnabled": { "type": "boolean" } }, "required": [ "buttonType", "length", "labels", "customIcon" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string" }, "groupId": { "type": "string" }, "outgoingEdgeId": { "type": "string" }, "type": { "type": "string", "enum": [ "file input" ] }, "options": { "type": "object", "properties": { "variableId": { "type": "string" }, "isRequired": { "type": "boolean" }, "isMultipleAllowed": { "type": "boolean" }, "labels": { "type": "object", "properties": { "placeholder": { "type": "string" }, "button": { "type": "string" }, "clear": { "type": "string" }, "skip": { "type": "string" } }, "required": [ "placeholder", "button" ], "additionalProperties": false }, "sizeLimit": { "type": "number" } }, "required": [ "isMultipleAllowed", "labels" ], "additionalProperties": false } }, "required": [ "id", "groupId", "type", "options" ], "additionalProperties": false } ] }, { "type": "object", "properties": { "prefilledValue": { "type": "string" }, "runtimeOptions": { "type": "object", "properties": { "paymentIntentSecret": { "type": "string" }, "amountLabel": { "type": "string" }, "publicKey": { "type": "string" } }, "required": [ "paymentIntentSecret", "amountLabel", "publicKey" ], "additionalProperties": false } }, "additionalProperties": false } ] }, "clientSideActions": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "lastBubbleBlockId": { "type": "string" } }, "additionalProperties": false }, { "anyOf": [ { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "scriptToExecute": { "type": "object", "properties": { "content": { "type": "string" }, "args": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, { "type": "boolean" } ] }, { "type": "array", "items": { "type": "string", "nullable": true } } ], "nullable": true } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "content", "args" ], "additionalProperties": false } }, "required": [ "scriptToExecute" ], "additionalProperties": false }, { "type": "object", "properties": { "redirect": { "type": "object", "properties": { "url": { "type": "string" }, "isNewTab": { "type": "boolean" } }, "required": [ "isNewTab" ], "additionalProperties": false } }, "required": [ "redirect" ], "additionalProperties": false } ] }, { "type": "object", "properties": { "chatwoot": { "type": "object", "properties": { "scriptToExecute": { "type": "object", "properties": { "content": { "type": "string" }, "args": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, { "type": "boolean" } ] }, { "type": "array", "items": { "type": "string", "nullable": true } } ], "nullable": true } }, "required": [ "id" ], "additionalProperties": false } } }, "required": [ "content", "args" ], "additionalProperties": false } }, "required": [ "scriptToExecute" ], "additionalProperties": false } }, "required": [ "chatwoot" ], "additionalProperties": false } ] }, { "type": "object", "properties": { "googleAnalytics": { "type": "object", "properties": { "trackingId": { "type": "string" }, "category": { "type": "string" }, "action": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false } }, "required": [ "googleAnalytics" ], "additionalProperties": false } ] }, { "type": "object", "properties": { "wait": { "type": "object", "properties": { "secondsToWaitFor": { "type": "number" } }, "required": [ "secondsToWaitFor" ], "additionalProperties": false } }, "required": [ "wait" ], "additionalProperties": false } ] } ] } }, "sessionId": { "type": "string" }, "typebot": { "type": "object", "properties": { "id": { "type": "string" }, "theme": { "type": "object", "properties": { "general": { "type": "object", "properties": { "font": { "type": "string" }, "background": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Color", "Image", "None" ] }, "content": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false } }, "required": [ "font", "background" ], "additionalProperties": false }, "chat": { "type": "object", "properties": { "hostAvatar": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "isEnabled" ], "additionalProperties": false }, "guestAvatar": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "isEnabled" ], "additionalProperties": false }, "hostBubbles": { "type": "object", "properties": { "backgroundColor": { "type": "string" }, "color": { "type": "string" } }, "required": [ "backgroundColor", "color" ], "additionalProperties": false }, "guestBubbles": { "type": "object", "properties": { "backgroundColor": { "type": "string" }, "color": { "type": "string" } }, "required": [ "backgroundColor", "color" ], "additionalProperties": false }, "buttons": { "type": "object", "properties": { "backgroundColor": { "type": "string" }, "color": { "type": "string" } }, "required": [ "backgroundColor", "color" ], "additionalProperties": false }, "inputs": { "type": "object", "properties": { "backgroundColor": { "type": "string" }, "color": { "type": "string" }, "placeholderColor": { "type": "string" } }, "required": [ "backgroundColor", "color", "placeholderColor" ], "additionalProperties": false }, "roundness": { "type": "string", "enum": [ "none", "medium", "large" ] } }, "required": [ "hostBubbles", "guestBubbles", "buttons", "inputs" ], "additionalProperties": false }, "customCss": { "type": "string" } }, "required": [ "general", "chat" ], "additionalProperties": false }, "settings": { "type": "object", "properties": { "general": { "type": "object", "properties": { "isBrandingEnabled": { "type": "boolean" }, "isTypingEmulationEnabled": { "type": "boolean" }, "isInputPrefillEnabled": { "type": "boolean" }, "isHideQueryParamsEnabled": { "type": "boolean" }, "isNewResultOnRefreshEnabled": { "type": "boolean" } }, "required": [ "isBrandingEnabled" ], "additionalProperties": false }, "typingEmulation": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "speed": { "type": "number" }, "maxDelay": { "type": "number" } }, "required": [ "enabled", "speed", "maxDelay" ], "additionalProperties": false }, "metadata": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "imageUrl": { "type": "string" }, "favIconUrl": { "type": "string" }, "customHeadCode": { "type": "string" }, "googleTagManagerId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "general", "typingEmulation", "metadata" ], "additionalProperties": false } }, "required": [ "id", "theme", "settings" ], "additionalProperties": false }, "resultId": { "type": "string" }, "dynamicTheme": { "type": "object", "properties": { "hostAvatarUrl": { "type": "string" }, "guestAvatarUrl": { "type": "string" } }, "additionalProperties": false }, "logs": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "description": { "type": "string" }, "details": {} }, "required": [ "status", "description" ], "additionalProperties": false } } }, "required": [ "messages" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } }, "/typebots/{typebotId}/blocks/{blockId}/storage/upload-url": { "get": { "operationId": "query.getUploadUrl", "summary": "Get upload URL for a file", "description": "Used for the web client to get the bucket upload file.", "parameters": [ { "name": "typebotId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "blockId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filePath", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "fileType", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "presignedUrl": { "type": "object", "properties": { "url": { "type": "string" }, "fields": {} }, "required": [ "url" ], "additionalProperties": false }, "hasReachedStorageLimit": { "type": "boolean" } }, "required": [ "presignedUrl", "hasReachedStorageLimit" ], "additionalProperties": false } } } }, "default": { "$ref": "#/components/responses/error" } } } } }, "components": { "securitySchemes": { "Authorization": { "type": "http", "scheme": "bearer" } }, "responses": { "error": { "description": "Error response", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ], "additionalProperties": false } } }, "required": [ "message", "code" ], "additionalProperties": false } } } } } }, "externalDocs": { "url": "https://docs.typebot.io/api" } }