baptisteArno / typebot.io
9,919 TypeScript💬 Typebot is a powerful chatbot builder that you can self-host.
Builder API Specification
Located in apps/docs/openapi/builder.json on branch HEAD
3.1.1
JSON
53 Endpoints
3364.2 KB
Operations & Route Endpoints (67)
Raw JSON Specification
{
"info": {
"title": "Builder API",
"version": "1.0.0"
},
"servers": [
{
"url": "https://app.typebot.com/api"
}
],
"externalDocs": {
"url": "https://docs.typebot.com/api-reference"
},
"components": {
"securitySchemes": {
"Authorization": {
"type": "http",
"scheme": "bearer"
}
},
"schemas": {
"V6": {
"type": "object",
"properties": {
"version": {
"enum": [
"6",
"6.1"
],
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"events": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "start"
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
],
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "command"
},
"options": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"resumeAfter": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "reply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "invalidReply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
]
}
},
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"$ref": "#/components/schemas/Image"
},
{
"$ref": "#/components/schemas/Video"
},
{
"$ref": "#/components/schemas/Embed"
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"$ref": "#/components/schemas/NumberInput"
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"$ref": "#/components/schemas/RatingInput"
},
{
"$ref": "#/components/schemas/Cards"
},
{
"$ref": "#/components/schemas/ChoiceInput"
},
{
"$ref": "#/components/schemas/FileInput"
},
{
"$ref": "#/components/schemas/PictureChoiceInput"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"$ref": "#/components/schemas/Condition"
},
{
"$ref": "#/components/schemas/AbTest"
},
{
"$ref": "#/components/schemas/Webhook"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"$ref": "#/components/schemas/GoogleAnalytics"
},
{
"$ref": "#/components/schemas/Openai"
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"$ref": "#/components/schemas/GoogleSheets"
},
{
"$ref": "#/components/schemas/Make.com"
},
{
"$ref": "#/components/schemas/Pabbly"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zapier"
}
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "openai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{},
{},
{},
{}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{}
]
}
},
"temperature": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {},
"variableId": {}
}
}
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/AskAssistant"
},
{
"$ref": "#/components/schemas/AskModel"
},
{
"$ref": "#/components/schemas/GenerateVariables"
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create speech"
},
"model": {
"type": "string"
},
"input": {
"type": "string"
},
"instructions": {
"type": "string"
},
"voice": {
"enum": [
"alloy",
"echo",
"fable",
"onyx",
"nova",
"shimmer"
],
"type": "string"
},
"saveUrlInVariableId": {
"type": "string"
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/CreateTranscription"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/CalCom"
},
{
"$ref": "#/components/schemas/ChatNode"
},
{
"$ref": "#/components/schemas/QrCode"
},
{
"$ref": "#/components/schemas/DifyAi"
},
{
"$ref": "#/components/schemas/Mistral"
},
{
"$ref": "#/components/schemas/Elevenlabs"
},
{
"$ref": "#/components/schemas/Anthropic"
},
{
"$ref": "#/components/schemas/TogetherAi"
},
{
"$ref": "#/components/schemas/OpenRouter"
},
{
"$ref": "#/components/schemas/Nocodb"
},
{
"$ref": "#/components/schemas/Segment"
},
{
"$ref": "#/components/schemas/Groq"
},
{
"$ref": "#/components/schemas/Zendesk"
},
{
"$ref": "#/components/schemas/Posthog"
},
{
"$ref": "#/components/schemas/Perplexity"
},
{
"$ref": "#/components/schemas/Deepseek"
},
{
"$ref": "#/components/schemas/Blink"
},
{
"$ref": "#/components/schemas/Gmail"
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"selectedThemeTemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"startCondition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
},
"required": [
"comparisons"
]
},
"sessionExpiryTimeout": {
"type": "number",
"minimum": 0.01,
"maximum": 48,
"description": "Expiration delay in hours after latest interaction"
},
"errorAndMarketingStatusWebhookForwardUrl": {
"type": "string",
"format": "uri"
},
"isWebhookForwardingEnabled": {
"type": "boolean"
},
"webhookForwardingEventTypes": {
"type": "array",
"items": {
"enum": [
"all",
"errorStatuses",
"marketingStatuses"
],
"type": "string"
}
}
}
},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publicId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customDomain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"resultsTablePreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"columnsOrder": {
"type": "array",
"items": {
"type": "string"
}
},
"columnsVisibility": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
"columnsWidth": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"columnsOrder",
"columnsVisibility",
"columnsWidth"
]
},
{
"type": "null"
}
]
},
"isArchived": {
"type": "boolean"
},
"isClosed": {
"type": "boolean"
},
"whatsAppCredentialsId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"riskLevel": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"spaceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"version",
"id",
"name",
"events",
"groups",
"edges",
"variables",
"theme",
"selectedThemeTemplateId",
"settings",
"createdAt",
"updatedAt",
"icon",
"folderId",
"publicId",
"customDomain",
"workspaceId",
"resultsTablePreferences",
"isArchived",
"isClosed",
"whatsAppCredentialsId",
"riskLevel",
"spaceId"
]
},
"V6.1": {
"type": "object",
"properties": {
"version": {
"enum": [
"6",
"6.1"
],
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"events": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "start"
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
],
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "command"
},
"options": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"resumeAfter": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "reply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "invalidReply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
]
}
},
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"$ref": "#/components/schemas/Image"
},
{
"$ref": "#/components/schemas/Video"
},
{
"$ref": "#/components/schemas/Embed"
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"$ref": "#/components/schemas/NumberInput"
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"$ref": "#/components/schemas/RatingInput"
},
{
"$ref": "#/components/schemas/Cards"
},
{
"$ref": "#/components/schemas/ChoiceInput"
},
{
"$ref": "#/components/schemas/FileInput"
},
{
"$ref": "#/components/schemas/PictureChoiceInput"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"$ref": "#/components/schemas/Condition"
},
{
"$ref": "#/components/schemas/AbTest"
},
{
"$ref": "#/components/schemas/Webhook"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"$ref": "#/components/schemas/GoogleAnalytics"
},
{
"$ref": "#/components/schemas/Openai"
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"$ref": "#/components/schemas/GoogleSheets"
},
{
"$ref": "#/components/schemas/Make.com"
},
{
"$ref": "#/components/schemas/Pabbly"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zapier"
}
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "openai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{},
{},
{},
{}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{}
]
}
},
"temperature": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {},
"variableId": {}
}
}
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/AskAssistant"
},
{
"$ref": "#/components/schemas/AskModel"
},
{
"$ref": "#/components/schemas/GenerateVariables"
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create speech"
},
"model": {
"type": "string"
},
"input": {
"type": "string"
},
"instructions": {
"type": "string"
},
"voice": {
"enum": [
"alloy",
"echo",
"fable",
"onyx",
"nova",
"shimmer"
],
"type": "string"
},
"saveUrlInVariableId": {
"type": "string"
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/CreateTranscription"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/CalCom"
},
{
"$ref": "#/components/schemas/ChatNode"
},
{
"$ref": "#/components/schemas/QrCode"
},
{
"$ref": "#/components/schemas/DifyAi"
},
{
"$ref": "#/components/schemas/Mistral"
},
{
"$ref": "#/components/schemas/Elevenlabs"
},
{
"$ref": "#/components/schemas/Anthropic"
},
{
"$ref": "#/components/schemas/TogetherAi"
},
{
"$ref": "#/components/schemas/OpenRouter"
},
{
"$ref": "#/components/schemas/Nocodb"
},
{
"$ref": "#/components/schemas/Segment"
},
{
"$ref": "#/components/schemas/Groq"
},
{
"$ref": "#/components/schemas/Zendesk"
},
{
"$ref": "#/components/schemas/Posthog"
},
{
"$ref": "#/components/schemas/Perplexity"
},
{
"$ref": "#/components/schemas/Deepseek"
},
{
"$ref": "#/components/schemas/Blink"
},
{
"$ref": "#/components/schemas/Gmail"
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"selectedThemeTemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"startCondition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
},
"required": [
"comparisons"
]
},
"sessionExpiryTimeout": {
"type": "number",
"minimum": 0.01,
"maximum": 48,
"description": "Expiration delay in hours after latest interaction"
},
"errorAndMarketingStatusWebhookForwardUrl": {
"type": "string",
"format": "uri"
},
"isWebhookForwardingEnabled": {
"type": "boolean"
},
"webhookForwardingEventTypes": {
"type": "array",
"items": {
"enum": [
"all",
"errorStatuses",
"marketingStatuses"
],
"type": "string"
}
}
}
},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publicId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customDomain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"resultsTablePreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"columnsOrder": {
"type": "array",
"items": {
"type": "string"
}
},
"columnsVisibility": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
"columnsWidth": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"columnsOrder",
"columnsVisibility",
"columnsWidth"
]
},
{
"type": "null"
}
]
},
"isArchived": {
"type": "boolean"
},
"isClosed": {
"type": "boolean"
},
"whatsAppCredentialsId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"riskLevel": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"spaceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"version",
"id",
"name",
"events",
"groups",
"edges",
"variables",
"theme",
"selectedThemeTemplateId",
"settings",
"createdAt",
"updatedAt",
"icon",
"folderId",
"publicId",
"customDomain",
"workspaceId",
"resultsTablePreferences",
"isArchived",
"isClosed",
"whatsAppCredentialsId",
"riskLevel",
"spaceId"
]
},
"Start": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "start"
},
"label": {
"type": "string"
}
},
"required": [
"id",
"type",
"label"
]
},
"Text": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"text"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"html": {
"type": "string"
},
"richText": {
"type": "array",
"items": {}
},
"plainText": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
"Image": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"image"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"clickLink": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"alt": {
"type": "string"
}
}
}
}
}
},
"required": [
"id",
"type"
]
},
"Video": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"video"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"enum": [
"url",
"youtube",
"vimeo",
"tiktok",
"gumlet"
],
"type": "string"
},
"height": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"aspectRatio": {
"type": "string"
},
"maxWidth": {
"type": "string"
},
"queryParamsStr": {
"type": "string"
},
"areControlsDisplayed": {
"type": "boolean"
},
"isAutoplayEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
"Embed": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"embed"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"height": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"waitForEvent": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"saveDataInVariableId": {
"type": "string"
}
}
}
}
}
},
"required": [
"id",
"type"
]
},
"Audio": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"audio"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"isAutoplayEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
"TextInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"text input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"labels": {
"type": "object",
"properties": {
"placeholder": {
"type": "string"
},
"button": {
"type": "string"
}
}
},
"variableId": {
"type": "string"
},
"isLong": {
"type": "boolean"
},
"inputMode": {
"enum": [
"text",
"decimal",
"numeric",
"tel",
"search",
"email",
"url"
],
"type": "string"
},
"audioClip": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"saveVariableId": {
"type": "string"
},
"visibility": {
"enum": [
"Auto",
"Public",
"Private"
],
"type": "string"
}
}
},
"attachments": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"saveVariableId": {
"type": "string"
},
"visibility": {
"enum": [
"Auto",
"Public",
"Private"
],
"type": "string"
}
}
}
}
}
},
"required": [
"id",
"type"
]
},
"EmailInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"email input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"labels": {
"type": "object",
"properties": {
"placeholder": {
"type": "string"
},
"button": {
"type": "string"
}
}
},
"retryMessageContent": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
"NumberInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"number input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"labels": {
"type": "object",
"properties": {
"placeholder": {
"type": "string"
},
"button": {
"type": "string"
}
}
},
"min": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"max": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"step": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"locale": {
"type": "string",
"pattern": "^[a-z]{2}(-[A-Z]{2})?$"
},
"style": {
"enum": [
"decimal",
"currency",
"percent",
"unit"
],
"type": "string"
},
"currency": {
"type": "string"
},
"unit": {
"enum": [
"acre",
"bit",
"byte",
"celsius",
"centimeter",
"day",
"degree",
"fahrenheit",
"fluid-ounce",
"foot",
"gallon",
"gigabit",
"gigabyte",
"gram",
"hectare",
"hour",
"inch",
"kilobit",
"kilobyte",
"kilogram",
"kilometer",
"liter",
"megabit",
"megabyte",
"meter",
"microsecond",
"mile",
"mile-scandinavian",
"milliliter",
"millimeter",
"millisecond",
"minute",
"month",
"nanosecond",
"ounce",
"percent",
"petabyte",
"pound",
"second",
"stone",
"terabit",
"terabyte",
"week",
"yard",
"year"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
"UrlInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"url input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"labels": {
"type": "object",
"properties": {
"placeholder": {
"type": "string"
},
"button": {
"type": "string"
}
}
},
"retryMessageContent": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
"PhoneNumberInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"phone number input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"labels": {
"type": "object",
"properties": {
"placeholder": {
"type": "string"
},
"button": {
"type": "string"
}
}
},
"retryMessageContent": {
"type": "string"
},
"defaultCountryCode": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
"DateInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"date input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"labels": {
"type": "object",
"properties": {
"button": {
"type": "string"
},
"from": {
"type": "string"
},
"to": {
"type": "string"
}
}
},
"hasTime": {
"type": "boolean"
},
"isRange": {
"type": "boolean"
},
"format": {
"type": "string",
"description": "Format of the string is based on Unicode Technical Standard #35"
},
"min": {
"type": "string"
},
"max": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
"TimeInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"time input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"labels": {
"type": "object",
"properties": {
"button": {
"type": "string"
}
}
},
"format": {
"type": "string",
"description": "Format of the string is based on Unicode Technical Standard #35"
}
}
}
},
"required": [
"id",
"type"
]
},
"PaymentInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"payment input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"provider": {
"enum": [
"Stripe"
],
"type": "string"
},
"labels": {
"type": "object",
"properties": {
"button": {
"type": "string"
},
"success": {
"type": "string"
}
}
},
"additionalInformation": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"address": {
"type": "object",
"properties": {
"country": {
"type": "string"
},
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"state": {
"type": "string"
},
"city": {
"type": "string"
},
"postalCode": {
"type": "string"
}
}
}
}
},
"credentialsId": {
"type": "string"
},
"currency": {
"type": "string"
},
"amount": {
"type": "string"
},
"retryMessageContent": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
"RatingInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "rating input"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"buttonType": {
"anyOf": [
{
"const": "Icons"
},
{
"const": "Numbers"
}
]
},
"length": {
"type": "number"
},
"startsAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"labels": {
"type": "object",
"properties": {
"left": {
"type": "string"
},
"right": {
"type": "string"
},
"button": {
"type": "string"
}
}
},
"customIcon": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"svg": {
"type": "string"
}
}
},
"isOneClickSubmitEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
"Cards": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "cards"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"options": {
"type": "object",
"properties": {
"displayCondition": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"condition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
}
}
}
},
"internalValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"imageUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"paths": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
}
},
"required": [
"id"
]
}
}
},
"required": [
"id"
]
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"saveResponseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"enum": [
"Image URL",
"Title",
"Description",
"Button",
"Internal Value"
],
"type": "string"
},
"variableId": {
"type": "string"
}
}
}
}
}
}
},
"required": [
"id",
"type",
"items"
]
},
"ChoiceInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"content": {
"type": "string"
},
"value": {
"type": "string"
},
"displayCondition": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"condition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"dynamicVariableId": {
"type": "string"
},
"isSearchable": {
"type": "boolean"
},
"searchInputPlaceholder": {
"type": "string"
},
"areInitialSearchButtonsVisible": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type",
"items"
]
},
"FileInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "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"
},
"success": {
"type": "object",
"properties": {
"single": {
"type": "string"
},
"multiple": {
"type": "string"
}
}
}
}
},
"allowedFileTypes": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"capture": {
"enum": [
"environment",
"user"
],
"type": "string"
},
"visibility": {
"enum": [
"Auto",
"Public",
"Private"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
"PictureChoiceInput": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"picture choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"pictureSrc": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"value": {
"type": "string"
},
"displayCondition": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"condition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"isSearchable": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"searchInputPlaceholder": {
"type": "string"
},
"dynamicItems": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"titlesVariableId": {
"type": "string"
},
"descriptionsVariableId": {
"type": "string"
},
"pictureSrcsVariableId": {
"type": "string"
}
}
}
}
}
},
"required": [
"id",
"type",
"items"
]
},
"Code": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Code"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"content": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"shouldExecuteInParentContext": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
"Redirect": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Redirect"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"isNewTab": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
"SetVariable": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Set variable"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"expressionToEvaluate": {
"type": "string"
},
"isCode": {
"type": "boolean"
},
"expressionDescription": {
"type": "string"
},
"saveErrorInVariableId": {
"type": "string"
},
"type": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/Custom"
},
{
"$ref": "#/components/schemas/Now"
},
{
"$ref": "#/components/schemas/Today"
},
{
"$ref": "#/components/schemas/MapItemWithSameIndex"
},
{
"$ref": "#/components/schemas/AppendValues"
},
{
"$ref": "#/components/schemas/Pop"
}
]
}
},
"required": [
"id",
"type"
]
},
"Custom": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"expressionToEvaluate": {
"type": "string"
},
"isCode": {
"type": "boolean"
},
"expressionDescription": {
"type": "string"
},
"saveErrorInVariableId": {
"type": "string"
},
"type": {
"const": "Custom"
}
},
"required": [
"type"
]
},
"Now": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Now",
"Yesterday",
"Tomorrow"
],
"type": "string"
},
"timeZone": {
"type": "string"
}
},
"required": [
"type"
]
},
"Yesterday": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Now",
"Yesterday",
"Tomorrow"
],
"type": "string"
},
"timeZone": {
"type": "string"
}
},
"required": [
"type"
]
},
"Tomorrow": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Now",
"Yesterday",
"Tomorrow"
],
"type": "string"
},
"timeZone": {
"type": "string"
}
},
"required": [
"type"
]
},
"Today": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Today",
"Moment of the day",
"Empty",
"Environment name",
"User ID",
"Result ID",
"Random ID",
"Phone number",
"Contact name",
"Transcript",
"Referral Click ID",
"Referral Source ID",
"Device type"
],
"type": "string"
}
},
"required": [
"type"
]
},
"MomentOfTheDay": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Today",
"Moment of the day",
"Empty",
"Environment name",
"User ID",
"Result ID",
"Random ID",
"Phone number",
"Contact name",
"Transcript",
"Referral Click ID",
"Referral Source ID",
"Device type"
],
"type": "string"
}
},
"required": [
"type"
]
},
"Empty": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Today",
"Moment of the day",
"Empty",
"Environment name",
"User ID",
"Result ID",
"Random ID",
"Phone number",
"Contact name",
"Transcript",
"Referral Click ID",
"Referral Source ID",
"Device type"
],
"type": "string"
}
},
"required": [
"type"
]
},
"EnvironmentName": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Today",
"Moment of the day",
"Empty",
"Environment name",
"User ID",
"Result ID",
"Random ID",
"Phone number",
"Contact name",
"Transcript",
"Referral Click ID",
"Referral Source ID",
"Device type"
],
"type": "string"
}
},
"required": [
"type"
]
},
"UserId": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Today",
"Moment of the day",
"Empty",
"Environment name",
"User ID",
"Result ID",
"Random ID",
"Phone number",
"Contact name",
"Transcript",
"Referral Click ID",
"Referral Source ID",
"Device type"
],
"type": "string"
}
},
"required": [
"type"
]
},
"ResultId": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Today",
"Moment of the day",
"Empty",
"Environment name",
"User ID",
"Result ID",
"Random ID",
"Phone number",
"Contact name",
"Transcript",
"Referral Click ID",
"Referral Source ID",
"Device type"
],
"type": "string"
}
},
"required": [
"type"
]
},
"RandomId": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Today",
"Moment of the day",
"Empty",
"Environment name",
"User ID",
"Result ID",
"Random ID",
"Phone number",
"Contact name",
"Transcript",
"Referral Click ID",
"Referral Source ID",
"Device type"
],
"type": "string"
}
},
"required": [
"type"
]
},
"PhoneNumber": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Today",
"Moment of the day",
"Empty",
"Environment name",
"User ID",
"Result ID",
"Random ID",
"Phone number",
"Contact name",
"Transcript",
"Referral Click ID",
"Referral Source ID",
"Device type"
],
"type": "string"
}
},
"required": [
"type"
]
},
"ContactName": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Today",
"Moment of the day",
"Empty",
"Environment name",
"User ID",
"Result ID",
"Random ID",
"Phone number",
"Contact name",
"Transcript",
"Referral Click ID",
"Referral Source ID",
"Device type"
],
"type": "string"
}
},
"required": [
"type"
]
},
"Transcript": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Today",
"Moment of the day",
"Empty",
"Environment name",
"User ID",
"Result ID",
"Random ID",
"Phone number",
"Contact name",
"Transcript",
"Referral Click ID",
"Referral Source ID",
"Device type"
],
"type": "string"
}
},
"required": [
"type"
]
},
"ReferralClickId": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Today",
"Moment of the day",
"Empty",
"Environment name",
"User ID",
"Result ID",
"Random ID",
"Phone number",
"Contact name",
"Transcript",
"Referral Click ID",
"Referral Source ID",
"Device type"
],
"type": "string"
}
},
"required": [
"type"
]
},
"ReferralSourceId": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Today",
"Moment of the day",
"Empty",
"Environment name",
"User ID",
"Result ID",
"Random ID",
"Phone number",
"Contact name",
"Transcript",
"Referral Click ID",
"Referral Source ID",
"Device type"
],
"type": "string"
}
},
"required": [
"type"
]
},
"DeviceType": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Today",
"Moment of the day",
"Empty",
"Environment name",
"User ID",
"Result ID",
"Random ID",
"Phone number",
"Contact name",
"Transcript",
"Referral Click ID",
"Referral Source ID",
"Device type"
],
"type": "string"
}
},
"required": [
"type"
]
},
"MapItemWithSameIndex": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"const": "Map item with same index"
},
"mapListItemParams": {
"type": "object",
"properties": {
"baseItemVariableId": {
"type": "string"
},
"baseListVariableId": {
"type": "string"
},
"targetListVariableId": {
"type": "string"
}
}
}
},
"required": [
"type"
]
},
"AppendValues": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"const": "Append value(s)"
},
"item": {
"type": "string"
}
},
"required": [
"type"
]
},
"Pop": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Pop",
"Shift"
],
"type": "string"
},
"saveItemInVariableId": {
"type": "string"
}
},
"required": [
"type"
]
},
"Shift": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isExecutedOnClient": {
"type": "boolean"
},
"isUnsafe": {
"type": "boolean",
"description": "Enabled by default for imported bots to prevent code to be executed in preview with priviledged access"
},
"type": {
"enum": [
"Pop",
"Shift"
],
"type": "string"
},
"saveItemInVariableId": {
"type": "string"
}
},
"required": [
"type"
]
},
"TypebotLink": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Typebot link"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"typebotId": {
"type": "string"
},
"groupId": {
"type": "string"
},
"mergeResults": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
"Wait": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Wait"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"secondsToWaitFor": {
"type": "string"
},
"shouldPause": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
"Jump": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Jump"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
"Return": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Return"
],
"type": "string"
}
},
"required": [
"id",
"type"
]
},
"Condition": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Condition"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"content": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"not": {}
}
},
"required": [
"id",
"type",
"items"
]
},
"AbTest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"AB test"
],
"type": "string"
},
"items": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"path": {
"const": "a"
}
},
"required": [
"id",
"path"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"path": {
"const": "b"
}
},
"required": [
"id",
"path"
]
}
]
},
"options": {
"type": "object",
"properties": {
"aPercent": {
"type": "number",
"minimum": 0,
"maximum": 100
}
}
}
},
"required": [
"id",
"type",
"items"
]
},
"Webhook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"webhook"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
}
}
}
},
"required": [
"id",
"type"
]
},
"Chatwoot": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Chatwoot"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"task": {
"enum": [
"Show widget",
"Close widget"
],
"type": "string"
},
"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"
}
}
}
}
}
},
"required": [
"id",
"type"
]
},
"GoogleAnalytics": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Analytics"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"trackingId": {
"type": "string"
},
"category": {
"type": "string"
},
"action": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"sendTo": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
"Openai": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"OpenAI"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"task": {
"not": {}
},
"credentialsId": {
"type": "string"
},
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
}
}
},
{
"$ref": "#/components/schemas/CreateChatCompletion"
},
{
"$ref": "#/components/schemas/CreateImage"
},
{
"$ref": "#/components/schemas/CreateSpeech"
}
]
}
},
"required": [
"id",
"type"
]
},
"CreateChatCompletion": {
"type": "object",
"properties": {
"task": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"role": {
"enum": [
"system",
"user",
"assistant"
],
"type": "string"
},
"content": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"role": {
"const": "Messages sequence ✨"
},
"content": {
"type": "object",
"properties": {
"assistantMessagesVariableId": {
"type": "string"
},
"userMessagesVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"role"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"role": {
"const": "Dialogue"
},
"dialogueVariableId": {
"type": "string"
},
"startsBy": {
"enum": [
"user",
"assistant"
],
"type": "string"
}
},
"required": [
"id",
"role"
]
}
]
}
},
"advancedSettings": {
"type": "object",
"properties": {
"temperature": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"valueToExtract": {
"enum": [
"Message content",
"Total tokens",
"Prompt tokens",
"Completion tokens"
],
"type": "string"
},
"variableId": {
"type": "string"
}
},
"required": [
"id",
"valueToExtract"
]
}
},
"credentialsId": {
"type": "string"
},
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
}
},
"required": [
"task"
]
},
"CreateImage": {
"type": "object",
"properties": {
"task": {
"const": "Create image"
},
"prompt": {
"type": "string"
},
"advancedOptions": {
"type": "object",
"properties": {
"size": {
"enum": [
"256x256",
"512x512",
"1024x1024"
],
"type": "string"
}
}
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"valueToExtract": {
"enum": [
"Image URL"
],
"type": "string"
},
"variableId": {
"type": "string"
}
},
"required": [
"id",
"valueToExtract"
]
}
},
"credentialsId": {
"type": "string"
},
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
}
},
"required": [
"task",
"advancedOptions",
"responseMapping"
]
},
"CreateSpeech": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"task": {
"const": "Create speech"
},
"model": {
"type": "string"
},
"input": {
"type": "string"
},
"voice": {
"enum": [
"alloy",
"echo",
"fable",
"onyx",
"nova",
"shimmer"
],
"type": "string"
},
"saveUrlInVariableId": {
"type": "string"
}
},
"required": [
"task"
]
},
"Email": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Email"
],
"type": "string"
},
"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": [
"id",
"type"
]
},
"Pixel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Pixel"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/Lead"
},
{
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Custom"
],
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"eventType"
]
}
]
}
},
"required": [
"id",
"type"
]
},
"Lead": {
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Lead",
"Contact",
"CompleteRegistration",
"Schedule",
"SubmitApplication",
"ViewContent",
"AddPaymentInfo",
"AddToCart",
"AddToWishlist",
"CustomizeProduct",
"Donate",
"FindLocation",
"InitiateCheckout",
"Purchase",
"Search",
"StartTrial",
"Subscribe"
],
"type": "string"
}
},
"required": [
"eventType"
]
},
"Contact": {
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Lead",
"Contact",
"CompleteRegistration",
"Schedule",
"SubmitApplication",
"ViewContent",
"AddPaymentInfo",
"AddToCart",
"AddToWishlist",
"CustomizeProduct",
"Donate",
"FindLocation",
"InitiateCheckout",
"Purchase",
"Search",
"StartTrial",
"Subscribe"
],
"type": "string"
}
},
"required": [
"eventType"
]
},
"Completeregistration": {
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Lead",
"Contact",
"CompleteRegistration",
"Schedule",
"SubmitApplication",
"ViewContent",
"AddPaymentInfo",
"AddToCart",
"AddToWishlist",
"CustomizeProduct",
"Donate",
"FindLocation",
"InitiateCheckout",
"Purchase",
"Search",
"StartTrial",
"Subscribe"
],
"type": "string"
}
},
"required": [
"eventType"
]
},
"Schedule": {
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Lead",
"Contact",
"CompleteRegistration",
"Schedule",
"SubmitApplication",
"ViewContent",
"AddPaymentInfo",
"AddToCart",
"AddToWishlist",
"CustomizeProduct",
"Donate",
"FindLocation",
"InitiateCheckout",
"Purchase",
"Search",
"StartTrial",
"Subscribe"
],
"type": "string"
}
},
"required": [
"eventType"
]
},
"Submitapplication": {
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Lead",
"Contact",
"CompleteRegistration",
"Schedule",
"SubmitApplication",
"ViewContent",
"AddPaymentInfo",
"AddToCart",
"AddToWishlist",
"CustomizeProduct",
"Donate",
"FindLocation",
"InitiateCheckout",
"Purchase",
"Search",
"StartTrial",
"Subscribe"
],
"type": "string"
}
},
"required": [
"eventType"
]
},
"Viewcontent": {
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Lead",
"Contact",
"CompleteRegistration",
"Schedule",
"SubmitApplication",
"ViewContent",
"AddPaymentInfo",
"AddToCart",
"AddToWishlist",
"CustomizeProduct",
"Donate",
"FindLocation",
"InitiateCheckout",
"Purchase",
"Search",
"StartTrial",
"Subscribe"
],
"type": "string"
}
},
"required": [
"eventType"
]
},
"Addpaymentinfo": {
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Lead",
"Contact",
"CompleteRegistration",
"Schedule",
"SubmitApplication",
"ViewContent",
"AddPaymentInfo",
"AddToCart",
"AddToWishlist",
"CustomizeProduct",
"Donate",
"FindLocation",
"InitiateCheckout",
"Purchase",
"Search",
"StartTrial",
"Subscribe"
],
"type": "string"
}
},
"required": [
"eventType"
]
},
"Addtocart": {
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Lead",
"Contact",
"CompleteRegistration",
"Schedule",
"SubmitApplication",
"ViewContent",
"AddPaymentInfo",
"AddToCart",
"AddToWishlist",
"CustomizeProduct",
"Donate",
"FindLocation",
"InitiateCheckout",
"Purchase",
"Search",
"StartTrial",
"Subscribe"
],
"type": "string"
}
},
"required": [
"eventType"
]
},
"Addtowishlist": {
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Lead",
"Contact",
"CompleteRegistration",
"Schedule",
"SubmitApplication",
"ViewContent",
"AddPaymentInfo",
"AddToCart",
"AddToWishlist",
"CustomizeProduct",
"Donate",
"FindLocation",
"InitiateCheckout",
"Purchase",
"Search",
"StartTrial",
"Subscribe"
],
"type": "string"
}
},
"required": [
"eventType"
]
},
"Customizeproduct": {
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Lead",
"Contact",
"CompleteRegistration",
"Schedule",
"SubmitApplication",
"ViewContent",
"AddPaymentInfo",
"AddToCart",
"AddToWishlist",
"CustomizeProduct",
"Donate",
"FindLocation",
"InitiateCheckout",
"Purchase",
"Search",
"StartTrial",
"Subscribe"
],
"type": "string"
}
},
"required": [
"eventType"
]
},
"Donate": {
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Lead",
"Contact",
"CompleteRegistration",
"Schedule",
"SubmitApplication",
"ViewContent",
"AddPaymentInfo",
"AddToCart",
"AddToWishlist",
"CustomizeProduct",
"Donate",
"FindLocation",
"InitiateCheckout",
"Purchase",
"Search",
"StartTrial",
"Subscribe"
],
"type": "string"
}
},
"required": [
"eventType"
]
},
"Findlocation": {
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Lead",
"Contact",
"CompleteRegistration",
"Schedule",
"SubmitApplication",
"ViewContent",
"AddPaymentInfo",
"AddToCart",
"AddToWishlist",
"CustomizeProduct",
"Donate",
"FindLocation",
"InitiateCheckout",
"Purchase",
"Search",
"StartTrial",
"Subscribe"
],
"type": "string"
}
},
"required": [
"eventType"
]
},
"Initiatecheckout": {
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Lead",
"Contact",
"CompleteRegistration",
"Schedule",
"SubmitApplication",
"ViewContent",
"AddPaymentInfo",
"AddToCart",
"AddToWishlist",
"CustomizeProduct",
"Donate",
"FindLocation",
"InitiateCheckout",
"Purchase",
"Search",
"StartTrial",
"Subscribe"
],
"type": "string"
}
},
"required": [
"eventType"
]
},
"Purchase": {
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Lead",
"Contact",
"CompleteRegistration",
"Schedule",
"SubmitApplication",
"ViewContent",
"AddPaymentInfo",
"AddToCart",
"AddToWishlist",
"CustomizeProduct",
"Donate",
"FindLocation",
"InitiateCheckout",
"Purchase",
"Search",
"StartTrial",
"Subscribe"
],
"type": "string"
}
},
"required": [
"eventType"
]
},
"Search": {
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Lead",
"Contact",
"CompleteRegistration",
"Schedule",
"SubmitApplication",
"ViewContent",
"AddPaymentInfo",
"AddToCart",
"AddToWishlist",
"CustomizeProduct",
"Donate",
"FindLocation",
"InitiateCheckout",
"Purchase",
"Search",
"StartTrial",
"Subscribe"
],
"type": "string"
}
},
"required": [
"eventType"
]
},
"Starttrial": {
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Lead",
"Contact",
"CompleteRegistration",
"Schedule",
"SubmitApplication",
"ViewContent",
"AddPaymentInfo",
"AddToCart",
"AddToWishlist",
"CustomizeProduct",
"Donate",
"FindLocation",
"InitiateCheckout",
"Purchase",
"Search",
"StartTrial",
"Subscribe"
],
"type": "string"
}
},
"required": [
"eventType"
]
},
"Subscribe": {
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Lead",
"Contact",
"CompleteRegistration",
"Schedule",
"SubmitApplication",
"ViewContent",
"AddPaymentInfo",
"AddToCart",
"AddToWishlist",
"CustomizeProduct",
"Donate",
"FindLocation",
"InitiateCheckout",
"Purchase",
"Search",
"StartTrial",
"Subscribe"
],
"type": "string"
}
},
"required": [
"eventType"
]
},
"GoogleSheets": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Sheets"
],
"type": "string"
},
"options": {
"anyOf": [
{
"$ref": "#/components/schemas/GetDataFromSheet"
},
{
"$ref": "#/components/schemas/InsertARow"
},
{
"$ref": "#/components/schemas/UpdateARow"
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"sheetId": {
"type": "string"
},
"spreadsheetId": {
"type": "string"
},
"action": {
"not": {}
}
}
}
]
}
},
"required": [
"id",
"type"
]
},
"GetDataFromSheet": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"sheetId": {
"type": "string"
},
"spreadsheetId": {
"type": "string"
},
"action": {
"enum": [
"Get data from sheet"
],
"type": "string"
},
"filter": {
"type": "object",
"properties": {
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"column": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
}
}
},
"cellsToExtract": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"id": {
"type": "string"
},
"variableId": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"totalRowsToExtract": {
"enum": [
"All",
"First",
"Last",
"Random"
],
"type": "string"
}
},
"required": [
"action"
]
},
"InsertARow": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"sheetId": {
"type": "string"
},
"spreadsheetId": {
"type": "string"
},
"action": {
"enum": [
"Insert a row"
],
"type": "string"
},
"cellsToInsert": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"value": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"id"
]
}
}
},
"required": [
"action"
]
},
"UpdateARow": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"sheetId": {
"type": "string"
},
"spreadsheetId": {
"type": "string"
},
"action": {
"enum": [
"Update a row"
],
"type": "string"
},
"cellsToUpsert": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"value": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"filter": {
"type": "object",
"properties": {
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"column": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
}
}
}
},
"required": [
"action"
]
},
"Make.com": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Make.com"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
"Pabbly": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Pabbly"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
"Zapier": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Zapier"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
"AskAssistant": {
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Ask Assistant"
},
"assistantId": {
"type": "string"
},
"threadVariableId": {
"type": "string"
},
"message": {
"type": "string"
},
"functions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"code": {
"type": "string"
}
}
}
},
"additionalInstructions": {
"type": "string"
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"enum": [
"Message",
"Thread ID"
],
"type": "string"
},
"variableId": {
"type": "string"
}
}
}
},
"threadId": {
"type": "string"
}
},
"required": [
"action"
]
},
"AskModel": {
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Ask Model"
},
"model": {
"type": "string"
},
"message": {
"type": "string"
},
"instructions": {
"type": "string"
},
"responseIdVariableId": {
"type": "string"
},
"fileSearchVectorStoreIds": {
"type": "array",
"items": {
"type": "string"
}
},
"fileSearchMaxNumResults": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"fileSearchScoreThreshold": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"webSearchEnabled": {
"type": "boolean"
},
"codeInterpreterEnabled": {
"type": "boolean"
},
"functions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "enum"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
}
]
}
},
"code": {
"type": "string"
}
}
}
},
"temperature": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"enum": [
"Message",
"Response ID"
],
"type": "string"
},
"variableId": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
},
"GenerateVariables": {
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Generate variables"
},
"model": {
"type": "string"
},
"prompt": {
"type": "string"
},
"variablesToExtract": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "string"
},
"variableId": {
"type": "string"
},
"description": {
"type": "string"
},
"isRequired": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "number"
},
"variableId": {
"type": "string"
},
"description": {
"type": "string"
},
"isRequired": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "boolean"
},
"variableId": {
"type": "string"
},
"description": {
"type": "string"
},
"isRequired": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "array"
},
"variableId": {
"type": "string"
},
"description": {
"type": "string"
},
"isRequired": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "enum"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"variableId": {
"type": "string"
},
"description": {
"type": "string"
},
"isRequired": {
"type": "boolean"
}
},
"required": [
"type"
]
}
]
}
}
},
"required": [
"action"
]
},
"CreateTranscription": {
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create transcription"
},
"url": {
"type": "string"
},
"model": {
"type": "string"
},
"prompt": {
"type": "string"
},
"transcriptionVariableId": {
"type": "string"
}
},
"required": [
"action"
]
},
"CalCom": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "cal-com"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/BookEvent"
}
]
}
},
"required": [
"id",
"type"
]
},
"BookEvent": {
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Book event"
},
"link": {
"type": "string"
},
"layout": {
"enum": [
"Month",
"Weekly",
"Columns"
],
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"additionalNotes": {
"type": "string"
},
"phone": {
"type": "string"
},
"anyPrefilledInformations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"questionId": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"saveBookedDateInVariableId": {
"type": "string"
}
},
"required": [
"action"
]
},
"ChatNode": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "chat-node"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/SendMessage"
}
]
}
},
"required": [
"id",
"type"
]
},
"SendMessage": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Send Message"
},
"botId": {
"type": "string"
},
"threadId": {
"type": "string"
},
"message": {
"type": "string"
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"enum": [
"Message",
"Thread ID"
],
"type": "string"
},
"variableId": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
},
"QrCode": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "qr-code"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/GenerateAQrCode"
}
]
}
},
"required": [
"id",
"type"
]
},
"GenerateAQrCode": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Generate a QR Code"
},
"data": {
"type": "string"
},
"saveUrlInVariableId": {
"type": "string"
}
},
"required": [
"action"
]
},
"DifyAi": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "dify-ai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/CreateChatMessage"
},
{
"$ref": "#/components/schemas/QueryKnowledgeBase"
}
]
}
},
"required": [
"id",
"type"
]
},
"CreateChatMessage": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create Chat Message"
},
"query": {
"type": "string"
},
"conversationVariableId": {
"type": "string"
},
"user": {
"type": "string"
},
"inputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"enum": [
"Answer",
"Total Tokens",
"Message content",
"Total tokens",
"Prompt tokens",
"Completion tokens"
],
"type": "string"
},
"variableId": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
},
"QueryKnowledgeBase": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Query Knowledge Base"
},
"datasetId": {
"type": "string"
},
"query": {
"type": "string"
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"enum": [
"Retrieved chunks"
],
"type": "string"
},
"variableId": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
},
"Mistral": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "mistral"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"role": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"role": {
"const": "system"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "user"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "assistant"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "Dialogue"
},
"dialogueVariableId": {
"type": "string"
},
"startsBy": {
"enum": [
"user",
"assistant"
],
"type": "string"
}
},
"required": [
"role"
]
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "function"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "enum"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
}
]
}
},
"code": {
"type": "string"
}
},
"required": [
"type"
]
}
]
}
},
"temperature": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"enum": [
"Message content",
"Total tokens",
"Prompt tokens",
"Completion tokens"
],
"type": "string"
},
"variableId": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Generate variables"
},
"model": {
"type": "string"
},
"prompt": {
"type": "string"
},
"variablesToExtract": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "string"
},
"variableId": {
"type": "string"
},
"description": {
"type": "string"
},
"isRequired": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "number"
},
"variableId": {
"type": "string"
},
"description": {
"type": "string"
},
"isRequired": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "boolean"
},
"variableId": {
"type": "string"
},
"description": {
"type": "string"
},
"isRequired": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "array"
},
"variableId": {
"type": "string"
},
"description": {
"type": "string"
},
"isRequired": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "enum"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"variableId": {
"type": "string"
},
"description": {
"type": "string"
},
"isRequired": {
"type": "boolean"
}
},
"required": [
"type"
]
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
"Elevenlabs": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "elevenlabs"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/ConvertTextToSpeech"
}
]
}
},
"required": [
"id",
"type"
]
},
"ConvertTextToSpeech": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Convert text to speech"
},
"text": {
"type": "string"
},
"voiceId": {
"type": "string"
},
"modelId": {
"type": "string"
},
"saveUrlInVariableId": {
"type": "string"
}
},
"required": [
"action"
]
},
"Anthropic": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "anthropic"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create Chat Message"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"role": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"role": {
"const": "user"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "assistant"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "Dialogue"
},
"dialogueVariableId": {
"type": "string"
},
"startsBy": {
"enum": [
"user",
"assistant"
],
"type": "string"
}
},
"required": [
"role"
]
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "function"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "enum"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
}
]
}
},
"code": {
"type": "string"
}
},
"required": [
"type"
]
}
]
}
},
"systemMessage": {
"type": "string"
},
"temperature": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"maxTokens": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"enum": [
"Message content"
],
"type": "string"
},
"variableId": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Generate variables"
},
"model": {
"type": "string"
},
"prompt": {
"type": "string"
},
"variablesToExtract": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "string"
},
"variableId": {
"type": "string"
},
"description": {
"type": "string"
},
"isRequired": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "number"
},
"variableId": {
"type": "string"
},
"description": {
"type": "string"
},
"isRequired": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "boolean"
},
"variableId": {
"type": "string"
},
"description": {
"type": "string"
},
"isRequired": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "array"
},
"variableId": {
"type": "string"
},
"description": {
"type": "string"
},
"isRequired": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "enum"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"variableId": {
"type": "string"
},
"description": {
"type": "string"
},
"isRequired": {
"type": "boolean"
}
},
"required": [
"type"
]
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
"TogetherAi": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "together-ai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"role": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"role": {
"const": "system"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "user"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "assistant"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "Dialogue"
},
"dialogueVariableId": {
"type": "string"
},
"startsBy": {
"enum": [
"user",
"assistant"
],
"type": "string"
}
},
"required": [
"role"
]
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "function"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "enum"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
}
]
}
},
"code": {
"type": "string"
}
},
"required": [
"type"
]
}
]
}
},
"temperature": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"enum": [
"Message content",
"Total tokens",
"Prompt tokens",
"Completion tokens"
],
"type": "string"
},
"variableId": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
"OpenRouter": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "open-router"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"role": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"role": {
"const": "system"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "user"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "assistant"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "Dialogue"
},
"dialogueVariableId": {
"type": "string"
},
"startsBy": {
"enum": [
"user",
"assistant"
],
"type": "string"
}
},
"required": [
"role"
]
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "function"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "enum"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
}
]
}
},
"code": {
"type": "string"
}
},
"required": [
"type"
]
}
]
}
},
"temperature": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"enum": [
"Message content",
"Total tokens",
"Prompt tokens",
"Completion tokens"
],
"type": "string"
},
"variableId": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
"Nocodb": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "nocodb"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/SearchRecords"
},
{
"$ref": "#/components/schemas/CreateRecord"
},
{
"$ref": "#/components/schemas/UpdateExistingRecord"
}
]
}
},
"required": [
"id",
"type"
]
},
"SearchRecords": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Search Records"
},
"tableId": {
"type": "string"
},
"viewId": {
"type": "string"
},
"returnType": {
"enum": [
"All",
"First",
"Last",
"Random"
],
"type": "string"
},
"filter": {
"type": "object",
"properties": {
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"input": {
"type": "string"
},
"operator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Greater than",
"Less than",
"Is set",
"Is empty",
"Starts with",
"Ends with"
],
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"joiner": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"required": [
"comparisons"
]
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fieldName": {
"type": "string"
},
"variableId": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
},
"CreateRecord": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create Record"
},
"tableId": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
},
"UpdateExistingRecord": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Update Existing Record"
},
"tableId": {
"type": "string"
},
"viewId": {
"type": "string"
},
"filter": {
"type": "object",
"properties": {
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"input": {
"type": "string"
},
"operator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Greater than",
"Less than",
"Is set",
"Is empty",
"Starts with",
"Ends with"
],
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"joiner": {
"enum": [
"AND",
"OR"
],
"type": "string"
}
},
"required": [
"comparisons"
]
},
"updates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fieldName": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
},
"Segment": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "segment"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/Alias"
},
{
"$ref": "#/components/schemas/IdentifyUser"
},
{
"$ref": "#/components/schemas/Page"
},
{
"$ref": "#/components/schemas/Track"
}
]
}
},
"required": [
"id",
"type"
]
},
"Alias": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Alias"
},
"userId": {
"type": "string"
},
"previousId": {
"type": "string"
}
},
"required": [
"action"
]
},
"IdentifyUser": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Identify User"
},
"userId": {
"type": "string"
},
"email": {
"type": "string"
},
"traits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
},
"Page": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Page"
},
"userId": {
"type": "string"
},
"name": {
"type": "string"
},
"category": {
"type": "string"
},
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
},
"Track": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Track"
},
"eventName": {
"type": "string"
},
"userId": {
"type": "string"
},
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
},
"Groq": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "groq"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"role": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"role": {
"const": "system"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "user"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "assistant"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "Dialogue"
},
"dialogueVariableId": {
"type": "string"
},
"startsBy": {
"enum": [
"user",
"assistant"
],
"type": "string"
}
},
"required": [
"role"
]
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "function"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "enum"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
}
]
}
},
"code": {
"type": "string"
}
},
"required": [
"type"
]
}
]
}
},
"temperature": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"enum": [
"Message content",
"Total tokens",
"Prompt tokens",
"Completion tokens"
],
"type": "string"
},
"variableId": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
"Zendesk": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "zendesk"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/OpenWebWidget"
}
]
}
},
"required": [
"id",
"type"
]
},
"OpenWebWidget": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Open Web Widget"
},
"userId": {
"type": "string"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"webWidgetKey": {
"type": "string"
}
},
"required": [
"action"
]
},
"Posthog": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "posthog"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/Capture"
},
{
"$ref": "#/components/schemas/IdentifyGroup"
}
]
}
},
"required": [
"id",
"type"
]
},
"Capture": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Capture"
},
"isAnonymous": {
"type": "boolean"
},
"distinctId": {
"type": "string"
},
"event": {
"type": "string"
},
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"personProperties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"key": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
},
"IdentifyGroup": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Identify Group"
},
"distinctId": {
"type": "string"
},
"groupType": {
"type": "string"
},
"groupKey": {
"type": "string"
},
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
},
"Perplexity": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "perplexity"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"role": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"role": {
"const": "system"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "user"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "assistant"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "Dialogue"
},
"dialogueVariableId": {
"type": "string"
},
"startsBy": {
"enum": [
"user",
"assistant"
],
"type": "string"
}
},
"required": [
"role"
]
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "function"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "enum"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
}
]
}
},
"code": {
"type": "string"
}
},
"required": [
"type"
]
}
]
}
},
"temperature": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"enum": [
"Message content",
"Total tokens",
"Prompt tokens",
"Completion tokens"
],
"type": "string"
},
"variableId": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
"Deepseek": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "deepseek"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"role": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"role": {
"const": "system"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "user"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "assistant"
},
"content": {
"type": "string"
}
},
"required": [
"role"
]
},
{
"type": "object",
"properties": {
"role": {
"const": "Dialogue"
},
"dialogueVariableId": {
"type": "string"
},
"startsBy": {
"enum": [
"user",
"assistant"
],
"type": "string"
}
},
"required": [
"role"
]
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "function"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"parameters": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "number"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "boolean"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "enum"
},
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"required": [
"type"
]
}
]
}
},
"code": {
"type": "string"
}
},
"required": [
"type"
]
}
]
}
},
"temperature": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"enum": [
"Message content",
"Total tokens",
"Prompt tokens",
"Completion tokens"
],
"type": "string"
},
"variableId": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
"Blink": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "blink"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/GetUsers"
},
{
"$ref": "#/components/schemas/SendFeedEvent"
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Redirect"
},
"url": {
"type": "string"
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
"GetUsers": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Get Users"
},
"filter": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "User ID"
},
"userId": {
"type": "string"
}
},
"required": [
"type"
]
},
{
"$ref": "#/components/schemas/EmployeeId"
}
]
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"enum": [
"Emails",
"Company Names",
"First Names",
"Second Names",
"Display Names",
"Initials",
"Job Titles",
"Profile Photo IDs",
"Timezones",
"Manager IDs",
"Department Names",
"Account Statuses",
"User IDs",
"Employee IDs"
],
"type": "string"
},
"variableId": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
},
"EmployeeId": {
"type": "object",
"properties": {
"type": {
"const": "Employee ID"
},
"employeeId": {
"type": "string"
}
},
"required": [
"type"
]
},
"SendFeedEvent": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Send Feed Event"
},
"categoryId": {
"type": "string"
},
"ribbonColor": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "Header"
},
"title": {
"type": "string"
},
"iconUrl": {
"type": "string"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "Text"
},
"value": {
"type": "string"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "Labelled Text"
},
"label": {
"type": "string"
},
"value": {
"type": "string"
},
"iconUrl": {
"type": "string"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "Image"
},
"imageUrl": {
"type": "string"
},
"fitImage": {
"type": "boolean"
},
"width": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"height": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "Image gallery"
},
"imageUrls": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "YouTube"
},
"link": {
"type": "string"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "Link"
},
"url": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"imagePlacement": {
"enum": [
"left",
"right",
"top"
],
"type": "string"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "Buttons"
},
"buttons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"clientAction": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"type": {
"const": "Open Link"
},
"url": {
"type": "string"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "Open Webview"
},
"url": {
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"label": {
"type": "string"
},
"iconUrl": {
"type": "string"
}
},
"required": [
"clientAction"
]
}
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "Attachment"
},
"url": {
"type": "string"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "Event"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"start": {
"type": "string"
},
"end": {
"type": "string"
},
"allDay": {
"type": "boolean"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "Horizontal Bar Chart"
},
"total": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"label": {
"type": "string"
}
}
}
}
},
"required": [
"type"
]
}
]
}
},
"allowComments": {
"type": "boolean"
},
"allowReactions": {
"type": "boolean"
},
"userIds": {
"type": "array",
"items": {
"type": "string"
}
},
"groupIds": {
"type": "array",
"items": {
"type": "string"
}
},
"pushNotification": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"text": {
"type": "string"
}
}
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"enum": [
"Event ID"
],
"type": "string"
},
"variableId": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
},
"Gmail": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "gmail"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/SendEmail"
}
]
}
},
"required": [
"id",
"type"
]
},
"SendEmail": {
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Send email"
},
"to": {
"type": "string"
},
"subject": {
"type": "string"
},
"body": {
"type": "string"
},
"attachments": {
"type": "string"
},
"label": {
"type": "string"
},
"from": {
"type": "string"
},
"threadId": {
"type": "string"
},
"replyTo": {
"type": "string"
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {
"enum": [
"Thread ID"
],
"type": "string"
},
"variableId": {
"type": "string"
}
}
}
}
},
"required": [
"action"
]
},
"Google": {
"type": "object",
"properties": {
"type": {
"const": "Google"
},
"family": {
"type": "string"
}
},
"required": [
"type"
]
},
"V3": {
"type": "object",
"properties": {
"version": {
"enum": [
"3",
"4",
"5"
],
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"events": {
"type": "null"
},
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"$ref": "#/components/schemas/Image"
},
{
"$ref": "#/components/schemas/Video"
},
{
"$ref": "#/components/schemas/Embed"
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"$ref": "#/components/schemas/NumberInput"
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"$ref": "#/components/schemas/RatingInput"
},
{
"$ref": "#/components/schemas/Cards"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"content": {
"type": "string"
},
"value": {
"type": "string"
},
"displayCondition": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"condition": {
"type": "object",
"properties": {
"logicalOperator": {},
"comparisons": {}
}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"dynamicVariableId": {
"type": "string"
},
"isSearchable": {
"type": "boolean"
},
"searchInputPlaceholder": {
"type": "string"
},
"areInitialSearchButtonsVisible": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "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"
},
"success": {
"type": "object",
"properties": {
"single": {
"type": "string"
},
"multiple": {
"type": "string"
}
}
}
}
},
"allowedFileTypes": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"capture": {
"enum": [
"environment",
"user"
],
"type": "string"
},
"sizeLimit": {
"type": "number"
},
"visibility": {
"enum": [
"Auto",
"Public",
"Private"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"picture choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"pictureSrc": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"value": {
"type": "string"
},
"displayCondition": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"condition": {
"type": "object",
"properties": {
"logicalOperator": {},
"comparisons": {}
}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"isSearchable": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"searchInputPlaceholder": {
"type": "string"
},
"dynamicItems": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"titlesVariableId": {
"type": "string"
},
"descriptionsVariableId": {
"type": "string"
},
"pictureSrcsVariableId": {
"type": "string"
}
}
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Condition"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"content": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"not": {}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"AB test"
],
"type": "string"
},
"items": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"path": {
"const": "a"
}
},
"required": [
"id",
"path"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"path": {
"const": "b"
}
},
"required": [
"id",
"path"
]
}
]
},
"options": {
"type": "object",
"properties": {
"aPercent": {
"type": "number",
"minimum": 0,
"maximum": 100
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"$ref": "#/components/schemas/GoogleAnalytics"
},
{
"$ref": "#/components/schemas/Openai"
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Sheets"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"sheetId": {
"type": "string"
},
"spreadsheetId": {
"type": "string"
},
"action": {
"enum": [
"Get data from sheet"
],
"type": "string"
},
"referenceCell": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"value": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"id"
]
},
"filter": {
"type": "object",
"properties": {
"comparisons": {
"type": "array",
"items": {}
},
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
}
}
},
"cellsToExtract": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {},
"id": {},
"variableId": {}
}
}
},
"totalRowsToExtract": {
"enum": [
"All",
"First",
"Last",
"Random"
],
"type": "string"
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/InsertARow"
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"sheetId": {
"type": "string"
},
"spreadsheetId": {
"type": "string"
},
"action": {
"enum": [
"Update a row"
],
"type": "string"
},
"cellsToUpsert": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {},
"value": {},
"id": {}
}
}
},
"referenceCell": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"value": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"id"
]
},
"filter": {
"type": "object",
"properties": {
"comparisons": {
"type": "array",
"items": {}
},
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
}
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"sheetId": {
"type": "string"
},
"spreadsheetId": {
"type": "string"
},
"action": {
"not": {}
}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Make.com"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"id"
]
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Pabbly"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"id"
]
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"id"
]
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Zapier"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"id"
]
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"selectedThemeTemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"startCondition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
},
"required": [
"comparisons"
]
},
"sessionExpiryTimeout": {
"type": "number",
"minimum": 0.01,
"maximum": 48,
"description": "Expiration delay in hours after latest interaction"
},
"errorAndMarketingStatusWebhookForwardUrl": {
"type": "string",
"format": "uri"
},
"isWebhookForwardingEnabled": {
"type": "boolean"
},
"webhookForwardingEventTypes": {
"type": "array",
"items": {
"enum": [
"all",
"errorStatuses",
"marketingStatuses"
],
"type": "string"
}
}
}
},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publicId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customDomain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"resultsTablePreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"columnsOrder": {
"type": "array",
"items": {
"type": "string"
}
},
"columnsVisibility": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
"columnsWidth": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"columnsOrder",
"columnsVisibility",
"columnsWidth"
]
},
{
"type": "null"
}
]
},
"isArchived": {
"type": "boolean"
},
"isClosed": {
"type": "boolean"
},
"whatsAppCredentialsId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"riskLevel": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"spaceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"version",
"id",
"name",
"events",
"groups",
"edges",
"variables",
"theme",
"selectedThemeTemplateId",
"settings",
"createdAt",
"updatedAt",
"icon",
"folderId",
"publicId",
"customDomain",
"workspaceId",
"resultsTablePreferences",
"isArchived",
"isClosed",
"whatsAppCredentialsId",
"riskLevel",
"spaceId"
]
},
"V4": {
"type": "object",
"properties": {
"version": {
"enum": [
"3",
"4",
"5"
],
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"events": {
"type": "null"
},
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"$ref": "#/components/schemas/Image"
},
{
"$ref": "#/components/schemas/Video"
},
{
"$ref": "#/components/schemas/Embed"
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"$ref": "#/components/schemas/NumberInput"
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"$ref": "#/components/schemas/RatingInput"
},
{
"$ref": "#/components/schemas/Cards"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"content": {
"type": "string"
},
"value": {
"type": "string"
},
"displayCondition": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"condition": {
"type": "object",
"properties": {
"logicalOperator": {},
"comparisons": {}
}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"dynamicVariableId": {
"type": "string"
},
"isSearchable": {
"type": "boolean"
},
"searchInputPlaceholder": {
"type": "string"
},
"areInitialSearchButtonsVisible": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "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"
},
"success": {
"type": "object",
"properties": {
"single": {
"type": "string"
},
"multiple": {
"type": "string"
}
}
}
}
},
"allowedFileTypes": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"capture": {
"enum": [
"environment",
"user"
],
"type": "string"
},
"sizeLimit": {
"type": "number"
},
"visibility": {
"enum": [
"Auto",
"Public",
"Private"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"picture choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"pictureSrc": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"value": {
"type": "string"
},
"displayCondition": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"condition": {
"type": "object",
"properties": {
"logicalOperator": {},
"comparisons": {}
}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"isSearchable": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"searchInputPlaceholder": {
"type": "string"
},
"dynamicItems": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"titlesVariableId": {
"type": "string"
},
"descriptionsVariableId": {
"type": "string"
},
"pictureSrcsVariableId": {
"type": "string"
}
}
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Condition"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"content": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"not": {}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"AB test"
],
"type": "string"
},
"items": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"path": {
"const": "a"
}
},
"required": [
"id",
"path"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"path": {
"const": "b"
}
},
"required": [
"id",
"path"
]
}
]
},
"options": {
"type": "object",
"properties": {
"aPercent": {
"type": "number",
"minimum": 0,
"maximum": 100
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"$ref": "#/components/schemas/GoogleAnalytics"
},
{
"$ref": "#/components/schemas/Openai"
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Sheets"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"sheetId": {
"type": "string"
},
"spreadsheetId": {
"type": "string"
},
"action": {
"enum": [
"Get data from sheet"
],
"type": "string"
},
"referenceCell": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"value": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"id"
]
},
"filter": {
"type": "object",
"properties": {
"comparisons": {
"type": "array",
"items": {}
},
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
}
}
},
"cellsToExtract": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {},
"id": {},
"variableId": {}
}
}
},
"totalRowsToExtract": {
"enum": [
"All",
"First",
"Last",
"Random"
],
"type": "string"
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/InsertARow"
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"sheetId": {
"type": "string"
},
"spreadsheetId": {
"type": "string"
},
"action": {
"enum": [
"Update a row"
],
"type": "string"
},
"cellsToUpsert": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {},
"value": {},
"id": {}
}
}
},
"referenceCell": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"value": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"id"
]
},
"filter": {
"type": "object",
"properties": {
"comparisons": {
"type": "array",
"items": {}
},
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
}
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"sheetId": {
"type": "string"
},
"spreadsheetId": {
"type": "string"
},
"action": {
"not": {}
}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Make.com"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"id"
]
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Pabbly"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"id"
]
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"id"
]
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Zapier"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"id"
]
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"selectedThemeTemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"startCondition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
},
"required": [
"comparisons"
]
},
"sessionExpiryTimeout": {
"type": "number",
"minimum": 0.01,
"maximum": 48,
"description": "Expiration delay in hours after latest interaction"
},
"errorAndMarketingStatusWebhookForwardUrl": {
"type": "string",
"format": "uri"
},
"isWebhookForwardingEnabled": {
"type": "boolean"
},
"webhookForwardingEventTypes": {
"type": "array",
"items": {
"enum": [
"all",
"errorStatuses",
"marketingStatuses"
],
"type": "string"
}
}
}
},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publicId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customDomain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"resultsTablePreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"columnsOrder": {
"type": "array",
"items": {
"type": "string"
}
},
"columnsVisibility": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
"columnsWidth": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"columnsOrder",
"columnsVisibility",
"columnsWidth"
]
},
{
"type": "null"
}
]
},
"isArchived": {
"type": "boolean"
},
"isClosed": {
"type": "boolean"
},
"whatsAppCredentialsId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"riskLevel": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"spaceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"version",
"id",
"name",
"events",
"groups",
"edges",
"variables",
"theme",
"selectedThemeTemplateId",
"settings",
"createdAt",
"updatedAt",
"icon",
"folderId",
"publicId",
"customDomain",
"workspaceId",
"resultsTablePreferences",
"isArchived",
"isClosed",
"whatsAppCredentialsId",
"riskLevel",
"spaceId"
]
},
"V5": {
"type": "object",
"properties": {
"version": {
"enum": [
"3",
"4",
"5"
],
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"events": {
"type": "null"
},
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"$ref": "#/components/schemas/Image"
},
{
"$ref": "#/components/schemas/Video"
},
{
"$ref": "#/components/schemas/Embed"
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"$ref": "#/components/schemas/NumberInput"
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"$ref": "#/components/schemas/RatingInput"
},
{
"$ref": "#/components/schemas/Cards"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"content": {
"type": "string"
},
"value": {
"type": "string"
},
"displayCondition": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"condition": {
"type": "object",
"properties": {
"logicalOperator": {},
"comparisons": {}
}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"dynamicVariableId": {
"type": "string"
},
"isSearchable": {
"type": "boolean"
},
"searchInputPlaceholder": {
"type": "string"
},
"areInitialSearchButtonsVisible": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "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"
},
"success": {
"type": "object",
"properties": {
"single": {
"type": "string"
},
"multiple": {
"type": "string"
}
}
}
}
},
"allowedFileTypes": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"capture": {
"enum": [
"environment",
"user"
],
"type": "string"
},
"sizeLimit": {
"type": "number"
},
"visibility": {
"enum": [
"Auto",
"Public",
"Private"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"picture choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"pictureSrc": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"value": {
"type": "string"
},
"displayCondition": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"condition": {
"type": "object",
"properties": {
"logicalOperator": {},
"comparisons": {}
}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"isSearchable": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"searchInputPlaceholder": {
"type": "string"
},
"dynamicItems": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"titlesVariableId": {
"type": "string"
},
"descriptionsVariableId": {
"type": "string"
},
"pictureSrcsVariableId": {
"type": "string"
}
}
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Condition"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"content": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"not": {}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"AB test"
],
"type": "string"
},
"items": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"path": {
"const": "a"
}
},
"required": [
"id",
"path"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"path": {
"const": "b"
}
},
"required": [
"id",
"path"
]
}
]
},
"options": {
"type": "object",
"properties": {
"aPercent": {
"type": "number",
"minimum": 0,
"maximum": 100
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"$ref": "#/components/schemas/GoogleAnalytics"
},
{
"$ref": "#/components/schemas/Openai"
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Sheets"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"sheetId": {
"type": "string"
},
"spreadsheetId": {
"type": "string"
},
"action": {
"enum": [
"Get data from sheet"
],
"type": "string"
},
"referenceCell": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"value": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"id"
]
},
"filter": {
"type": "object",
"properties": {
"comparisons": {
"type": "array",
"items": {}
},
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
}
}
},
"cellsToExtract": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {},
"id": {},
"variableId": {}
}
}
},
"totalRowsToExtract": {
"enum": [
"All",
"First",
"Last",
"Random"
],
"type": "string"
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/InsertARow"
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"sheetId": {
"type": "string"
},
"spreadsheetId": {
"type": "string"
},
"action": {
"enum": [
"Update a row"
],
"type": "string"
},
"cellsToUpsert": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {},
"value": {},
"id": {}
}
}
},
"referenceCell": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"value": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"id"
]
},
"filter": {
"type": "object",
"properties": {
"comparisons": {
"type": "array",
"items": {}
},
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
}
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"sheetId": {
"type": "string"
},
"spreadsheetId": {
"type": "string"
},
"action": {
"not": {}
}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Make.com"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"id"
]
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Pabbly"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"id"
]
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"id"
]
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Zapier"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"id"
]
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"selectedThemeTemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"startCondition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
},
"required": [
"comparisons"
]
},
"sessionExpiryTimeout": {
"type": "number",
"minimum": 0.01,
"maximum": 48,
"description": "Expiration delay in hours after latest interaction"
},
"errorAndMarketingStatusWebhookForwardUrl": {
"type": "string",
"format": "uri"
},
"isWebhookForwardingEnabled": {
"type": "boolean"
},
"webhookForwardingEventTypes": {
"type": "array",
"items": {
"enum": [
"all",
"errorStatuses",
"marketingStatuses"
],
"type": "string"
}
}
}
},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publicId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customDomain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"resultsTablePreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"columnsOrder": {
"type": "array",
"items": {
"type": "string"
}
},
"columnsVisibility": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
"columnsWidth": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"columnsOrder",
"columnsVisibility",
"columnsWidth"
]
},
{
"type": "null"
}
]
},
"isArchived": {
"type": "boolean"
},
"isClosed": {
"type": "boolean"
},
"whatsAppCredentialsId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"riskLevel": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"spaceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"version",
"id",
"name",
"events",
"groups",
"edges",
"variables",
"theme",
"selectedThemeTemplateId",
"settings",
"createdAt",
"updatedAt",
"icon",
"folderId",
"publicId",
"customDomain",
"workspaceId",
"resultsTablePreferences",
"isArchived",
"isClosed",
"whatsAppCredentialsId",
"riskLevel",
"spaceId"
]
},
"PublicTypebotV5": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"version": {
"enum": [
"3",
"4",
"5"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"lastActivityAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"typebotId": {
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"$ref": "#/components/schemas/Image"
},
{
"$ref": "#/components/schemas/Video"
},
{
"$ref": "#/components/schemas/Embed"
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"$ref": "#/components/schemas/NumberInput"
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"$ref": "#/components/schemas/RatingInput"
},
{
"$ref": "#/components/schemas/Cards"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"content": {
"type": "string"
},
"value": {
"type": "string"
},
"displayCondition": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"condition": {
"type": "object",
"properties": {
"logicalOperator": {},
"comparisons": {}
}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"dynamicVariableId": {
"type": "string"
},
"isSearchable": {
"type": "boolean"
},
"searchInputPlaceholder": {
"type": "string"
},
"areInitialSearchButtonsVisible": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "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"
},
"success": {
"type": "object",
"properties": {
"single": {
"type": "string"
},
"multiple": {
"type": "string"
}
}
}
}
},
"allowedFileTypes": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"capture": {
"enum": [
"environment",
"user"
],
"type": "string"
},
"sizeLimit": {
"type": "number"
},
"visibility": {
"enum": [
"Auto",
"Public",
"Private"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"picture choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"pictureSrc": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"value": {
"type": "string"
},
"displayCondition": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"condition": {
"type": "object",
"properties": {
"logicalOperator": {},
"comparisons": {}
}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"isSearchable": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"searchInputPlaceholder": {
"type": "string"
},
"dynamicItems": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"titlesVariableId": {
"type": "string"
},
"descriptionsVariableId": {
"type": "string"
},
"pictureSrcsVariableId": {
"type": "string"
}
}
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Condition"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"content": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"not": {}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"AB test"
],
"type": "string"
},
"items": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"path": {
"const": "a"
}
},
"required": [
"id",
"path"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"path": {
"const": "b"
}
},
"required": [
"id",
"path"
]
}
]
},
"options": {
"type": "object",
"properties": {
"aPercent": {
"type": "number",
"minimum": 0,
"maximum": 100
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"$ref": "#/components/schemas/GoogleAnalytics"
},
{
"$ref": "#/components/schemas/Openai"
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Sheets"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"sheetId": {
"type": "string"
},
"spreadsheetId": {
"type": "string"
},
"action": {
"enum": [
"Get data from sheet"
],
"type": "string"
},
"referenceCell": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"value": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"id"
]
},
"filter": {
"type": "object",
"properties": {
"comparisons": {
"type": "array",
"items": {}
},
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
}
}
},
"cellsToExtract": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {},
"id": {},
"variableId": {}
}
}
},
"totalRowsToExtract": {
"enum": [
"All",
"First",
"Last",
"Random"
],
"type": "string"
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/InsertARow"
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"sheetId": {
"type": "string"
},
"spreadsheetId": {
"type": "string"
},
"action": {
"enum": [
"Update a row"
],
"type": "string"
},
"cellsToUpsert": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {},
"value": {},
"id": {}
}
}
},
"referenceCell": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"value": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"id"
]
},
"filter": {
"type": "object",
"properties": {
"comparisons": {
"type": "array",
"items": {}
},
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
}
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"sheetId": {
"type": "string"
},
"spreadsheetId": {
"type": "string"
},
"action": {
"not": {}
}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Make.com"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"id"
]
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Pabbly"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"id"
]
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"id"
]
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Zapier"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
},
"required": [
"id"
]
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"events": {
"type": "null"
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"startCondition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
},
"required": [
"comparisons"
]
},
"sessionExpiryTimeout": {
"type": "number",
"minimum": 0.01,
"maximum": 48,
"description": "Expiration delay in hours after latest interaction"
},
"errorAndMarketingStatusWebhookForwardUrl": {
"type": "string",
"format": "uri"
},
"isWebhookForwardingEnabled": {
"type": "boolean"
},
"webhookForwardingEventTypes": {
"type": "array",
"items": {
"enum": [
"all",
"errorStatuses",
"marketingStatuses"
],
"type": "string"
}
}
}
},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"required": [
"id",
"version",
"createdAt",
"updatedAt",
"typebotId",
"groups",
"events",
"edges",
"variables",
"theme",
"settings"
]
},
"PublicTypebotV6": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"version": {
"enum": [
"6",
"6.1"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"lastActivityAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"typebotId": {
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"$ref": "#/components/schemas/Image"
},
{
"$ref": "#/components/schemas/Video"
},
{
"$ref": "#/components/schemas/Embed"
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"$ref": "#/components/schemas/NumberInput"
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"$ref": "#/components/schemas/RatingInput"
},
{
"$ref": "#/components/schemas/Cards"
},
{
"$ref": "#/components/schemas/ChoiceInput"
},
{
"$ref": "#/components/schemas/FileInput"
},
{
"$ref": "#/components/schemas/PictureChoiceInput"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"$ref": "#/components/schemas/Condition"
},
{
"$ref": "#/components/schemas/AbTest"
},
{
"$ref": "#/components/schemas/Webhook"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"$ref": "#/components/schemas/GoogleAnalytics"
},
{
"$ref": "#/components/schemas/Openai"
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"$ref": "#/components/schemas/GoogleSheets"
},
{
"$ref": "#/components/schemas/Make.com"
},
{
"$ref": "#/components/schemas/Pabbly"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"variableId": {
"type": "string"
},
"bodyPath": {
"type": "string"
}
},
"required": [
"id"
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"queryParams": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"key": {},
"value": {}
}
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zapier"
}
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "openai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{},
{},
{},
{}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{}
]
}
},
"temperature": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"responseMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item": {},
"variableId": {}
}
}
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/AskAssistant"
},
{
"$ref": "#/components/schemas/AskModel"
},
{
"$ref": "#/components/schemas/GenerateVariables"
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create speech"
},
"model": {
"type": "string"
},
"input": {
"type": "string"
},
"instructions": {
"type": "string"
},
"voice": {
"enum": [
"alloy",
"echo",
"fable",
"onyx",
"nova",
"shimmer"
],
"type": "string"
},
"saveUrlInVariableId": {
"type": "string"
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/CreateTranscription"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/CalCom"
},
{
"$ref": "#/components/schemas/ChatNode"
},
{
"$ref": "#/components/schemas/QrCode"
},
{
"$ref": "#/components/schemas/DifyAi"
},
{
"$ref": "#/components/schemas/Mistral"
},
{
"$ref": "#/components/schemas/Elevenlabs"
},
{
"$ref": "#/components/schemas/Anthropic"
},
{
"$ref": "#/components/schemas/TogetherAi"
},
{
"$ref": "#/components/schemas/OpenRouter"
},
{
"$ref": "#/components/schemas/Nocodb"
},
{
"$ref": "#/components/schemas/Segment"
},
{
"$ref": "#/components/schemas/Groq"
},
{
"$ref": "#/components/schemas/Zendesk"
},
{
"$ref": "#/components/schemas/Posthog"
},
{
"$ref": "#/components/schemas/Perplexity"
},
{
"$ref": "#/components/schemas/Deepseek"
},
{
"$ref": "#/components/schemas/Blink"
},
{
"$ref": "#/components/schemas/Gmail"
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"events": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "start"
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
],
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "command"
},
"options": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"resumeAfter": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "reply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "invalidReply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"startCondition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
},
"required": [
"comparisons"
]
},
"sessionExpiryTimeout": {
"type": "number",
"minimum": 0.01,
"maximum": 48,
"description": "Expiration delay in hours after latest interaction"
},
"errorAndMarketingStatusWebhookForwardUrl": {
"type": "string",
"format": "uri"
},
"isWebhookForwardingEnabled": {
"type": "boolean"
},
"webhookForwardingEventTypes": {
"type": "array",
"items": {
"enum": [
"all",
"errorStatuses",
"marketingStatuses"
],
"type": "string"
}
}
}
},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"required": [
"id",
"version",
"createdAt",
"updatedAt",
"typebotId",
"groups",
"events",
"edges",
"variables",
"theme",
"settings"
]
}
}
},
"openapi": "3.1.1",
"paths": {
"/v1/typebots/{typebotId}/linkedTypebots": {
"get": {
"operationId": "getLinkedTypebots",
"summary": "Get linked typebots",
"tags": [
"Typebot"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"typebots": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"version": {
"enum": [
"3",
"4",
"5"
],
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"text"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"html": {},
"richText": {},
"plainText": {}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Image"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"video"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {},
"id": {},
"type": {},
"height": {},
"aspectRatio": {},
"maxWidth": {},
"queryParamsStr": {},
"areControlsDisplayed": {},
"isAutoplayEnabled": {}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"embed"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {},
"height": {},
"waitForEvent": {}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"number input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {},
"labels": {},
"min": {},
"max": {},
"step": {},
"locale": {},
"style": {},
"currency": {},
"unit": {}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "rating input"
},
"options": {
"type": "object",
"properties": {
"variableId": {},
"buttonType": {},
"length": {},
"startsAt": {},
"labels": {},
"customIcon": {},
"isOneClickSubmitEnabled": {}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Cards"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"options": {
"type": "object",
"properties": {
"variableId": {},
"isMultipleChoice": {},
"buttonLabel": {},
"dynamicVariableId": {},
"isSearchable": {},
"searchInputPlaceholder": {},
"areInitialSearchButtonsVisible": {}
}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "file input"
},
"options": {
"type": "object",
"properties": {
"variableId": {},
"isRequired": {},
"isMultipleAllowed": {},
"labels": {},
"allowedFileTypes": {},
"capture": {},
"sizeLimit": {},
"visibility": {}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"picture choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"options": {
"type": "object",
"properties": {
"variableId": {},
"isMultipleChoice": {},
"isSearchable": {},
"buttonLabel": {},
"searchInputPlaceholder": {},
"dynamicItems": {}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Condition"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"options": {
"not": {}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"AB test"
],
"type": "string"
},
"items": {
"type": "array",
"prefixItems": [
{
"anyOf": [
{},
{
"type": "null"
}
]
},
{
"anyOf": [
{},
{
"type": "null"
}
]
}
]
},
"options": {
"type": "object",
"properties": {
"aPercent": {}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Analytics"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"trackingId": {},
"category": {},
"action": {},
"label": {},
"value": {},
"sendTo": {}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"OpenAI"
],
"type": "string"
},
"options": {
"anyOf": [
{},
{},
{},
{}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Sheets"
],
"type": "string"
},
"options": {
"anyOf": [
{},
{},
{},
{}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Make.com"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {},
"responseVariableMapping": {},
"isCustomBody": {},
"isExecutedOnClient": {},
"webhook": {},
"timeout": {},
"proxyCredentialsId": {}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Pabbly"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {},
"responseVariableMapping": {},
"isCustomBody": {},
"isExecutedOnClient": {},
"webhook": {},
"timeout": {},
"proxyCredentialsId": {}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {},
"responseVariableMapping": {},
"isCustomBody": {},
"isExecutedOnClient": {},
"webhook": {},
"timeout": {},
"proxyCredentialsId": {}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Zapier"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {},
"responseVariableMapping": {},
"isCustomBody": {},
"isExecutedOnClient": {},
"webhook": {},
"timeout": {},
"proxyCredentialsId": {}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"name": {
"type": "string"
}
},
"required": [
"version",
"groups",
"variables",
"name"
]
},
{
"type": "object",
"properties": {
"version": {
"enum": [
"6",
"6.1"
],
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"text"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"html": {},
"richText": {},
"plainText": {}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Image"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"video"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {},
"id": {},
"type": {},
"height": {},
"aspectRatio": {},
"maxWidth": {},
"queryParamsStr": {},
"areControlsDisplayed": {},
"isAutoplayEnabled": {}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"embed"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {},
"height": {},
"waitForEvent": {}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"number input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {},
"labels": {},
"min": {},
"max": {},
"step": {},
"locale": {},
"style": {},
"currency": {},
"unit": {}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "rating input"
},
"options": {
"type": "object",
"properties": {
"variableId": {},
"buttonType": {},
"length": {},
"startsAt": {},
"labels": {},
"customIcon": {},
"isOneClickSubmitEnabled": {}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Cards"
},
{
"$ref": "#/components/schemas/ChoiceInput"
},
{
"$ref": "#/components/schemas/FileInput"
},
{
"$ref": "#/components/schemas/PictureChoiceInput"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"$ref": "#/components/schemas/Condition"
},
{
"$ref": "#/components/schemas/AbTest"
},
{
"$ref": "#/components/schemas/Webhook"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Analytics"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"trackingId": {},
"category": {},
"action": {},
"label": {},
"value": {},
"sendTo": {}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"OpenAI"
],
"type": "string"
},
"options": {
"anyOf": [
{},
{},
{},
{}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"$ref": "#/components/schemas/GoogleSheets"
},
{
"$ref": "#/components/schemas/Make.com"
},
{
"$ref": "#/components/schemas/Pabbly"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {},
"responseVariableMapping": {},
"isCustomBody": {},
"isExecutedOnClient": {},
"webhook": {},
"timeout": {},
"proxyCredentialsId": {}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zapier"
}
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "openai"
},
"options": {
"anyOf": [
{},
{},
{},
{},
{},
{},
{}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/CalCom"
},
{
"$ref": "#/components/schemas/ChatNode"
},
{
"$ref": "#/components/schemas/QrCode"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "dify-ai"
},
"options": {
"anyOf": [
{},
{},
{}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "mistral"
},
"options": {
"anyOf": [
{},
{},
{}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Elevenlabs"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "anthropic"
},
"options": {
"anyOf": [
{},
{},
{}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "together-ai"
},
"options": {
"anyOf": [
{},
{}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "open-router"
},
"options": {
"anyOf": [
{},
{}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Nocodb"
},
{
"$ref": "#/components/schemas/Segment"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "groq"
},
"options": {
"anyOf": [
{},
{}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zendesk"
},
{
"$ref": "#/components/schemas/Posthog"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "perplexity"
},
"options": {
"anyOf": [
{},
{}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "deepseek"
},
"options": {
"anyOf": [
{},
{}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "blink"
},
"options": {
"anyOf": [
{},
{},
{},
{}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Gmail"
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"name": {
"type": "string"
}
},
"required": [
"version",
"groups",
"variables",
"name"
]
}
]
}
}
},
"required": [
"typebots"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots/{typebotId}/analytics/inDepthData": {
"get": {
"operationId": "analytics-getInDepthAnalyticsData",
"summary": "List total answers in blocks and off-default paths visited edges",
"tags": [
"Analytics"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "timeFilter",
"in": "query",
"required": false,
"schema": {
"enum": [
"today",
"last7Days",
"last30Days",
"monthToDate",
"lastMonth",
"yearToDate",
"allTime"
],
"type": "string",
"default": "last7Days"
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "timeZone",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"totalAnswers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"total": {
"type": "number"
}
},
"required": [
"blockId",
"total"
]
}
},
"offDefaultPathVisitedEdges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"total": {
"type": "number"
},
"to": {
"anyOf": [
{
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"total",
"to"
]
}
}
},
"required": [
"totalAnswers",
"offDefaultPathVisitedEdges"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots/{typebotId}/analytics/stats": {
"get": {
"operationId": "analytics-getStats",
"summary": "Get results stats",
"tags": [
"Analytics"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "timeFilter",
"in": "query",
"required": false,
"schema": {
"enum": [
"today",
"last7Days",
"last30Days",
"monthToDate",
"lastMonth",
"yearToDate",
"allTime"
],
"type": "string",
"default": "last7Days"
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "timeZone",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"stats": {
"type": "object",
"properties": {
"totalViews": {
"type": "number"
},
"totalStarts": {
"type": "number"
},
"totalCompleted": {
"type": "number"
}
},
"required": [
"totalViews",
"totalStarts",
"totalCompleted"
]
}
},
"required": [
"stats"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/workspaces/{workspaceId}/spaces/{spaceId}": {
"patch": {
"operationId": "spaces.patch",
"summary": "Update a space",
"tags": [
"Space"
],
"parameters": [
{
"name": "workspaceId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"allOf": [
{
"minLength": 1
}
]
}
},
{
"name": "spaceId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"allOf": [
{
"minLength": 1
}
]
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"anyOf": [
{
"type": "string",
"allOf": [
{
"minLength": 1
}
]
},
{
"type": "null"
}
]
},
"icon": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "string"
}
]
},
{
"type": "null"
}
]
},
{
"type": "null"
}
]
}
},
"required": [],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"anyOf": [
{},
{
"not": {}
}
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/workspaces": {
"get": {
"operationId": "workspace-listWorkspaces",
"summary": "List workspaces",
"tags": [
"Workspace"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"workspaces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"plan": {
"enum": [
"FREE",
"STARTER",
"PRO",
"LIFETIME",
"OFFERED",
"CUSTOM",
"UNLIMITED",
"ENTERPRISE"
],
"type": "string"
}
},
"required": [
"id",
"name",
"icon",
"plan"
]
}
}
},
"required": [
"workspaces"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
},
"post": {
"operationId": "workspace-createWorkspace",
"summary": "Create workspace",
"tags": [
"Workspace"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"icon": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"name"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"name": {
"type": "string"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"plan": {
"enum": [
"FREE",
"STARTER",
"PRO",
"LIFETIME",
"OFFERED",
"CUSTOM",
"UNLIMITED",
"ENTERPRISE"
],
"type": "string"
},
"stripeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"settings": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"isSuspended": {
"type": "boolean"
},
"isPastDue": {
"type": "boolean"
},
"isVerified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"chatsHardLimit": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastActivityAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"inactiveFirstEmailSentAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"inactiveSecondEmailSentAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"createdAt",
"updatedAt",
"name",
"icon",
"plan",
"stripeId",
"settings",
"isSuspended",
"isPastDue",
"isVerified",
"chatsHardLimit",
"lastActivityAt",
"inactiveFirstEmailSentAt",
"inactiveSecondEmailSentAt"
]
}
},
"required": [
"workspace"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/workspaces/{workspaceId}": {
"get": {
"operationId": "workspace-getWorkspace",
"summary": "Get workspace",
"tags": [
"Workspace"
],
"parameters": [
{
"name": "workspaceId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"name": {
"type": "string"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"plan": {
"enum": [
"FREE",
"STARTER",
"PRO",
"LIFETIME",
"OFFERED",
"CUSTOM",
"UNLIMITED",
"ENTERPRISE"
],
"type": "string"
},
"stripeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"settings": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"customChatsLimit": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"customSeatsLimit": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"isSuspended": {
"type": "boolean"
},
"isPastDue": {
"type": "boolean"
},
"isVerified": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"chatsHardLimit": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"lastActivityAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"inactiveFirstEmailSentAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"inactiveSecondEmailSentAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"createdAt",
"updatedAt",
"name",
"icon",
"plan",
"stripeId",
"settings",
"customChatsLimit",
"customSeatsLimit",
"isSuspended",
"isPastDue",
"isVerified",
"chatsHardLimit",
"lastActivityAt",
"inactiveFirstEmailSentAt",
"inactiveSecondEmailSentAt"
]
},
"currentUserMode": {
"enum": [
"read",
"write",
"guest"
],
"type": "string"
}
},
"required": [
"workspace",
"currentUserMode"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
},
"patch": {
"operationId": "workspace-updateWorkspace",
"summary": "Update workspace",
"tags": [
"Workspace"
],
"parameters": [
{
"name": "workspaceId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"icon": {
"type": "string"
}
},
"required": []
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"workspace": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"icon"
]
}
},
"required": [
"workspace"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
},
"delete": {
"operationId": "workspace-deleteWorkspace",
"summary": "Delete workspace",
"tags": [
"Workspace"
],
"parameters": [
{
"name": "workspaceId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"required": []
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/workspaces/{workspaceId}/members": {
"get": {
"operationId": "workspace-listMembersInWorkspace",
"summary": "List members in workspace",
"tags": [
"Workspace"
],
"parameters": [
{
"name": "workspaceId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string"
},
"userId": {
"type": "string"
},
"user": {
"type": "object",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"email",
"image"
]
},
"role": {
"enum": [
"ADMIN",
"MEMBER",
"GUEST"
],
"type": "string"
}
},
"required": [
"workspaceId",
"userId",
"user",
"role"
]
}
}
},
"required": [
"members"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/workspaces/{workspaceId}/invitations": {
"get": {
"operationId": "workspace.listInvitationsInWorkspace",
"summary": "List invitations in workspace",
"tags": [
"Workspace"
],
"parameters": [
{
"name": "workspaceId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"invitations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"email": {
"type": "string"
},
"type": {
"enum": [
"ADMIN",
"MEMBER",
"GUEST"
],
"type": "string"
}
},
"required": [
"id",
"createdAt",
"updatedAt",
"email",
"type"
]
}
}
},
"required": [
"invitations"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots": {
"post": {
"operationId": "typebot-createTypebot",
"summary": "Create a typebot",
"tags": [
"Typebot"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string"
},
"typebot": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"selectedThemeTemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"$ref": "#/components/schemas/Image"
},
{
"$ref": "#/components/schemas/Video"
},
{
"$ref": "#/components/schemas/Embed"
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"$ref": "#/components/schemas/NumberInput"
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"$ref": "#/components/schemas/RatingInput"
},
{
"$ref": "#/components/schemas/Cards"
},
{
"$ref": "#/components/schemas/ChoiceInput"
},
{
"$ref": "#/components/schemas/FileInput"
},
{
"$ref": "#/components/schemas/PictureChoiceInput"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"$ref": "#/components/schemas/Condition"
},
{
"$ref": "#/components/schemas/AbTest"
},
{
"$ref": "#/components/schemas/Webhook"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"$ref": "#/components/schemas/GoogleAnalytics"
},
{
"$ref": "#/components/schemas/Openai"
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"$ref": "#/components/schemas/GoogleSheets"
},
{
"$ref": "#/components/schemas/Make.com"
},
{
"$ref": "#/components/schemas/Pabbly"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"variableId": {},
"value": {}
}
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"variableId": {},
"bodyPath": {}
}
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"queryParams": {
"type": "array",
"items": {}
},
"headers": {
"type": "array",
"items": {}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zapier"
}
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "openai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {}
},
"tools": {
"type": "array",
"items": {}
},
"temperature": {
"anyOf": [
{},
{}
]
},
"responseMapping": {
"type": "array",
"items": {}
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/AskAssistant"
},
{
"$ref": "#/components/schemas/AskModel"
},
{
"$ref": "#/components/schemas/GenerateVariables"
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create speech"
},
"model": {
"type": "string"
},
"input": {
"type": "string"
},
"instructions": {
"type": "string"
},
"voice": {
"enum": [
"alloy",
"echo",
"fable",
"onyx",
"nova",
"shimmer"
],
"type": "string"
},
"saveUrlInVariableId": {
"type": "string"
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/CreateTranscription"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/CalCom"
},
{
"$ref": "#/components/schemas/ChatNode"
},
{
"$ref": "#/components/schemas/QrCode"
},
{
"$ref": "#/components/schemas/DifyAi"
},
{
"$ref": "#/components/schemas/Mistral"
},
{
"$ref": "#/components/schemas/Elevenlabs"
},
{
"$ref": "#/components/schemas/Anthropic"
},
{
"$ref": "#/components/schemas/TogetherAi"
},
{
"$ref": "#/components/schemas/OpenRouter"
},
{
"$ref": "#/components/schemas/Nocodb"
},
{
"$ref": "#/components/schemas/Segment"
},
{
"$ref": "#/components/schemas/Groq"
},
{
"$ref": "#/components/schemas/Zendesk"
},
{
"$ref": "#/components/schemas/Posthog"
},
{
"$ref": "#/components/schemas/Perplexity"
},
{
"$ref": "#/components/schemas/Deepseek"
},
{
"$ref": "#/components/schemas/Blink"
},
{
"$ref": "#/components/schemas/Gmail"
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"events": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "start"
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
],
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "command"
},
"options": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"resumeAfter": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "reply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "invalidReply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"startCondition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
},
"required": [
"comparisons"
]
},
"sessionExpiryTimeout": {
"type": "number",
"minimum": 0.01,
"maximum": 48,
"description": "Expiration delay in hours after latest interaction"
},
"errorAndMarketingStatusWebhookForwardUrl": {
"type": "string",
"format": "uri"
},
"isWebhookForwardingEnabled": {
"type": "boolean"
},
"webhookForwardingEventTypes": {
"type": "array",
"items": {
"enum": [
"all",
"errorStatuses",
"marketingStatuses"
],
"type": "string"
}
}
}
},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"resultsTablePreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"columnsOrder": {
"type": "array",
"items": {
"type": "string"
}
},
"columnsVisibility": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
"columnsWidth": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"columnsOrder",
"columnsVisibility",
"columnsWidth"
]
},
{
"type": "null"
}
]
},
"publicId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customDomain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
}
},
"required": [
"workspaceId",
"typebot"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"typebot": {
"type": "object",
"properties": {
"version": {
"enum": [
"6",
"6.1"
],
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"events": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "start"
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
],
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "command"
},
"options": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"resumeAfter": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "reply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "invalidReply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
]
}
},
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"text"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"html": {
"type": "string"
},
"richText": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"plainText": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Image"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"video"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"enum": [
"url",
"youtube",
"vimeo",
"tiktok",
"gumlet"
],
"type": "string"
},
"height": {},
"aspectRatio": {
"type": "string"
},
"maxWidth": {
"type": "string"
},
"queryParamsStr": {
"type": "string"
},
"areControlsDisplayed": {
"type": "boolean"
},
"isAutoplayEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"embed"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"height": {},
"waitForEvent": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"saveDataInVariableId": {
"type": "string"
}
}
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"number input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"labels": {
"type": "object",
"properties": {
"placeholder": {
"type": "string"
},
"button": {
"type": "string"
}
}
},
"min": {},
"max": {},
"step": {},
"locale": {
"type": "string",
"pattern": "^[a-z]{2}(-[A-Z]{2})?$"
},
"style": {
"enum": [
"decimal",
"currency",
"percent",
"unit"
],
"type": "string"
},
"currency": {
"type": "string"
},
"unit": {
"enum": [
"acre",
"bit",
"byte",
"celsius",
"centimeter",
"day",
"degree",
"fahrenheit",
"fluid-ounce",
"foot",
"gallon",
"gigabit",
"gigabyte",
"gram",
"hectare",
"hour",
"inch",
"kilobit",
"kilobyte",
"kilogram",
"kilometer",
"liter",
"megabit",
"megabyte",
"meter",
"microsecond",
"mile",
"mile-scandinavian",
"milliliter",
"millimeter",
"millisecond",
"minute",
"month",
"nanosecond",
"ounce",
"percent",
"petabyte",
"pound",
"second",
"stone",
"terabit",
"terabyte",
"week",
"yard",
"year"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "rating input"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"buttonType": {
"anyOf": [
{
"const": "Icons"
},
{
"const": "Numbers"
}
]
},
"length": {
"type": "number"
},
"startsAt": {},
"labels": {
"type": "object",
"properties": {
"left": {
"type": "string"
},
"right": {
"type": "string"
},
"button": {
"type": "string"
}
}
},
"customIcon": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"svg": {
"type": "string"
}
}
},
"isOneClickSubmitEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Cards"
},
{
"$ref": "#/components/schemas/ChoiceInput"
},
{
"$ref": "#/components/schemas/FileInput"
},
{
"$ref": "#/components/schemas/PictureChoiceInput"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"$ref": "#/components/schemas/Condition"
},
{
"$ref": "#/components/schemas/AbTest"
},
{
"$ref": "#/components/schemas/Webhook"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Analytics"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"trackingId": {
"type": "string"
},
"category": {
"type": "string"
},
"action": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {},
"sendTo": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"OpenAI"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"task": {
"not": {}
},
"credentialsId": {
"type": "string"
},
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"task": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"advancedSettings": {
"type": "object",
"properties": {
"temperature": {}
}
},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"credentialsId": {
"type": "string"
},
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
}
},
"required": [
"task"
]
},
{
"$ref": "#/components/schemas/CreateImage"
},
{
"$ref": "#/components/schemas/CreateSpeech"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"$ref": "#/components/schemas/GoogleSheets"
},
{
"$ref": "#/components/schemas/Make.com"
},
{
"$ref": "#/components/schemas/Pabbly"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"variableId": {},
"value": {}
}
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"variableId": {},
"bodyPath": {}
}
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"queryParams": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"headers": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zapier"
}
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "openai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/AskAssistant"
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Ask Model"
},
"model": {
"type": "string"
},
"message": {
"type": "string"
},
"instructions": {
"type": "string"
},
"responseIdVariableId": {
"type": "string"
},
"fileSearchVectorStoreIds": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"fileSearchMaxNumResults": {},
"fileSearchScoreThreshold": {},
"webSearchEnabled": {
"type": "boolean"
},
"codeInterpreterEnabled": {
"type": "boolean"
},
"functions": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Generate variables"
},
"model": {
"type": "string"
},
"prompt": {
"type": "string"
},
"variablesToExtract": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create speech"
},
"model": {
"type": "string"
},
"input": {
"type": "string"
},
"instructions": {
"type": "string"
},
"voice": {
"enum": [
"alloy",
"echo",
"fable",
"onyx",
"nova",
"shimmer"
],
"type": "string"
},
"saveUrlInVariableId": {
"type": "string"
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/CreateTranscription"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/CalCom"
},
{
"$ref": "#/components/schemas/ChatNode"
},
{
"$ref": "#/components/schemas/QrCode"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "dify-ai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create Chat Message"
},
"query": {
"type": "string"
},
"conversationVariableId": {
"type": "string"
},
"user": {
"type": "string"
},
"inputs": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"responseMapping": {}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/QueryKnowledgeBase"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "mistral"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Generate variables"
},
"model": {
"type": "string"
},
"prompt": {
"type": "string"
},
"variablesToExtract": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Elevenlabs"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "anthropic"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create Chat Message"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"systemMessage": {
"type": "string"
},
"temperature": {},
"maxTokens": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Generate variables"
},
"model": {
"type": "string"
},
"prompt": {
"type": "string"
},
"variablesToExtract": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "together-ai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "open-router"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Nocodb"
},
{
"$ref": "#/components/schemas/Segment"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "groq"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zendesk"
},
{
"$ref": "#/components/schemas/Posthog"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "perplexity"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "deepseek"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "blink"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/GetUsers"
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Send Feed Event"
},
"categoryId": {
"type": "string"
},
"ribbonColor": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"allowComments": {
"type": "boolean"
},
"allowReactions": {
"type": "boolean"
},
"userIds": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"groupIds": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"pushNotification": {
"type": "object",
"properties": {
"title": {},
"text": {}
}
},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Redirect"
},
"url": {
"type": "string"
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Gmail"
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"selectedThemeTemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publicId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customDomain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"resultsTablePreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"columnsOrder": {
"type": "array",
"items": {
"type": "string"
}
},
"columnsVisibility": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
"columnsWidth": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"columnsOrder",
"columnsVisibility",
"columnsWidth"
]
},
{
"type": "null"
}
]
},
"isArchived": {
"type": "boolean"
},
"isClosed": {
"type": "boolean"
},
"whatsAppCredentialsId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"riskLevel": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"spaceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"version",
"id",
"name",
"events",
"groups",
"edges",
"variables",
"theme",
"selectedThemeTemplateId",
"settings",
"createdAt",
"updatedAt",
"icon",
"folderId",
"publicId",
"customDomain",
"workspaceId",
"resultsTablePreferences",
"isArchived",
"isClosed",
"whatsAppCredentialsId",
"riskLevel",
"spaceId"
]
}
},
"required": [
"typebot"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
},
"get": {
"operationId": "typebot-listTypebots",
"summary": "List typebots",
"tags": [
"Typebot"
],
"parameters": [
{
"name": "workspaceId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)"
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "folderId",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"typebots": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"spaceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"publishedTypebotId": {
"type": "string"
},
"accessRight": {
"enum": [
"read",
"write",
"guest"
],
"type": "string"
}
},
"required": [
"name",
"icon",
"id",
"spaceId",
"createdAt",
"accessRight"
]
}
}
},
"required": [
"typebots"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots/{typebotId}": {
"get": {
"operationId": "typebot-getTypebot",
"summary": "Get a typebot",
"tags": [
"Typebot"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
}
},
{
"name": "migrateToLatestVersion",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"description": "If enabled, the typebot will be converted to the latest schema version"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"typebot": {
"anyOf": [
{
"type": "object",
"properties": {
"version": {
"enum": [
"6",
"6.1"
],
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"events": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "start"
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
],
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "command"
},
"options": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"resumeAfter": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "reply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "invalidReply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
]
}
},
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"text"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"html": {
"type": "string"
},
"richText": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"plainText": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Image"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"video"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"enum": [
"url",
"youtube",
"vimeo",
"tiktok",
"gumlet"
],
"type": "string"
},
"height": {},
"aspectRatio": {
"type": "string"
},
"maxWidth": {
"type": "string"
},
"queryParamsStr": {
"type": "string"
},
"areControlsDisplayed": {
"type": "boolean"
},
"isAutoplayEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"embed"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"height": {},
"waitForEvent": {
"type": "object",
"properties": {
"isEnabled": {},
"name": {},
"saveDataInVariableId": {}
}
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"number input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"labels": {
"type": "object",
"properties": {
"placeholder": {},
"button": {}
}
},
"min": {},
"max": {},
"step": {},
"locale": {
"type": "string",
"pattern": "^[a-z]{2}(-[A-Z]{2})?$"
},
"style": {
"enum": [
"decimal",
"currency",
"percent",
"unit"
],
"type": "string"
},
"currency": {
"type": "string"
},
"unit": {
"enum": [
"acre",
"bit",
"byte",
"celsius",
"centimeter",
"day",
"degree",
"fahrenheit",
"fluid-ounce",
"foot",
"gallon",
"gigabit",
"gigabyte",
"gram",
"hectare",
"hour",
"inch",
"kilobit",
"kilobyte",
"kilogram",
"kilometer",
"liter",
"megabit",
"megabyte",
"meter",
"microsecond",
"mile",
"mile-scandinavian",
"milliliter",
"millimeter",
"millisecond",
"minute",
"month",
"nanosecond",
"ounce",
"percent",
"petabyte",
"pound",
"second",
"stone",
"terabit",
"terabyte",
"week",
"yard",
"year"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "rating input"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"buttonType": {
"anyOf": [
{},
{}
]
},
"length": {
"type": "number"
},
"startsAt": {},
"labels": {
"type": "object",
"properties": {
"left": {},
"right": {},
"button": {}
}
},
"customIcon": {
"type": "object",
"properties": {
"isEnabled": {},
"svg": {}
}
},
"isOneClickSubmitEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Cards"
},
{
"$ref": "#/components/schemas/ChoiceInput"
},
{
"$ref": "#/components/schemas/FileInput"
},
{
"$ref": "#/components/schemas/PictureChoiceInput"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"$ref": "#/components/schemas/Condition"
},
{
"$ref": "#/components/schemas/AbTest"
},
{
"$ref": "#/components/schemas/Webhook"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Analytics"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"trackingId": {
"type": "string"
},
"category": {
"type": "string"
},
"action": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {},
"sendTo": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"OpenAI"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"task": {},
"credentialsId": {},
"baseUrl": {},
"apiVersion": {}
}
},
{
"type": "object",
"properties": {
"task": {},
"model": {},
"messages": {},
"advancedSettings": {},
"responseMapping": {},
"credentialsId": {},
"baseUrl": {},
"apiVersion": {}
}
},
{
"$ref": "#/components/schemas/CreateImage"
},
{
"$ref": "#/components/schemas/CreateSpeech"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"$ref": "#/components/schemas/GoogleSheets"
},
{
"$ref": "#/components/schemas/Make.com"
},
{
"$ref": "#/components/schemas/Pabbly"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zapier"
}
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "openai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"baseUrl": {},
"apiVersion": {},
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"baseUrl": {},
"apiVersion": {},
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"temperature": {},
"responseMapping": {}
}
},
{
"$ref": "#/components/schemas/AskAssistant"
},
{
"type": "object",
"properties": {
"baseUrl": {},
"apiVersion": {},
"credentialsId": {},
"action": {},
"model": {},
"message": {},
"instructions": {},
"responseIdVariableId": {},
"fileSearchVectorStoreIds": {},
"fileSearchMaxNumResults": {},
"fileSearchScoreThreshold": {},
"webSearchEnabled": {},
"codeInterpreterEnabled": {},
"functions": {},
"temperature": {},
"responseMapping": {}
}
},
{
"type": "object",
"properties": {
"baseUrl": {},
"apiVersion": {},
"credentialsId": {},
"action": {},
"model": {},
"prompt": {},
"variablesToExtract": {}
}
},
{
"type": "object",
"properties": {
"baseUrl": {},
"apiVersion": {},
"credentialsId": {},
"action": {},
"model": {},
"input": {},
"instructions": {},
"voice": {},
"saveUrlInVariableId": {}
}
},
{
"$ref": "#/components/schemas/CreateTranscription"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/CalCom"
},
{
"$ref": "#/components/schemas/ChatNode"
},
{
"$ref": "#/components/schemas/QrCode"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "dify-ai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"query": {},
"conversationVariableId": {},
"user": {},
"inputs": {},
"responseMapping": {}
}
},
{
"$ref": "#/components/schemas/QueryKnowledgeBase"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "mistral"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"temperature": {},
"responseMapping": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"prompt": {},
"variablesToExtract": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Elevenlabs"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "anthropic"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"systemMessage": {},
"temperature": {},
"maxTokens": {},
"responseMapping": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"prompt": {},
"variablesToExtract": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "together-ai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"temperature": {},
"responseMapping": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "open-router"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"temperature": {},
"responseMapping": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Nocodb"
},
{
"$ref": "#/components/schemas/Segment"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "groq"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"temperature": {},
"responseMapping": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zendesk"
},
{
"$ref": "#/components/schemas/Posthog"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "perplexity"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"temperature": {},
"responseMapping": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "deepseek"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"temperature": {},
"responseMapping": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "blink"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"$ref": "#/components/schemas/GetUsers"
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"categoryId": {},
"ribbonColor": {},
"sections": {},
"allowComments": {},
"allowReactions": {},
"userIds": {},
"groupIds": {},
"pushNotification": {},
"responseMapping": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"url": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Gmail"
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"selectedThemeTemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publicId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customDomain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"resultsTablePreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"columnsOrder": {
"type": "array",
"items": {
"type": "string"
}
},
"columnsVisibility": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
"columnsWidth": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"columnsOrder",
"columnsVisibility",
"columnsWidth"
]
},
{
"type": "null"
}
]
},
"isArchived": {
"type": "boolean"
},
"isClosed": {
"type": "boolean"
},
"whatsAppCredentialsId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"riskLevel": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"spaceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"version",
"id",
"name",
"events",
"groups",
"edges",
"variables",
"theme",
"selectedThemeTemplateId",
"settings",
"createdAt",
"updatedAt",
"icon",
"folderId",
"publicId",
"customDomain",
"workspaceId",
"resultsTablePreferences",
"isArchived",
"isClosed",
"whatsAppCredentialsId",
"riskLevel",
"spaceId"
]
},
{
"type": "object",
"properties": {
"version": {
"enum": [
"3",
"4",
"5"
],
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"events": {
"type": "null"
},
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"text"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"html": {
"type": "string"
},
"richText": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"plainText": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Image"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"video"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"enum": [
"url",
"youtube",
"vimeo",
"tiktok",
"gumlet"
],
"type": "string"
},
"height": {},
"aspectRatio": {
"type": "string"
},
"maxWidth": {
"type": "string"
},
"queryParamsStr": {
"type": "string"
},
"areControlsDisplayed": {
"type": "boolean"
},
"isAutoplayEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"embed"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"height": {},
"waitForEvent": {
"type": "object",
"properties": {
"isEnabled": {},
"name": {},
"saveDataInVariableId": {}
}
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"number input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"labels": {
"type": "object",
"properties": {
"placeholder": {},
"button": {}
}
},
"min": {},
"max": {},
"step": {},
"locale": {
"type": "string",
"pattern": "^[a-z]{2}(-[A-Z]{2})?$"
},
"style": {
"enum": [
"decimal",
"currency",
"percent",
"unit"
],
"type": "string"
},
"currency": {
"type": "string"
},
"unit": {
"enum": [
"acre",
"bit",
"byte",
"celsius",
"centimeter",
"day",
"degree",
"fahrenheit",
"fluid-ounce",
"foot",
"gallon",
"gigabit",
"gigabyte",
"gram",
"hectare",
"hour",
"inch",
"kilobit",
"kilobyte",
"kilogram",
"kilometer",
"liter",
"megabit",
"megabyte",
"meter",
"microsecond",
"mile",
"mile-scandinavian",
"milliliter",
"millimeter",
"millisecond",
"minute",
"month",
"nanosecond",
"ounce",
"percent",
"petabyte",
"pound",
"second",
"stone",
"terabit",
"terabyte",
"week",
"yard",
"year"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "rating input"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"buttonType": {
"anyOf": [
{},
{}
]
},
"length": {
"type": "number"
},
"startsAt": {},
"labels": {
"type": "object",
"properties": {
"left": {},
"right": {},
"button": {}
}
},
"customIcon": {
"type": "object",
"properties": {
"isEnabled": {},
"svg": {}
}
},
"isOneClickSubmitEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Cards"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"content": {},
"value": {},
"displayCondition": {}
}
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"dynamicVariableId": {
"type": "string"
},
"isSearchable": {
"type": "boolean"
},
"searchInputPlaceholder": {
"type": "string"
},
"areInitialSearchButtonsVisible": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "file input"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isRequired": {
"type": "boolean"
},
"isMultipleAllowed": {
"type": "boolean"
},
"labels": {
"type": "object",
"properties": {
"placeholder": {},
"button": {},
"clear": {},
"skip": {},
"success": {}
}
},
"allowedFileTypes": {
"type": "object",
"properties": {
"isEnabled": {},
"types": {}
}
},
"capture": {
"enum": [
"environment",
"user"
],
"type": "string"
},
"sizeLimit": {
"type": "number"
},
"visibility": {
"enum": [
"Auto",
"Public",
"Private"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"picture choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"pictureSrc": {},
"title": {},
"description": {},
"value": {},
"displayCondition": {}
}
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"isSearchable": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"searchInputPlaceholder": {
"type": "string"
},
"dynamicItems": {
"type": "object",
"properties": {
"isEnabled": {},
"titlesVariableId": {},
"descriptionsVariableId": {},
"pictureSrcsVariableId": {}
}
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Condition"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"content": {}
}
}
},
"options": {
"not": {}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"AB test"
],
"type": "string"
},
"items": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"path": {}
}
},
{
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"path": {}
}
}
]
},
"options": {
"type": "object",
"properties": {
"aPercent": {
"type": "number",
"minimum": 0,
"maximum": 100
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Analytics"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"trackingId": {
"type": "string"
},
"category": {
"type": "string"
},
"action": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {},
"sendTo": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"OpenAI"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"task": {},
"credentialsId": {},
"baseUrl": {},
"apiVersion": {}
}
},
{
"type": "object",
"properties": {
"task": {},
"model": {},
"messages": {},
"advancedSettings": {},
"responseMapping": {},
"credentialsId": {},
"baseUrl": {},
"apiVersion": {}
}
},
{
"$ref": "#/components/schemas/CreateImage"
},
{
"$ref": "#/components/schemas/CreateSpeech"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Sheets"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"sheetId": {},
"spreadsheetId": {},
"action": {},
"referenceCell": {},
"filter": {},
"cellsToExtract": {},
"totalRowsToExtract": {}
}
},
{
"$ref": "#/components/schemas/InsertARow"
},
{
"type": "object",
"properties": {
"credentialsId": {},
"sheetId": {},
"spreadsheetId": {},
"action": {},
"cellsToUpsert": {},
"referenceCell": {},
"filter": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"sheetId": {},
"spreadsheetId": {},
"action": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Make.com"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {},
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Pabbly"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {},
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {},
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Zapier"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {},
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"selectedThemeTemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publicId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customDomain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"resultsTablePreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"columnsOrder": {
"type": "array",
"items": {
"type": "string"
}
},
"columnsVisibility": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
"columnsWidth": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"columnsOrder",
"columnsVisibility",
"columnsWidth"
]
},
{
"type": "null"
}
]
},
"isArchived": {
"type": "boolean"
},
"isClosed": {
"type": "boolean"
},
"whatsAppCredentialsId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"riskLevel": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"spaceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"version",
"id",
"name",
"events",
"groups",
"edges",
"variables",
"theme",
"selectedThemeTemplateId",
"settings",
"createdAt",
"updatedAt",
"icon",
"folderId",
"publicId",
"customDomain",
"workspaceId",
"resultsTablePreferences",
"isArchived",
"isClosed",
"whatsAppCredentialsId",
"riskLevel",
"spaceId"
]
}
]
},
"currentUserMode": {
"enum": [
"guest",
"read",
"write"
],
"type": "string"
}
},
"required": [
"typebot",
"currentUserMode"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
}
},
"patch": {
"operationId": "typebot-updateTypebot",
"summary": "Update a typebot",
"tags": [
"Typebot"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"typebot": {
"anyOf": [
{
"type": "object",
"properties": {
"version": {
"enum": [
"6",
"6.1"
],
"type": "string"
},
"name": {
"type": "string"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"selectedThemeTemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"$ref": "#/components/schemas/Image"
},
{
"$ref": "#/components/schemas/Video"
},
{
"$ref": "#/components/schemas/Embed"
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"$ref": "#/components/schemas/NumberInput"
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"$ref": "#/components/schemas/RatingInput"
},
{
"$ref": "#/components/schemas/Cards"
},
{
"$ref": "#/components/schemas/ChoiceInput"
},
{
"$ref": "#/components/schemas/FileInput"
},
{
"$ref": "#/components/schemas/PictureChoiceInput"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"$ref": "#/components/schemas/Condition"
},
{
"$ref": "#/components/schemas/AbTest"
},
{
"$ref": "#/components/schemas/Webhook"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"$ref": "#/components/schemas/GoogleAnalytics"
},
{
"$ref": "#/components/schemas/Openai"
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"$ref": "#/components/schemas/GoogleSheets"
},
{
"$ref": "#/components/schemas/Make.com"
},
{
"$ref": "#/components/schemas/Pabbly"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {}
},
"responseVariableMapping": {
"type": "array",
"items": {}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zapier"
}
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "openai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"baseUrl": {},
"apiVersion": {},
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"baseUrl": {},
"apiVersion": {},
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"temperature": {},
"responseMapping": {}
}
},
{
"$ref": "#/components/schemas/AskAssistant"
},
{
"$ref": "#/components/schemas/AskModel"
},
{
"$ref": "#/components/schemas/GenerateVariables"
},
{
"type": "object",
"properties": {
"baseUrl": {},
"apiVersion": {},
"credentialsId": {},
"action": {},
"model": {},
"input": {},
"instructions": {},
"voice": {},
"saveUrlInVariableId": {}
}
},
{
"$ref": "#/components/schemas/CreateTranscription"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/CalCom"
},
{
"$ref": "#/components/schemas/ChatNode"
},
{
"$ref": "#/components/schemas/QrCode"
},
{
"$ref": "#/components/schemas/DifyAi"
},
{
"$ref": "#/components/schemas/Mistral"
},
{
"$ref": "#/components/schemas/Elevenlabs"
},
{
"$ref": "#/components/schemas/Anthropic"
},
{
"$ref": "#/components/schemas/TogetherAi"
},
{
"$ref": "#/components/schemas/OpenRouter"
},
{
"$ref": "#/components/schemas/Nocodb"
},
{
"$ref": "#/components/schemas/Segment"
},
{
"$ref": "#/components/schemas/Groq"
},
{
"$ref": "#/components/schemas/Zendesk"
},
{
"$ref": "#/components/schemas/Posthog"
},
{
"$ref": "#/components/schemas/Perplexity"
},
{
"$ref": "#/components/schemas/Deepseek"
},
{
"$ref": "#/components/schemas/Blink"
},
{
"$ref": "#/components/schemas/Gmail"
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"startCondition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
},
"required": [
"comparisons"
]
},
"sessionExpiryTimeout": {
"type": "number",
"minimum": 0.01,
"maximum": 48,
"description": "Expiration delay in hours after latest interaction"
},
"errorAndMarketingStatusWebhookForwardUrl": {
"type": "string",
"format": "uri"
},
"isWebhookForwardingEnabled": {
"type": "boolean"
},
"webhookForwardingEventTypes": {
"type": "array",
"items": {
"enum": [
"all",
"errorStatuses",
"marketingStatuses"
],
"type": "string"
}
}
}
},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"resultsTablePreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"columnsOrder": {
"type": "array",
"items": {
"type": "string"
}
},
"columnsVisibility": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
"columnsWidth": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"columnsOrder",
"columnsVisibility",
"columnsWidth"
]
},
{
"type": "null"
}
]
},
"publicId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customDomain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"isClosed": {
"type": "boolean"
},
"whatsAppCredentialsId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"riskLevel": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"events": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "start"
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
],
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "command"
},
"options": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"resumeAfter": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "reply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "invalidReply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
]
}
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"spaceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
{
"type": "object",
"properties": {
"version": {
"enum": [
"3",
"4",
"5"
],
"type": "string"
},
"name": {
"type": "string"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"selectedThemeTemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"$ref": "#/components/schemas/Image"
},
{
"$ref": "#/components/schemas/Video"
},
{
"$ref": "#/components/schemas/Embed"
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"$ref": "#/components/schemas/NumberInput"
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"$ref": "#/components/schemas/RatingInput"
},
{
"$ref": "#/components/schemas/Cards"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"content": {},
"value": {},
"displayCondition": {}
}
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"dynamicVariableId": {
"type": "string"
},
"isSearchable": {
"type": "boolean"
},
"searchInputPlaceholder": {
"type": "string"
},
"areInitialSearchButtonsVisible": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "file input"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isRequired": {
"type": "boolean"
},
"isMultipleAllowed": {
"type": "boolean"
},
"labels": {
"type": "object",
"properties": {
"placeholder": {},
"button": {},
"clear": {},
"skip": {},
"success": {}
}
},
"allowedFileTypes": {
"type": "object",
"properties": {
"isEnabled": {},
"types": {}
}
},
"capture": {
"enum": [
"environment",
"user"
],
"type": "string"
},
"sizeLimit": {
"type": "number"
},
"visibility": {
"enum": [
"Auto",
"Public",
"Private"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"picture choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"pictureSrc": {},
"title": {},
"description": {},
"value": {},
"displayCondition": {}
}
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"isSearchable": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"searchInputPlaceholder": {
"type": "string"
},
"dynamicItems": {
"type": "object",
"properties": {
"isEnabled": {},
"titlesVariableId": {},
"descriptionsVariableId": {},
"pictureSrcsVariableId": {}
}
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Condition"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"content": {}
}
}
},
"options": {
"not": {}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"AB test"
],
"type": "string"
},
"items": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"path": {}
}
},
{
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"path": {}
}
}
]
},
"options": {
"type": "object",
"properties": {
"aPercent": {
"type": "number",
"minimum": 0,
"maximum": 100
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"$ref": "#/components/schemas/GoogleAnalytics"
},
{
"$ref": "#/components/schemas/Openai"
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Sheets"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"sheetId": {},
"spreadsheetId": {},
"action": {},
"referenceCell": {},
"filter": {},
"cellsToExtract": {},
"totalRowsToExtract": {}
}
},
{
"$ref": "#/components/schemas/InsertARow"
},
{
"type": "object",
"properties": {
"credentialsId": {},
"sheetId": {},
"spreadsheetId": {},
"action": {},
"cellsToUpsert": {},
"referenceCell": {},
"filter": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"sheetId": {},
"spreadsheetId": {},
"action": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Make.com"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {}
},
"responseVariableMapping": {
"type": "array",
"items": {}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {},
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Pabbly"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {}
},
"responseVariableMapping": {
"type": "array",
"items": {}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {},
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {}
},
"responseVariableMapping": {
"type": "array",
"items": {}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {},
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Zapier"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {}
},
"responseVariableMapping": {
"type": "array",
"items": {}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {},
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"startCondition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
},
"required": [
"comparisons"
]
},
"sessionExpiryTimeout": {
"type": "number",
"minimum": 0.01,
"maximum": 48,
"description": "Expiration delay in hours after latest interaction"
},
"errorAndMarketingStatusWebhookForwardUrl": {
"type": "string",
"format": "uri"
},
"isWebhookForwardingEnabled": {
"type": "boolean"
},
"webhookForwardingEventTypes": {
"type": "array",
"items": {
"enum": [
"all",
"errorStatuses",
"marketingStatuses"
],
"type": "string"
}
}
}
},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"resultsTablePreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"columnsOrder": {
"type": "array",
"items": {
"type": "string"
}
},
"columnsVisibility": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
"columnsWidth": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"columnsOrder",
"columnsVisibility",
"columnsWidth"
]
},
{
"type": "null"
}
]
},
"publicId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customDomain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"isClosed": {
"type": "boolean"
},
"whatsAppCredentialsId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"riskLevel": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"events": {
"type": "null"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"spaceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
}
]
},
"overwrite": {
"type": "boolean",
"description": "If true, even if we detect a conflict, we will overwrite push the updates to the typebot"
}
},
"required": [
"typebot"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"typebot": {
"type": "object",
"properties": {
"version": {
"enum": [
"6",
"6.1"
],
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"events": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "start"
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
],
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "command"
},
"options": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"resumeAfter": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "reply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "invalidReply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
]
}
},
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"text"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"html": {
"type": "string"
},
"richText": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"plainText": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Image"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"video"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"enum": [
"url",
"youtube",
"vimeo",
"tiktok",
"gumlet"
],
"type": "string"
},
"height": {},
"aspectRatio": {
"type": "string"
},
"maxWidth": {
"type": "string"
},
"queryParamsStr": {
"type": "string"
},
"areControlsDisplayed": {
"type": "boolean"
},
"isAutoplayEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"embed"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"height": {},
"waitForEvent": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"saveDataInVariableId": {
"type": "string"
}
}
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"number input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"labels": {
"type": "object",
"properties": {
"placeholder": {
"type": "string"
},
"button": {
"type": "string"
}
}
},
"min": {},
"max": {},
"step": {},
"locale": {
"type": "string",
"pattern": "^[a-z]{2}(-[A-Z]{2})?$"
},
"style": {
"enum": [
"decimal",
"currency",
"percent",
"unit"
],
"type": "string"
},
"currency": {
"type": "string"
},
"unit": {
"enum": [
"acre",
"bit",
"byte",
"celsius",
"centimeter",
"day",
"degree",
"fahrenheit",
"fluid-ounce",
"foot",
"gallon",
"gigabit",
"gigabyte",
"gram",
"hectare",
"hour",
"inch",
"kilobit",
"kilobyte",
"kilogram",
"kilometer",
"liter",
"megabit",
"megabyte",
"meter",
"microsecond",
"mile",
"mile-scandinavian",
"milliliter",
"millimeter",
"millisecond",
"minute",
"month",
"nanosecond",
"ounce",
"percent",
"petabyte",
"pound",
"second",
"stone",
"terabit",
"terabyte",
"week",
"yard",
"year"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "rating input"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"buttonType": {
"anyOf": [
{
"const": "Icons"
},
{
"const": "Numbers"
}
]
},
"length": {
"type": "number"
},
"startsAt": {},
"labels": {
"type": "object",
"properties": {
"left": {
"type": "string"
},
"right": {
"type": "string"
},
"button": {
"type": "string"
}
}
},
"customIcon": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"svg": {
"type": "string"
}
}
},
"isOneClickSubmitEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Cards"
},
{
"$ref": "#/components/schemas/ChoiceInput"
},
{
"$ref": "#/components/schemas/FileInput"
},
{
"$ref": "#/components/schemas/PictureChoiceInput"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"$ref": "#/components/schemas/Condition"
},
{
"$ref": "#/components/schemas/AbTest"
},
{
"$ref": "#/components/schemas/Webhook"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Analytics"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"trackingId": {
"type": "string"
},
"category": {
"type": "string"
},
"action": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {},
"sendTo": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"OpenAI"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"task": {
"not": {}
},
"credentialsId": {
"type": "string"
},
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"task": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"advancedSettings": {
"type": "object",
"properties": {
"temperature": {}
}
},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"credentialsId": {
"type": "string"
},
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
}
},
"required": [
"task"
]
},
{
"$ref": "#/components/schemas/CreateImage"
},
{
"$ref": "#/components/schemas/CreateSpeech"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"$ref": "#/components/schemas/GoogleSheets"
},
{
"$ref": "#/components/schemas/Make.com"
},
{
"$ref": "#/components/schemas/Pabbly"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"variableId": {},
"value": {}
}
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"variableId": {},
"bodyPath": {}
}
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"queryParams": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"headers": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zapier"
}
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "openai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/AskAssistant"
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Ask Model"
},
"model": {
"type": "string"
},
"message": {
"type": "string"
},
"instructions": {
"type": "string"
},
"responseIdVariableId": {
"type": "string"
},
"fileSearchVectorStoreIds": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"fileSearchMaxNumResults": {},
"fileSearchScoreThreshold": {},
"webSearchEnabled": {
"type": "boolean"
},
"codeInterpreterEnabled": {
"type": "boolean"
},
"functions": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Generate variables"
},
"model": {
"type": "string"
},
"prompt": {
"type": "string"
},
"variablesToExtract": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create speech"
},
"model": {
"type": "string"
},
"input": {
"type": "string"
},
"instructions": {
"type": "string"
},
"voice": {
"enum": [
"alloy",
"echo",
"fable",
"onyx",
"nova",
"shimmer"
],
"type": "string"
},
"saveUrlInVariableId": {
"type": "string"
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/CreateTranscription"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/CalCom"
},
{
"$ref": "#/components/schemas/ChatNode"
},
{
"$ref": "#/components/schemas/QrCode"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "dify-ai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create Chat Message"
},
"query": {
"type": "string"
},
"conversationVariableId": {
"type": "string"
},
"user": {
"type": "string"
},
"inputs": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"responseMapping": {}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/QueryKnowledgeBase"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "mistral"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Generate variables"
},
"model": {
"type": "string"
},
"prompt": {
"type": "string"
},
"variablesToExtract": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Elevenlabs"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "anthropic"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create Chat Message"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"systemMessage": {
"type": "string"
},
"temperature": {},
"maxTokens": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Generate variables"
},
"model": {
"type": "string"
},
"prompt": {
"type": "string"
},
"variablesToExtract": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "together-ai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "open-router"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Nocodb"
},
{
"$ref": "#/components/schemas/Segment"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "groq"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zendesk"
},
{
"$ref": "#/components/schemas/Posthog"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "perplexity"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "deepseek"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "blink"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/GetUsers"
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Send Feed Event"
},
"categoryId": {
"type": "string"
},
"ribbonColor": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"allowComments": {
"type": "boolean"
},
"allowReactions": {
"type": "boolean"
},
"userIds": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"groupIds": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"pushNotification": {
"type": "object",
"properties": {
"title": {},
"text": {}
}
},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Redirect"
},
"url": {
"type": "string"
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Gmail"
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"selectedThemeTemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publicId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customDomain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"resultsTablePreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"columnsOrder": {
"type": "array",
"items": {
"type": "string"
}
},
"columnsVisibility": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
"columnsWidth": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"columnsOrder",
"columnsVisibility",
"columnsWidth"
]
},
{
"type": "null"
}
]
},
"isArchived": {
"type": "boolean"
},
"isClosed": {
"type": "boolean"
},
"whatsAppCredentialsId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"riskLevel": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"spaceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"version",
"id",
"name",
"events",
"groups",
"edges",
"variables",
"theme",
"selectedThemeTemplateId",
"settings",
"createdAt",
"updatedAt",
"icon",
"folderId",
"publicId",
"customDomain",
"workspaceId",
"resultsTablePreferences",
"isArchived",
"isClosed",
"whatsAppCredentialsId",
"riskLevel",
"spaceId"
]
}
},
"required": [
"typebot"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
},
"delete": {
"operationId": "typebot-deleteTypebot",
"summary": "Delete a typebot",
"tags": [
"Typebot"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"required": []
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"const": "success"
}
},
"required": [
"message"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots/{typebotId}/publish": {
"post": {
"operationId": "typebot-publishTypebot",
"summary": "Publish a typebot",
"tags": [
"Typebot"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"required": []
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"const": "success"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"trademarkInfringement"
],
"type": "string"
},
"trademark": {
"type": "string"
}
},
"required": [
"type",
"trademark"
]
}
}
},
"required": [
"message"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots/{typebotId}/unpublish": {
"post": {
"operationId": "typebot-unpublishTypebot",
"summary": "Unpublish a typebot",
"tags": [
"Typebot"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"required": []
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"const": "success"
}
},
"required": [
"message"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots/{typebotId}/publishedTypebot": {
"get": {
"operationId": "typebot-getPublishedTypebot",
"summary": "Get published typebot",
"tags": [
"Typebot"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
}
},
{
"name": "migrateToLatestVersion",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"default": false,
"description": "If enabled, the typebot will be converted to the latest schema version"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"publishedTypebot": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"version": {
"enum": [
"6",
"6.1"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"lastActivityAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"typebotId": {
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"text"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"html": {
"type": "string"
},
"richText": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"plainText": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Image"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"video"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"enum": [
"url",
"youtube",
"vimeo",
"tiktok",
"gumlet"
],
"type": "string"
},
"height": {},
"aspectRatio": {
"type": "string"
},
"maxWidth": {
"type": "string"
},
"queryParamsStr": {
"type": "string"
},
"areControlsDisplayed": {
"type": "boolean"
},
"isAutoplayEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"embed"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"height": {},
"waitForEvent": {
"type": "object",
"properties": {
"isEnabled": {},
"name": {},
"saveDataInVariableId": {}
}
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"number input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"labels": {
"type": "object",
"properties": {
"placeholder": {},
"button": {}
}
},
"min": {},
"max": {},
"step": {},
"locale": {
"type": "string",
"pattern": "^[a-z]{2}(-[A-Z]{2})?$"
},
"style": {
"enum": [
"decimal",
"currency",
"percent",
"unit"
],
"type": "string"
},
"currency": {
"type": "string"
},
"unit": {
"enum": [
"acre",
"bit",
"byte",
"celsius",
"centimeter",
"day",
"degree",
"fahrenheit",
"fluid-ounce",
"foot",
"gallon",
"gigabit",
"gigabyte",
"gram",
"hectare",
"hour",
"inch",
"kilobit",
"kilobyte",
"kilogram",
"kilometer",
"liter",
"megabit",
"megabyte",
"meter",
"microsecond",
"mile",
"mile-scandinavian",
"milliliter",
"millimeter",
"millisecond",
"minute",
"month",
"nanosecond",
"ounce",
"percent",
"petabyte",
"pound",
"second",
"stone",
"terabit",
"terabyte",
"week",
"yard",
"year"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "rating input"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"buttonType": {
"anyOf": [
{},
{}
]
},
"length": {
"type": "number"
},
"startsAt": {},
"labels": {
"type": "object",
"properties": {
"left": {},
"right": {},
"button": {}
}
},
"customIcon": {
"type": "object",
"properties": {
"isEnabled": {},
"svg": {}
}
},
"isOneClickSubmitEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Cards"
},
{
"$ref": "#/components/schemas/ChoiceInput"
},
{
"$ref": "#/components/schemas/FileInput"
},
{
"$ref": "#/components/schemas/PictureChoiceInput"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"$ref": "#/components/schemas/Condition"
},
{
"$ref": "#/components/schemas/AbTest"
},
{
"$ref": "#/components/schemas/Webhook"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Analytics"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"trackingId": {
"type": "string"
},
"category": {
"type": "string"
},
"action": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {},
"sendTo": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"OpenAI"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"task": {},
"credentialsId": {},
"baseUrl": {},
"apiVersion": {}
}
},
{
"type": "object",
"properties": {
"task": {},
"model": {},
"messages": {},
"advancedSettings": {},
"responseMapping": {},
"credentialsId": {},
"baseUrl": {},
"apiVersion": {}
}
},
{
"$ref": "#/components/schemas/CreateImage"
},
{
"$ref": "#/components/schemas/CreateSpeech"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"$ref": "#/components/schemas/GoogleSheets"
},
{
"$ref": "#/components/schemas/Make.com"
},
{
"$ref": "#/components/schemas/Pabbly"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zapier"
}
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "openai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"baseUrl": {},
"apiVersion": {},
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"baseUrl": {},
"apiVersion": {},
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"temperature": {},
"responseMapping": {}
}
},
{
"$ref": "#/components/schemas/AskAssistant"
},
{
"type": "object",
"properties": {
"baseUrl": {},
"apiVersion": {},
"credentialsId": {},
"action": {},
"model": {},
"message": {},
"instructions": {},
"responseIdVariableId": {},
"fileSearchVectorStoreIds": {},
"fileSearchMaxNumResults": {},
"fileSearchScoreThreshold": {},
"webSearchEnabled": {},
"codeInterpreterEnabled": {},
"functions": {},
"temperature": {},
"responseMapping": {}
}
},
{
"type": "object",
"properties": {
"baseUrl": {},
"apiVersion": {},
"credentialsId": {},
"action": {},
"model": {},
"prompt": {},
"variablesToExtract": {}
}
},
{
"type": "object",
"properties": {
"baseUrl": {},
"apiVersion": {},
"credentialsId": {},
"action": {},
"model": {},
"input": {},
"instructions": {},
"voice": {},
"saveUrlInVariableId": {}
}
},
{
"$ref": "#/components/schemas/CreateTranscription"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/CalCom"
},
{
"$ref": "#/components/schemas/ChatNode"
},
{
"$ref": "#/components/schemas/QrCode"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "dify-ai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"query": {},
"conversationVariableId": {},
"user": {},
"inputs": {},
"responseMapping": {}
}
},
{
"$ref": "#/components/schemas/QueryKnowledgeBase"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "mistral"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"temperature": {},
"responseMapping": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"prompt": {},
"variablesToExtract": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Elevenlabs"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "anthropic"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"systemMessage": {},
"temperature": {},
"maxTokens": {},
"responseMapping": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"prompt": {},
"variablesToExtract": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "together-ai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"temperature": {},
"responseMapping": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "open-router"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"temperature": {},
"responseMapping": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Nocodb"
},
{
"$ref": "#/components/schemas/Segment"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "groq"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"temperature": {},
"responseMapping": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zendesk"
},
{
"$ref": "#/components/schemas/Posthog"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "perplexity"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"temperature": {},
"responseMapping": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "deepseek"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"temperature": {},
"responseMapping": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "blink"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {}
}
},
{
"$ref": "#/components/schemas/GetUsers"
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"categoryId": {},
"ribbonColor": {},
"sections": {},
"allowComments": {},
"allowReactions": {},
"userIds": {},
"groupIds": {},
"pushNotification": {},
"responseMapping": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"action": {},
"url": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Gmail"
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"events": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "start"
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
],
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "command"
},
"options": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"resumeAfter": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "reply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "invalidReply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"required": [
"id",
"version",
"createdAt",
"updatedAt",
"typebotId",
"groups",
"events",
"edges",
"variables",
"theme",
"settings"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"version": {
"enum": [
"3",
"4",
"5"
],
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"lastActivityAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"typebotId": {
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"text"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"html": {
"type": "string"
},
"richText": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"plainText": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Image"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"video"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"enum": [
"url",
"youtube",
"vimeo",
"tiktok",
"gumlet"
],
"type": "string"
},
"height": {},
"aspectRatio": {
"type": "string"
},
"maxWidth": {
"type": "string"
},
"queryParamsStr": {
"type": "string"
},
"areControlsDisplayed": {
"type": "boolean"
},
"isAutoplayEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"embed"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"height": {},
"waitForEvent": {
"type": "object",
"properties": {
"isEnabled": {},
"name": {},
"saveDataInVariableId": {}
}
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"number input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"labels": {
"type": "object",
"properties": {
"placeholder": {},
"button": {}
}
},
"min": {},
"max": {},
"step": {},
"locale": {
"type": "string",
"pattern": "^[a-z]{2}(-[A-Z]{2})?$"
},
"style": {
"enum": [
"decimal",
"currency",
"percent",
"unit"
],
"type": "string"
},
"currency": {
"type": "string"
},
"unit": {
"enum": [
"acre",
"bit",
"byte",
"celsius",
"centimeter",
"day",
"degree",
"fahrenheit",
"fluid-ounce",
"foot",
"gallon",
"gigabit",
"gigabyte",
"gram",
"hectare",
"hour",
"inch",
"kilobit",
"kilobyte",
"kilogram",
"kilometer",
"liter",
"megabit",
"megabyte",
"meter",
"microsecond",
"mile",
"mile-scandinavian",
"milliliter",
"millimeter",
"millisecond",
"minute",
"month",
"nanosecond",
"ounce",
"percent",
"petabyte",
"pound",
"second",
"stone",
"terabit",
"terabyte",
"week",
"yard",
"year"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "rating input"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"buttonType": {
"anyOf": [
{},
{}
]
},
"length": {
"type": "number"
},
"startsAt": {},
"labels": {
"type": "object",
"properties": {
"left": {},
"right": {},
"button": {}
}
},
"customIcon": {
"type": "object",
"properties": {
"isEnabled": {},
"svg": {}
}
},
"isOneClickSubmitEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Cards"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"content": {},
"value": {},
"displayCondition": {}
}
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"dynamicVariableId": {
"type": "string"
},
"isSearchable": {
"type": "boolean"
},
"searchInputPlaceholder": {
"type": "string"
},
"areInitialSearchButtonsVisible": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "file input"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isRequired": {
"type": "boolean"
},
"isMultipleAllowed": {
"type": "boolean"
},
"labels": {
"type": "object",
"properties": {
"placeholder": {},
"button": {},
"clear": {},
"skip": {},
"success": {}
}
},
"allowedFileTypes": {
"type": "object",
"properties": {
"isEnabled": {},
"types": {}
}
},
"capture": {
"enum": [
"environment",
"user"
],
"type": "string"
},
"sizeLimit": {
"type": "number"
},
"visibility": {
"enum": [
"Auto",
"Public",
"Private"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"picture choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"pictureSrc": {},
"title": {},
"description": {},
"value": {},
"displayCondition": {}
}
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"isSearchable": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"searchInputPlaceholder": {
"type": "string"
},
"dynamicItems": {
"type": "object",
"properties": {
"isEnabled": {},
"titlesVariableId": {},
"descriptionsVariableId": {},
"pictureSrcsVariableId": {}
}
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Condition"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"content": {}
}
}
},
"options": {
"not": {}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"AB test"
],
"type": "string"
},
"items": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"path": {}
}
},
{
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"path": {}
}
}
]
},
"options": {
"type": "object",
"properties": {
"aPercent": {
"type": "number",
"minimum": 0,
"maximum": 100
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Analytics"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"trackingId": {
"type": "string"
},
"category": {
"type": "string"
},
"action": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {},
"sendTo": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"OpenAI"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"task": {},
"credentialsId": {},
"baseUrl": {},
"apiVersion": {}
}
},
{
"type": "object",
"properties": {
"task": {},
"model": {},
"messages": {},
"advancedSettings": {},
"responseMapping": {},
"credentialsId": {},
"baseUrl": {},
"apiVersion": {}
}
},
{
"$ref": "#/components/schemas/CreateImage"
},
{
"$ref": "#/components/schemas/CreateSpeech"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Sheets"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"sheetId": {},
"spreadsheetId": {},
"action": {},
"referenceCell": {},
"filter": {},
"cellsToExtract": {},
"totalRowsToExtract": {}
}
},
{
"$ref": "#/components/schemas/InsertARow"
},
{
"type": "object",
"properties": {
"credentialsId": {},
"sheetId": {},
"spreadsheetId": {},
"action": {},
"cellsToUpsert": {},
"referenceCell": {},
"filter": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"sheetId": {},
"spreadsheetId": {},
"action": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Make.com"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {},
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Pabbly"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {},
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {},
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Zapier"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {},
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"events": {
"type": "null"
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"required": [
"id",
"version",
"createdAt",
"updatedAt",
"typebotId",
"groups",
"events",
"edges",
"variables",
"theme",
"settings"
]
}
]
},
{
"type": "null"
}
]
},
"version": {
"anyOf": [
{
"enum": [
"3",
"4",
"5"
],
"type": "string"
},
{
"enum": [
"6",
"6.1"
],
"type": "string"
}
],
"description": "Provides the version the published bot was migrated from if `migrateToLatestVersion` is set to `true`."
}
},
"required": [
"publishedTypebot"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots/import": {
"post": {
"operationId": "typebot-importTypebot",
"summary": "Import a typebot",
"tags": [
"Typebot"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)"
},
"typebot": {
"anyOf": [
{
"type": "object",
"properties": {
"version": {
"enum": [
"6",
"6.1"
],
"type": "string"
},
"name": {
"type": "string"
},
"events": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "start"
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
],
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "command"
},
"options": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"resumeAfter": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "reply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "invalidReply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
]
}
},
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"$ref": "#/components/schemas/Image"
},
{
"$ref": "#/components/schemas/Video"
},
{
"$ref": "#/components/schemas/Embed"
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"$ref": "#/components/schemas/NumberInput"
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"$ref": "#/components/schemas/RatingInput"
},
{
"$ref": "#/components/schemas/Cards"
},
{
"$ref": "#/components/schemas/ChoiceInput"
},
{
"$ref": "#/components/schemas/FileInput"
},
{
"$ref": "#/components/schemas/PictureChoiceInput"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"$ref": "#/components/schemas/Condition"
},
{
"$ref": "#/components/schemas/AbTest"
},
{
"$ref": "#/components/schemas/Webhook"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"$ref": "#/components/schemas/GoogleAnalytics"
},
{
"$ref": "#/components/schemas/Openai"
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"$ref": "#/components/schemas/GoogleSheets"
},
{
"$ref": "#/components/schemas/Make.com"
},
{
"$ref": "#/components/schemas/Pabbly"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {}
},
"responseVariableMapping": {
"type": "array",
"items": {}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zapier"
}
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "openai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"baseUrl": {},
"apiVersion": {},
"credentialsId": {},
"action": {}
}
},
{
"type": "object",
"properties": {
"baseUrl": {},
"apiVersion": {},
"credentialsId": {},
"action": {},
"model": {},
"messages": {},
"tools": {},
"temperature": {},
"responseMapping": {}
}
},
{
"$ref": "#/components/schemas/AskAssistant"
},
{
"$ref": "#/components/schemas/AskModel"
},
{
"$ref": "#/components/schemas/GenerateVariables"
},
{
"type": "object",
"properties": {
"baseUrl": {},
"apiVersion": {},
"credentialsId": {},
"action": {},
"model": {},
"input": {},
"instructions": {},
"voice": {},
"saveUrlInVariableId": {}
}
},
{
"$ref": "#/components/schemas/CreateTranscription"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/CalCom"
},
{
"$ref": "#/components/schemas/ChatNode"
},
{
"$ref": "#/components/schemas/QrCode"
},
{
"$ref": "#/components/schemas/DifyAi"
},
{
"$ref": "#/components/schemas/Mistral"
},
{
"$ref": "#/components/schemas/Elevenlabs"
},
{
"$ref": "#/components/schemas/Anthropic"
},
{
"$ref": "#/components/schemas/TogetherAi"
},
{
"$ref": "#/components/schemas/OpenRouter"
},
{
"$ref": "#/components/schemas/Nocodb"
},
{
"$ref": "#/components/schemas/Segment"
},
{
"$ref": "#/components/schemas/Groq"
},
{
"$ref": "#/components/schemas/Zendesk"
},
{
"$ref": "#/components/schemas/Posthog"
},
{
"$ref": "#/components/schemas/Perplexity"
},
{
"$ref": "#/components/schemas/Deepseek"
},
{
"$ref": "#/components/schemas/Blink"
},
{
"$ref": "#/components/schemas/Gmail"
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"startCondition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
},
"required": [
"comparisons"
]
},
"sessionExpiryTimeout": {
"type": "number",
"minimum": 0.01,
"maximum": 48,
"description": "Expiration delay in hours after latest interaction"
},
"errorAndMarketingStatusWebhookForwardUrl": {
"type": "string",
"format": "uri"
},
"isWebhookForwardingEnabled": {
"type": "boolean"
},
"webhookForwardingEventTypes": {
"type": "array",
"items": {
"enum": [
"all",
"errorStatuses",
"marketingStatuses"
],
"type": "string"
}
}
}
},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resultsTablePreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"columnsOrder": {
"type": "array",
"items": {
"type": "string"
}
},
"columnsVisibility": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
"columnsWidth": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"columnsOrder",
"columnsVisibility",
"columnsWidth"
]
},
{
"type": "null"
}
]
},
"selectedThemeTemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"version",
"name",
"events",
"groups",
"edges",
"variables",
"theme",
"settings",
"icon",
"folderId"
]
},
{
"type": "object",
"properties": {
"version": {
"enum": [
"3",
"4",
"5"
],
"type": "string"
},
"name": {
"type": "string"
},
"events": {
"type": "null"
},
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"$ref": "#/components/schemas/Image"
},
{
"$ref": "#/components/schemas/Video"
},
{
"$ref": "#/components/schemas/Embed"
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"$ref": "#/components/schemas/NumberInput"
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"$ref": "#/components/schemas/RatingInput"
},
{
"$ref": "#/components/schemas/Cards"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"content": {},
"value": {},
"displayCondition": {}
}
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"dynamicVariableId": {
"type": "string"
},
"isSearchable": {
"type": "boolean"
},
"searchInputPlaceholder": {
"type": "string"
},
"areInitialSearchButtonsVisible": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "file input"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isRequired": {
"type": "boolean"
},
"isMultipleAllowed": {
"type": "boolean"
},
"labels": {
"type": "object",
"properties": {
"placeholder": {},
"button": {},
"clear": {},
"skip": {},
"success": {}
}
},
"allowedFileTypes": {
"type": "object",
"properties": {
"isEnabled": {},
"types": {}
}
},
"capture": {
"enum": [
"environment",
"user"
],
"type": "string"
},
"sizeLimit": {
"type": "number"
},
"visibility": {
"enum": [
"Auto",
"Public",
"Private"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"picture choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"pictureSrc": {},
"title": {},
"description": {},
"value": {},
"displayCondition": {}
}
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"isSearchable": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"searchInputPlaceholder": {
"type": "string"
},
"dynamicItems": {
"type": "object",
"properties": {
"isEnabled": {},
"titlesVariableId": {},
"descriptionsVariableId": {},
"pictureSrcsVariableId": {}
}
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Condition"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"content": {}
}
}
},
"options": {
"not": {}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"AB test"
],
"type": "string"
},
"items": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"path": {}
}
},
{
"type": "object",
"properties": {
"id": {},
"blockId": {},
"outgoingEdgeId": {},
"path": {}
}
}
]
},
"options": {
"type": "object",
"properties": {
"aPercent": {
"type": "number",
"minimum": 0,
"maximum": 100
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"$ref": "#/components/schemas/GoogleAnalytics"
},
{
"$ref": "#/components/schemas/Openai"
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Sheets"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {},
"sheetId": {},
"spreadsheetId": {},
"action": {},
"referenceCell": {},
"filter": {},
"cellsToExtract": {},
"totalRowsToExtract": {}
}
},
{
"$ref": "#/components/schemas/InsertARow"
},
{
"type": "object",
"properties": {
"credentialsId": {},
"sheetId": {},
"spreadsheetId": {},
"action": {},
"cellsToUpsert": {},
"referenceCell": {},
"filter": {}
}
},
{
"type": "object",
"properties": {
"credentialsId": {},
"sheetId": {},
"spreadsheetId": {},
"action": {}
}
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Make.com"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {}
},
"responseVariableMapping": {
"type": "array",
"items": {}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {},
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Pabbly"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {}
},
"responseVariableMapping": {
"type": "array",
"items": {}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {},
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {}
},
"responseVariableMapping": {
"type": "array",
"items": {}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {},
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Zapier"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {}
},
"responseVariableMapping": {
"type": "array",
"items": {}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"id": {},
"queryParams": {},
"headers": {},
"method": {},
"url": {},
"body": {}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"startCondition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
},
"required": [
"comparisons"
]
},
"sessionExpiryTimeout": {
"type": "number",
"minimum": 0.01,
"maximum": 48,
"description": "Expiration delay in hours after latest interaction"
},
"errorAndMarketingStatusWebhookForwardUrl": {
"type": "string",
"format": "uri"
},
"isWebhookForwardingEnabled": {
"type": "boolean"
},
"webhookForwardingEventTypes": {
"type": "array",
"items": {
"enum": [
"all",
"errorStatuses",
"marketingStatuses"
],
"type": "string"
}
}
}
},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resultsTablePreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"columnsOrder": {
"type": "array",
"items": {
"type": "string"
}
},
"columnsVisibility": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
"columnsWidth": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"columnsOrder",
"columnsVisibility",
"columnsWidth"
]
},
{
"type": "null"
}
]
},
"selectedThemeTemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"version",
"name",
"events",
"groups",
"edges",
"variables",
"theme",
"settings",
"icon",
"folderId"
]
}
]
},
"fromTemplate": {
"type": "string"
},
"enableSafetyFlags": {
"type": "boolean"
}
},
"required": [
"workspaceId",
"typebot"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"typebot": {
"type": "object",
"properties": {
"version": {
"enum": [
"6",
"6.1"
],
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"events": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "start"
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
],
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "command"
},
"options": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"resumeAfter": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "reply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "invalidReply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
]
}
},
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"text"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"html": {
"type": "string"
},
"richText": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"plainText": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Image"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"video"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"enum": [
"url",
"youtube",
"vimeo",
"tiktok",
"gumlet"
],
"type": "string"
},
"height": {},
"aspectRatio": {
"type": "string"
},
"maxWidth": {
"type": "string"
},
"queryParamsStr": {
"type": "string"
},
"areControlsDisplayed": {
"type": "boolean"
},
"isAutoplayEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"embed"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"height": {},
"waitForEvent": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"saveDataInVariableId": {
"type": "string"
}
}
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"number input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"labels": {
"type": "object",
"properties": {
"placeholder": {
"type": "string"
},
"button": {
"type": "string"
}
}
},
"min": {},
"max": {},
"step": {},
"locale": {
"type": "string",
"pattern": "^[a-z]{2}(-[A-Z]{2})?$"
},
"style": {
"enum": [
"decimal",
"currency",
"percent",
"unit"
],
"type": "string"
},
"currency": {
"type": "string"
},
"unit": {
"enum": [
"acre",
"bit",
"byte",
"celsius",
"centimeter",
"day",
"degree",
"fahrenheit",
"fluid-ounce",
"foot",
"gallon",
"gigabit",
"gigabyte",
"gram",
"hectare",
"hour",
"inch",
"kilobit",
"kilobyte",
"kilogram",
"kilometer",
"liter",
"megabit",
"megabyte",
"meter",
"microsecond",
"mile",
"mile-scandinavian",
"milliliter",
"millimeter",
"millisecond",
"minute",
"month",
"nanosecond",
"ounce",
"percent",
"petabyte",
"pound",
"second",
"stone",
"terabit",
"terabyte",
"week",
"yard",
"year"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "rating input"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"buttonType": {
"anyOf": [
{
"const": "Icons"
},
{
"const": "Numbers"
}
]
},
"length": {
"type": "number"
},
"startsAt": {},
"labels": {
"type": "object",
"properties": {
"left": {
"type": "string"
},
"right": {
"type": "string"
},
"button": {
"type": "string"
}
}
},
"customIcon": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"svg": {
"type": "string"
}
}
},
"isOneClickSubmitEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Cards"
},
{
"$ref": "#/components/schemas/ChoiceInput"
},
{
"$ref": "#/components/schemas/FileInput"
},
{
"$ref": "#/components/schemas/PictureChoiceInput"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"$ref": "#/components/schemas/Condition"
},
{
"$ref": "#/components/schemas/AbTest"
},
{
"$ref": "#/components/schemas/Webhook"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Analytics"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"trackingId": {
"type": "string"
},
"category": {
"type": "string"
},
"action": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {},
"sendTo": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"OpenAI"
],
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"task": {
"not": {}
},
"credentialsId": {
"type": "string"
},
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"task": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"advancedSettings": {
"type": "object",
"properties": {
"temperature": {}
}
},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"credentialsId": {
"type": "string"
},
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
}
},
"required": [
"task"
]
},
{
"$ref": "#/components/schemas/CreateImage"
},
{
"$ref": "#/components/schemas/CreateSpeech"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"$ref": "#/components/schemas/GoogleSheets"
},
{
"$ref": "#/components/schemas/Make.com"
},
{
"$ref": "#/components/schemas/Pabbly"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"variableId": {},
"value": {}
}
}
},
"responseVariableMapping": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"variableId": {},
"bodyPath": {}
}
}
},
"isCustomBody": {
"type": "boolean"
},
"isExecutedOnClient": {
"type": "boolean"
},
"webhook": {
"type": "object",
"properties": {
"queryParams": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"headers": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
},
"url": {
"type": "string"
},
"body": {
"type": "string"
}
}
},
"timeout": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"proxyCredentialsId": {
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zapier"
}
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "openai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/AskAssistant"
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Ask Model"
},
"model": {
"type": "string"
},
"message": {
"type": "string"
},
"instructions": {
"type": "string"
},
"responseIdVariableId": {
"type": "string"
},
"fileSearchVectorStoreIds": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"fileSearchMaxNumResults": {},
"fileSearchScoreThreshold": {},
"webSearchEnabled": {
"type": "boolean"
},
"codeInterpreterEnabled": {
"type": "boolean"
},
"functions": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Generate variables"
},
"model": {
"type": "string"
},
"prompt": {
"type": "string"
},
"variablesToExtract": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string"
},
"apiVersion": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create speech"
},
"model": {
"type": "string"
},
"input": {
"type": "string"
},
"instructions": {
"type": "string"
},
"voice": {
"enum": [
"alloy",
"echo",
"fable",
"onyx",
"nova",
"shimmer"
],
"type": "string"
},
"saveUrlInVariableId": {
"type": "string"
}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/CreateTranscription"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/CalCom"
},
{
"$ref": "#/components/schemas/ChatNode"
},
{
"$ref": "#/components/schemas/QrCode"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "dify-ai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create Chat Message"
},
"query": {
"type": "string"
},
"conversationVariableId": {
"type": "string"
},
"user": {
"type": "string"
},
"inputs": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"responseMapping": {}
},
"required": [
"action"
]
},
{
"$ref": "#/components/schemas/QueryKnowledgeBase"
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "mistral"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Generate variables"
},
"model": {
"type": "string"
},
"prompt": {
"type": "string"
},
"variablesToExtract": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Elevenlabs"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "anthropic"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create Chat Message"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"systemMessage": {
"type": "string"
},
"temperature": {},
"maxTokens": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Generate variables"
},
"model": {
"type": "string"
},
"prompt": {
"type": "string"
},
"variablesToExtract": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "together-ai"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "open-router"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Nocodb"
},
{
"$ref": "#/components/schemas/Segment"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "groq"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zendesk"
},
{
"$ref": "#/components/schemas/Posthog"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "perplexity"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "deepseek"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Create chat completion"
},
"model": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"tools": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"temperature": {},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "blink"
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/GetUsers"
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Send Feed Event"
},
"categoryId": {
"type": "string"
},
"ribbonColor": {
"type": "string"
},
"sections": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"allowComments": {
"type": "boolean"
},
"allowReactions": {
"type": "boolean"
},
"userIds": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"groupIds": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
},
"pushNotification": {
"type": "object",
"properties": {
"title": {},
"text": {}
}
},
"responseMapping": {
"type": "array",
"items": {
"anyOf": [
{},
{
"type": "null"
}
]
}
}
},
"required": [
"action"
]
},
{
"type": "object",
"properties": {
"credentialsId": {
"type": "string"
},
"action": {
"const": "Redirect"
},
"url": {
"type": "string"
}
},
"required": [
"action"
]
}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Gmail"
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"selectedThemeTemplateId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"icon": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"publicId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"customDomain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string",
"minLength": 1
},
"resultsTablePreferences": {
"anyOf": [
{
"type": "object",
"properties": {
"columnsOrder": {
"type": "array",
"items": {
"type": "string"
}
},
"columnsVisibility": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
"columnsWidth": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "number"
}
}
},
"required": [
"columnsOrder",
"columnsVisibility",
"columnsWidth"
]
},
{
"type": "null"
}
]
},
"isArchived": {
"type": "boolean"
},
"isClosed": {
"type": "boolean"
},
"whatsAppCredentialsId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"riskLevel": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"spaceId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"version",
"id",
"name",
"events",
"groups",
"edges",
"variables",
"theme",
"selectedThemeTemplateId",
"settings",
"createdAt",
"updatedAt",
"icon",
"folderId",
"publicId",
"customDomain",
"workspaceId",
"resultsTablePreferences",
"isArchived",
"isClosed",
"whatsAppCredentialsId",
"riskLevel",
"spaceId"
]
}
},
"required": [
"typebot"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots/{typebotId}/webhookBlocks": {
"get": {
"operationId": "httpRequest-listHttpRequestBlocks",
"summary": "List HTTP request blocks",
"description": "Returns a list of all the HTTP request blocks that you can subscribe to.",
"tags": [
"HTTP request"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"webhookBlocks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"Webhook",
"Zapier",
"Make.com",
"Pabbly"
],
"type": "string"
},
"label": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"id",
"type",
"label"
]
}
}
},
"required": [
"webhookBlocks"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots/{typebotId}/webhookBlocks/{blockId}/getResultExample": {
"get": {
"operationId": "httpRequest-getResultExample",
"summary": "Get result example",
"description": "Returns \"fake\" result for http request block to help you anticipate how the webhook will behave.",
"tags": [
"HTTP request"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "blockId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resultExample": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {},
"description": "Can contain any fields."
}
},
"required": [
"resultExample"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots/{typebotId}/webhookBlocks/{blockId}/subscribe": {
"post": {
"operationId": "httpRequest-subscribeHttpRequest",
"summary": "Subscribe to HTTP request block",
"tags": [
"HTTP request"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "blockId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"required": [
"url"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"url"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots/{typebotId}/webhookBlocks/{blockId}/unsubscribe": {
"post": {
"operationId": "httpRequest-unsubscribeHttpRequest",
"summary": "Unsubscribe from HTTP request block",
"tags": [
"HTTP request"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "blockId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"required": []
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"url"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots/{typebotId}/results": {
"get": {
"operationId": "results-getResults",
"summary": "List results ordered by descending creation date",
"tags": [
"Results"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "number",
"minimum": 1,
"maximum": 500,
"default": 50
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"type": "number"
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "timeFilter",
"in": "query",
"required": false,
"schema": {
"enum": [
"today",
"last7Days",
"last30Days",
"monthToDate",
"lastMonth",
"yearToDate",
"allTime"
],
"type": "string",
"default": "last7Days"
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "timeZone",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"typebotId": {
"type": "string"
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
}
},
"required": [
"id",
"name",
"value"
]
}
},
"isCompleted": {
"type": "boolean"
},
"hasStarted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isArchived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"lastChatSessionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"answers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"content": {
"type": "string"
},
"attachedFileUrls": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"blockId",
"content"
]
}
}
},
"required": [
"id",
"createdAt",
"typebotId",
"variables",
"isCompleted",
"hasStarted",
"isArchived",
"lastChatSessionId",
"answers"
]
}
},
"nextCursor": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"required": [
"results"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
},
"delete": {
"operationId": "results-deleteResults",
"summary": "Delete results",
"tags": [
"Results"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resultIds": {
"type": "string",
"description": "Comma separated list of ids. If not provided, all results will be deleted. ⚠️"
}
},
"required": []
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"not": {}
},
{
"not": {}
}
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots/{typebotId}/results/{resultId}": {
"get": {
"operationId": "results-getResult",
"summary": "Get result by id",
"tags": [
"Results"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
}
},
{
"name": "resultId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The `resultId` is returned by the /startChat endpoint or you can find it by listing results with `/results` endpoint"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"result": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"typebotId": {
"type": "string"
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
}
},
"required": [
"id",
"name",
"value"
]
}
},
"isCompleted": {
"type": "boolean"
},
"hasStarted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"isArchived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"lastChatSessionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"answers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"content": {
"type": "string"
},
"attachedFileUrls": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"blockId",
"content"
]
}
}
},
"required": [
"id",
"createdAt",
"typebotId",
"variables",
"isCompleted",
"hasStarted",
"isArchived",
"lastChatSessionId",
"answers"
]
}
},
"required": [
"result"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots/{typebotId}/results/{resultId}/transcript": {
"get": {
"operationId": "results-getResultTranscript",
"summary": "Get result transcript",
"tags": [
"Results"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
}
},
{
"name": "resultId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The `resultId` is returned by the /startChat endpoint or you can find it by listing results with `/results` endpoint"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"transcript": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"enum": [
"bot",
"user"
],
"type": "string"
},
"type": {
"enum": [
"text",
"image",
"video",
"audio"
],
"type": "string"
},
"text": {
"type": "string"
},
"image": {
"type": "string"
},
"video": {
"type": "string"
},
"audio": {
"type": "string"
}
},
"required": [
"role",
"type"
]
}
}
},
"required": [
"transcript"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots/{typebotId}/results/{resultId}/logs": {
"get": {
"operationId": "results-getResultLogs",
"summary": "List result logs",
"tags": [
"Results"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
}
},
{
"name": "resultId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"logs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"resultId": {
"type": "string"
},
"status": {
"type": "string"
},
"description": {
"type": "string"
},
"details": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"context": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"createdAt",
"resultId",
"status",
"description",
"details",
"context"
]
}
}
},
"required": [
"logs"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/typebots/{typebotId}/results/{resultId}/blocks/{blockId}/{fileName}": {
"get": {
"operationId": "results.getResultBlockFile",
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resultId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "blockId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fileName",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"302": {
"description": "OK",
"headers": {
"location": {
"schema": {
"type": "string"
},
"required": true
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/themeTemplates": {
"get": {
"operationId": "theme-listThemeTemplates",
"summary": "List theme templates",
"tags": [
"Theme template"
],
"parameters": [
{
"name": "workspaceId",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"themeTemplates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
}
},
"required": [
"id",
"name",
"theme"
]
}
}
},
"required": [
"themeTemplates"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/themeTemplates/{themeTemplateId}": {
"put": {
"operationId": "theme-saveThemeTemplate",
"summary": "Save theme template",
"tags": [
"Theme template"
],
"parameters": [
{
"name": "themeTemplateId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string"
},
"name": {
"type": "string"
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
}
},
"required": [
"workspaceId",
"name",
"theme"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"themeTemplate": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"workspaceId": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"id",
"name",
"theme",
"workspaceId",
"createdAt",
"updatedAt"
]
}
},
"required": [
"themeTemplate"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
},
"delete": {
"operationId": "theme-deleteThemeTemplate",
"summary": "Delete a theme template",
"tags": [
"Theme template"
],
"parameters": [
{
"name": "themeTemplateId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string"
}
},
"required": [
"workspaceId"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"themeTemplate": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"workspaceId": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"id",
"name",
"theme",
"workspaceId",
"createdAt",
"updatedAt"
]
}
},
"required": [
"themeTemplate"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots/{typebotId}/collaborators": {
"get": {
"operationId": "collaborators-getCollaborators",
"summary": "Get collaborators",
"tags": [
"Collaborators"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"collaborators": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"enum": [
"READ",
"WRITE",
"FULL_ACCESS"
],
"type": "string"
},
"userId": {
"type": "string"
},
"typebotId": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"user": {
"type": "object",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"image",
"email"
]
}
},
"required": [
"type",
"userId",
"typebotId",
"createdAt",
"updatedAt",
"user"
]
}
}
},
"required": [
"collaborators"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/custom-domains": {
"post": {
"operationId": "customDomains-createCustomDomain",
"summary": "Create custom domain",
"tags": [
"Custom domains"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"workspaceId",
"name"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"customDomain": {
"type": "object",
"properties": {
"name": {},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"createdAt"
]
}
},
"required": [
"customDomain"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
},
"get": {
"operationId": "customDomains-listCustomDomains",
"summary": "List custom domains",
"tags": [
"Custom domains"
],
"parameters": [
{
"name": "workspaceId",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"customDomains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"createdAt"
]
}
}
},
"required": [
"customDomains"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/custom-domains/{name}": {
"delete": {
"operationId": "customDomains-deleteCustomDomain",
"summary": "Delete custom domain",
"tags": [
"Custom domains"
],
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string"
}
},
"required": [
"workspaceId"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"const": "success"
}
},
"required": [
"message"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/custom-domains/{name}/verify": {
"get": {
"operationId": "customDomains-verifyCustomDomain",
"summary": "Verify domain config",
"tags": [
"Custom domains"
],
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "workspaceId",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"enum": [
"Valid Configuration",
"Invalid Configuration",
"Domain Not Found",
"Pending Verification",
"Unknown Error"
],
"type": "string"
},
"domainJson": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"apexName": {
"type": "string"
},
"projectId": {
"type": "string"
},
"redirect": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"redirectStatusCode": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"gitBranch": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"updatedAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"createdAt": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"verified": {
"type": "boolean"
},
"verification": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"domain": {
"type": "string"
},
"value": {
"type": "string"
},
"reason": {
"type": "string"
}
},
"required": [
"type",
"domain",
"value",
"reason"
]
}
}
},
"required": [
"name",
"apexName",
"projectId",
"redirect",
"redirectStatusCode",
"gitBranch",
"updatedAt",
"createdAt",
"verified"
]
}
},
"required": [
"status",
"domainJson"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/whatsapp/preview/webhook": {
"post": {
"operationId": "whatsApp.previewWebhookProcedure",
"tags": [
"WhatsApp"
],
"parameters": [
{
"name": "x-hub-signature-256",
"in": "header",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"const": "Message received"
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
}
},
"get": {
"operationId": "whatsApp-subscribePreviewWebhook",
"summary": "Subscribe webhook",
"tags": [
"WhatsApp"
],
"parameters": [
{
"name": "hub.challenge",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "hub.verify_token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "number"
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
}
}
},
"/v1/typebots/{typebotId}/whatsapp/start-preview": {
"post": {
"operationId": "whatsApp-startWhatsAppPreview",
"summary": "Start preview",
"tags": [
"WhatsApp"
],
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"to": {
"type": "string",
"minLength": 1
},
"startFrom": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"const": "group"
},
"groupId": {
"type": "string"
}
},
"required": [
"type",
"groupId"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "event"
},
"eventId": {
"type": "string"
}
},
"required": [
"type",
"eventId"
]
}
]
}
},
"required": [
"to"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/typebots/{typebotId}/whatsapp/media/{mediaId}": {
"get": {
"operationId": "whatsApp.getWhatsAppMedia",
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "mediaId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"content-type": {
"schema": {
"type": "string"
},
"required": true
},
"cache-control": {
"schema": {
"type": "string"
},
"required": true
}
},
"content": {
"application/json": {
"schema": {
"not": {}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/typebots/{typebotId}/whatsapp/media/preview/{mediaId}": {
"get": {
"operationId": "whatsApp.getWhatsAppMediaPreview",
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "mediaId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"headers": {
"content-type": {
"schema": {
"type": "string"
},
"required": true
},
"cache-control": {
"schema": {
"type": "string"
},
"required": true
}
},
"content": {
"application/json": {
"schema": {
"not": {}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/folders/{folderId}": {
"get": {
"operationId": "folders-getFolder",
"summary": "Get folder",
"tags": [
"Folder"
],
"parameters": [
{
"name": "folderId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "workspaceId",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"folder": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"name": {
"type": "string"
},
"parentFolderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string"
}
},
"required": [
"id",
"createdAt",
"updatedAt",
"name",
"parentFolderId",
"workspaceId"
]
}
},
"required": [
"folder"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
},
"patch": {
"operationId": "folders-updateFolder",
"summary": "Update a folder",
"tags": [
"Folder"
],
"parameters": [
{
"name": "folderId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string"
},
"folder": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"parentFolderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
}
},
"required": [
"workspaceId",
"folder"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"folder": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"name": {
"type": "string"
},
"parentFolderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string"
}
},
"required": [
"id",
"createdAt",
"updatedAt",
"name",
"parentFolderId",
"workspaceId"
]
}
},
"required": [
"folder"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
},
"delete": {
"operationId": "folders-deleteFolder",
"summary": "Delete a folder",
"tags": [
"Folder"
],
"parameters": [
{
"name": "folderId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string"
}
},
"required": [
"workspaceId"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"folder": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"name": {
"type": "string"
},
"parentFolderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string"
}
},
"required": [
"id",
"createdAt",
"updatedAt",
"name",
"parentFolderId",
"workspaceId"
]
}
},
"required": [
"folder"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/folders": {
"post": {
"operationId": "folders-createFolder",
"summary": "Create a folder",
"tags": [
"Folder"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-z]+$"
},
"folderName": {
"type": "string"
},
"workspaceId": {
"type": "string"
},
"parentFolderId": {
"type": "string"
}
},
"required": [
"workspaceId"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"folder": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"name": {
"type": "string"
},
"parentFolderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workspaceId": {
"type": "string"
}
},
"required": [
"id",
"createdAt",
"updatedAt",
"name",
"parentFolderId",
"workspaceId"
]
}
},
"required": [
"folder"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
},
"get": {
"operationId": "folders-listFolders",
"summary": "List folders",
"tags": [
"Folder"
],
"parameters": [
{
"name": "workspaceId",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "parentFolderId",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"folders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"id",
"name",
"createdAt"
]
}
}
},
"required": [
"folders"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/emails/unsubscribe": {
"post": {
"operationId": "emails.unsubscribe",
"summary": "Unsubscribe email",
"tags": [
"Email"
],
"parameters": [
{
"name": "email",
"in": "query",
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "token",
"in": "query",
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"202": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
}
}
},
"/emails/unsubscribe/resubscribe": {
"post": {
"operationId": "emails.resubscribe",
"summary": "Resubscribe email",
"tags": [
"Email"
],
"parameters": [
{
"name": "email",
"in": "query",
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "token",
"in": "query",
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"enum": [
"resubscribed",
"already-subscribed",
"blocked",
"unknown",
"invalid"
],
"type": "string"
}
},
"required": [
"status"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
}
}
},
"/v1/users/me": {
"patch": {
"operationId": "user-update",
"tags": [
"User"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"updates": {
"type": "object",
"properties": {
"onboardingCategories": {
"type": "array",
"items": {
"type": "string"
}
},
"displayedInAppNotifications": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
{
"type": "null"
}
]
},
"groupTitlesAutoGeneration": {
"anyOf": [
{
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"provider": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"model": {
"type": "string"
},
"prompt": {
"type": "string"
}
}
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"company": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"graphNavigation": {
"anyOf": [
{
"enum": [
"MOUSE",
"TRACKPAD"
],
"type": "string"
},
{
"type": "null"
}
]
},
"preferredAppAppearance": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"preferredLanguage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"referral": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
}
},
"required": [
"updates"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"email": {
"type": "string"
},
"image": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"company": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"lastActivityAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"graphNavigation": {
"anyOf": [
{
"enum": [
"MOUSE",
"TRACKPAD"
],
"type": "string"
},
{
"type": "null"
}
]
},
"preferredAppAppearance": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"displayedInAppNotifications": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
},
{
"type": "null"
}
]
},
"groupTitlesAutoGeneration": {
"anyOf": [
{
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"provider": {
"type": "string"
},
"credentialsId": {
"type": "string"
},
"model": {
"type": "string"
},
"prompt": {
"type": "string"
}
}
},
{
"type": "null"
}
]
},
"preferredLanguage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"termsAcceptedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"email",
"image",
"company",
"createdAt",
"lastActivityAt",
"graphNavigation",
"preferredAppAppearance",
"displayedInAppNotifications",
"groupTitlesAutoGeneration",
"preferredLanguage",
"termsAcceptedAt"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/users/me/api-tokens": {
"get": {
"operationId": "user-listApiTokens",
"tags": [
"User"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"apiTokens": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"id",
"name",
"createdAt"
]
}
}
},
"required": [
"apiTokens"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
},
"post": {
"operationId": "user-createApiToken",
"tags": [
"User"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"apiToken": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"token": {
"type": "string"
}
},
"required": [
"id",
"name",
"createdAt",
"token"
]
}
},
"required": [
"apiToken"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/users/me/api-tokens/{tokenId}": {
"delete": {
"operationId": "user-deleteApiToken",
"tags": [
"User"
],
"parameters": [
{
"name": "tokenId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"required": []
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"apiToken": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"token": {
"type": "string"
},
"ownerId": {
"type": "string"
}
},
"required": [
"id",
"name",
"createdAt",
"token",
"ownerId"
]
}
},
"required": [
"apiToken"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/mock/fail": {
"post": {
"operationId": "httpRequestSpecMocks.fail",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"anyOf": [
{},
{
"not": {}
}
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
}
}
},
"/mock/mirror-body": {
"post": {
"operationId": "httpRequestSpecMocks.mirrorBody",
"requestBody": {
"content": {
"application/json": {
"schema": {}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"anyOf": [
{},
{
"not": {}
}
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
}
}
},
"/s3/private/{rest}": {
"get": {
"operationId": "fileInput.getPrivateFile",
"parameters": [
{
"name": "rest",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"307": {
"description": "OK",
"headers": {
"location": {
"schema": {
"type": "string"
},
"required": true
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v3/generate-upload-url": {
"post": {
"operationId": "fileInput.generateUploadUrlProcedure",
"summary": "Generate upload URL",
"description": "Used to upload anything from the client to S3 bucket",
"tags": [
"File upload"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sessionId": {
"type": "string"
},
"blockId": {
"type": "string"
},
"fileName": {
"type": "string"
},
"fileType": {
"type": "string"
},
"fileSize": {
"type": "number"
}
},
"required": [
"sessionId",
"blockId",
"fileName"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"presignedUrl": {
"type": "string"
},
"formData": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"fileType": {
"type": "string"
},
"maxFileSize": {
"type": "number"
},
"fileUrl": {
"type": "string"
}
},
"required": [
"presignedUrl",
"formData",
"fileUrl"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
}
}
},
"/credentials/google-sheets/consent-url": {
"get": {
"operationId": "sheets.getConsentUrl",
"parameters": [
{
"name": "redirectUrl",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "workspaceId",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "typebotId",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "blockId",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"302": {
"description": "OK",
"headers": {
"location": {
"schema": {
"type": "string"
},
"required": true
},
"set-cookie": {
"schema": {
"type": "string"
},
"required": true
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/credentials/google-sheets/callback": {
"get": {
"operationId": "sheets.handleCallback",
"parameters": [
{
"name": "code",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "state",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"302": {
"description": "OK",
"headers": {
"location": {
"schema": {
"type": "string"
},
"required": true
},
"set-cookie": {
"schema": {
"type": "string"
},
"required": true
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/resend/webhook": {
"post": {
"operationId": "email.resendWebhook",
"summary": "Handle Resend webhook",
"tags": [
"Email"
],
"parameters": [
{
"name": "svix-id",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "svix-timestamp",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "svix-signature",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
}
}
},
"/v1/sessions/{sessionId}/continueChat": {
"post": {
"operationId": "chat.continueChatProcedure",
"parameters": [
{
"name": "sessionId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The session ID you got from the [startChat](./start-chat) response."
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"const": "text"
},
"text": {
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"replyId": {
"type": "string"
}
}
},
"attachedFileUrls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Can only be provided if current input block is a text input block that allows attachments"
}
},
"required": [
"type",
"text"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "audio"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"description": "Can only be provided if current input block is a text input block that allows audio clips"
},
{
"type": "object",
"properties": {
"type": {
"const": "command"
},
"command": {
"type": "string"
}
},
"required": [
"type",
"command"
]
}
]
},
{
"type": "null"
}
]
},
"textBubbleContentFormat": {
"enum": [
"richText",
"markdown"
],
"type": "string",
"default": "richText"
}
},
"required": []
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"lastMessageNewFormat": {
"type": "string",
"description": "The sent message is validated and formatted on the backend. For example, if for a date input you replied something like `tomorrow`, the backend will convert it to a date string. This field returns the formatted message."
},
"messages": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"const": "text"
},
"content": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"const": "richText"
},
"richText": {}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "markdown"
},
"markdown": {
"type": "string"
}
},
"required": [
"type",
"markdown"
]
}
]
}
},
"required": [
"type",
"content"
]
},
{
"type": "object",
"properties": {
"type": {
"enum": [
"image"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"clickLink": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"alt": {
"type": "string"
}
}
}
}
}
},
"required": [
"type",
"content"
]
},
{
"type": "object",
"properties": {
"type": {
"enum": [
"video"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"enum": [
"url",
"youtube",
"vimeo",
"tiktok",
"gumlet"
],
"type": "string"
},
"height": {},
"aspectRatio": {
"type": "string"
},
"maxWidth": {
"type": "string"
},
"queryParamsStr": {
"type": "string"
},
"areControlsDisplayed": {
"type": "boolean"
},
"isAutoplayEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"type",
"content"
]
},
{
"type": "object",
"properties": {
"type": {
"enum": [
"audio"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"isAutoplayEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"type",
"content"
]
},
{
"type": "object",
"properties": {
"type": {
"enum": [
"embed"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"height": {},
"waitForEvent": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"saveDataInVariableId": {
"type": "string"
}
}
}
}
}
},
"required": [
"type",
"content"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "custom-embed"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"waitForEventFunction": {
"type": "object",
"properties": {
"args": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"content": {
"type": "string"
}
},
"required": [
"args",
"content"
]
},
"initFunction": {
"type": "object",
"properties": {
"args": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"content": {
"type": "string"
}
},
"required": [
"args",
"content"
]
}
},
"required": [
"initFunction"
]
}
},
"required": [
"type",
"content"
]
}
]
}
]
}
},
"input": {
"allOf": [
{
"anyOf": [
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/ChoiceInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"number input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"labels": {
"type": "object",
"properties": {
"placeholder": {
"type": "string"
},
"button": {
"type": "string"
}
}
},
"min": {},
"max": {},
"step": {},
"locale": {
"type": "string",
"pattern": "^[a-z]{2}(-[A-Z]{2})?$"
},
"style": {
"enum": [
"decimal",
"currency",
"percent",
"unit"
],
"type": "string"
},
"currency": {
"type": "string"
},
"unit": {
"enum": [
"acre",
"bit",
"byte",
"celsius",
"centimeter",
"day",
"degree",
"fahrenheit",
"fluid-ounce",
"foot",
"gallon",
"gigabit",
"gigabyte",
"gram",
"hectare",
"hour",
"inch",
"kilobit",
"kilobyte",
"kilogram",
"kilometer",
"liter",
"megabit",
"megabyte",
"meter",
"microsecond",
"mile",
"mile-scandinavian",
"milliliter",
"millimeter",
"millisecond",
"minute",
"month",
"nanosecond",
"ounce",
"percent",
"petabyte",
"pound",
"second",
"stone",
"terabit",
"terabyte",
"week",
"yard",
"year"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "rating input"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"buttonType": {
"anyOf": [
{
"const": "Icons"
},
{
"const": "Numbers"
}
]
},
"length": {
"type": "number"
},
"startsAt": {},
"labels": {
"type": "object",
"properties": {
"left": {
"type": "string"
},
"right": {
"type": "string"
},
"button": {
"type": "string"
}
}
},
"customIcon": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"svg": {
"type": "string"
}
}
},
"isOneClickSubmitEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/FileInput"
},
{
"$ref": "#/components/schemas/PictureChoiceInput"
},
{
"$ref": "#/components/schemas/Cards"
}
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"content": {
"type": "string"
},
"value": {
"type": "string"
},
"displayCondition": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"condition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"variableId": {},
"comparisonOperator": {},
"value": {}
}
}
}
}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"dynamicVariableId": {
"type": "string"
},
"isSearchable": {
"type": "boolean"
},
"searchInputPlaceholder": {
"type": "string"
},
"areInitialSearchButtonsVisible": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "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"
},
"success": {
"type": "object",
"properties": {
"single": {
"type": "string"
},
"multiple": {
"type": "string"
}
}
}
}
},
"allowedFileTypes": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"capture": {
"enum": [
"environment",
"user"
],
"type": "string"
},
"sizeLimit": {
"type": "number"
},
"visibility": {
"enum": [
"Auto",
"Public",
"Private"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"picture choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"pictureSrc": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"value": {
"type": "string"
},
"displayCondition": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"condition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"variableId": {},
"comparisonOperator": {},
"value": {}
}
}
}
}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"isSearchable": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"searchInputPlaceholder": {
"type": "string"
},
"dynamicItems": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"titlesVariableId": {
"type": "string"
},
"descriptionsVariableId": {
"type": "string"
},
"pictureSrcsVariableId": {
"type": "string"
}
}
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
}
]
},
{
"type": "object",
"properties": {
"prefilledValue": {
"type": "string"
},
"runtimeOptions": {
"type": "object",
"properties": {
"paymentIntentSecret": {
"type": "string"
},
"amountLabel": {
"type": "string"
},
"publicKey": {
"type": "string"
}
},
"required": [
"paymentIntentSecret",
"amountLabel",
"publicKey"
]
}
}
}
]
},
"clientSideActions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"const": "scriptToExecute"
},
"scriptToExecute": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"isUnsafe": {
"type": "boolean"
},
"isCode": {
"type": "boolean"
},
"args": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "boolean"
}
]
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id"
]
}
}
},
"required": [
"content",
"args"
]
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"scriptToExecute"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "redirect"
},
"redirect": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"isNewTab": {
"type": "boolean"
}
}
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"redirect"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "chatwoot"
},
"chatwoot": {
"type": "object",
"properties": {
"scriptToExecute": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"isUnsafe": {
"type": "boolean"
},
"isCode": {
"type": "boolean"
},
"args": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{},
{}
]
},
{
"type": "boolean"
}
]
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id"
]
}
}
},
"required": [
"content",
"args"
]
}
},
"required": [
"scriptToExecute"
]
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"chatwoot"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "googleAnalytics"
},
"googleAnalytics": {
"type": "object",
"properties": {
"trackingId": {
"type": "string"
},
"category": {
"type": "string"
},
"action": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {},
"sendTo": {
"type": "string"
}
}
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"googleAnalytics"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "wait"
},
"wait": {
"type": "object",
"properties": {
"secondsToWaitFor": {
"type": "number"
}
},
"required": [
"secondsToWaitFor"
]
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"wait"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "setVariable"
},
"setVariable": {
"type": "object",
"properties": {
"scriptToExecute": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"isUnsafe": {
"type": "boolean"
},
"isCode": {
"type": "boolean"
},
"args": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{},
{}
]
},
{
"type": "boolean"
}
]
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id"
]
}
}
},
"required": [
"content",
"args"
]
}
},
"required": [
"scriptToExecute"
]
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"setVariable"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "streamOpenAiChatCompletion"
},
"streamOpenAiChatCompletion": {
"type": "object",
"properties": {
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"role": {
"enum": [
"system",
"user",
"assistant"
],
"type": "string"
}
}
}
}
},
"required": [
"messages"
]
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"streamOpenAiChatCompletion"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "httpRequestToExecute"
},
"httpRequestToExecute": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"headers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"body": {},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
}
},
"required": [
"url"
]
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"httpRequestToExecute"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "startPropsToInject"
},
"startPropsToInject": {
"type": "object",
"properties": {
"googleAnalyticsId": {
"type": "string"
},
"pixelIds": {
"type": "array",
"items": {
"type": "string"
}
},
"gtmId": {
"type": "string"
},
"customHeadCode": {
"type": "string"
}
}
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"startPropsToInject"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "pixel"
},
"pixel": {
"anyOf": [
{
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/Lead"
},
{
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Custom"
],
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"eventType"
]
}
]
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"pixel"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "stream"
},
"stream": {
"const": true
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"stream"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "codeToExecute"
},
"codeToExecute": {
"type": "object",
"properties": {
"args": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"content": {
"type": "string"
}
},
"required": [
"args",
"content"
]
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"codeToExecute"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "listenForWebhook"
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type"
]
}
]
},
"description": "Actions to execute on the client side"
},
"logs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"description": {
"type": "string"
},
"details": {
"type": "string"
},
"context": {
"type": "string"
}
},
"required": [
"description"
]
},
"description": "Logs that were saved during the last execution"
},
"dynamicTheme": {
"type": "object",
"properties": {
"hostAvatarUrl": {
"type": "string"
},
"guestAvatarUrl": {
"type": "string"
},
"backgroundUrl": {
"type": "string"
}
},
"description": "If the typebot contains dynamic avatars, dynamicTheme returns the new avatar URLs whenever their variables are updated."
},
"progress": {
"type": "number",
"description": "If progress bar is enabled, this field will return a number between 0 and 100 indicating the current progress based on the longest remaining path of the flow."
}
},
"required": [
"messages"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/typebots/{typebotId}/preview/startChat": {
"post": {
"operationId": "chat.startChatPreviewProcedure",
"parameters": [
{
"name": "typebotId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my bot's ID?](../how-to#how-to-find-my-typebotid)"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"typebot": {
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"version": {
"enum": [
"6",
"6.1"
],
"type": "string"
},
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"$ref": "#/components/schemas/Image"
},
{
"$ref": "#/components/schemas/Video"
},
{
"$ref": "#/components/schemas/Embed"
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"$ref": "#/components/schemas/NumberInput"
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"$ref": "#/components/schemas/RatingInput"
},
{
"$ref": "#/components/schemas/Cards"
},
{
"$ref": "#/components/schemas/ChoiceInput"
},
{
"$ref": "#/components/schemas/FileInput"
},
{
"$ref": "#/components/schemas/PictureChoiceInput"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"$ref": "#/components/schemas/Condition"
},
{
"$ref": "#/components/schemas/AbTest"
},
{
"$ref": "#/components/schemas/Webhook"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"$ref": "#/components/schemas/GoogleAnalytics"
},
{
"$ref": "#/components/schemas/Openai"
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"$ref": "#/components/schemas/GoogleSheets"
},
{
"$ref": "#/components/schemas/Make.com"
},
{
"$ref": "#/components/schemas/Pabbly"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {},
"responseVariableMapping": {},
"isCustomBody": {},
"isExecutedOnClient": {},
"webhook": {},
"timeout": {},
"proxyCredentialsId": {}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/Zapier"
}
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "openai"
},
"options": {
"anyOf": [
{},
{},
{},
{},
{},
{},
{}
]
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/CalCom"
},
{
"$ref": "#/components/schemas/ChatNode"
},
{
"$ref": "#/components/schemas/QrCode"
},
{
"$ref": "#/components/schemas/DifyAi"
},
{
"$ref": "#/components/schemas/Mistral"
},
{
"$ref": "#/components/schemas/Elevenlabs"
},
{
"$ref": "#/components/schemas/Anthropic"
},
{
"$ref": "#/components/schemas/TogetherAi"
},
{
"$ref": "#/components/schemas/OpenRouter"
},
{
"$ref": "#/components/schemas/Nocodb"
},
{
"$ref": "#/components/schemas/Segment"
},
{
"$ref": "#/components/schemas/Groq"
},
{
"$ref": "#/components/schemas/Zendesk"
},
{
"$ref": "#/components/schemas/Posthog"
},
{
"$ref": "#/components/schemas/Perplexity"
},
{
"$ref": "#/components/schemas/Deepseek"
},
{
"$ref": "#/components/schemas/Blink"
},
{
"$ref": "#/components/schemas/Gmail"
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"events": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "start"
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
],
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "command"
},
"options": {
"type": "object",
"properties": {
"command": {
"type": "string"
},
"resumeAfter": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "reply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"graphCoordinates": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
},
"type": {
"const": "invalidReply"
},
"options": {
"type": "object",
"properties": {
"contentVariableId": {
"type": "string"
},
"inputNameVariableId": {
"type": "string"
},
"inputTypeVariableId": {
"type": "string"
}
}
}
},
"required": [
"id",
"graphCoordinates",
"type"
]
}
]
}
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"startCondition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
},
"required": [
"comparisons"
]
},
"sessionExpiryTimeout": {
"type": "number",
"minimum": 0.01,
"maximum": 48,
"description": "Expiration delay in hours after latest interaction"
},
"errorAndMarketingStatusWebhookForwardUrl": {
"type": "string",
"format": "uri"
},
"isWebhookForwardingEnabled": {
"type": "boolean"
},
"webhookForwardingEventTypes": {
"type": "array",
"items": {
"enum": [
"all",
"errorStatuses",
"marketingStatuses"
],
"type": "string"
}
}
}
},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"workspaceId": {
"type": "string",
"minLength": 1
}
},
"required": [
"version",
"id",
"groups",
"events",
"edges",
"variables",
"settings",
"theme",
"updatedAt",
"workspaceId"
]
},
{
"type": "object",
"properties": {
"version": {
"enum": [
"3",
"4",
"5"
],
"type": "string"
},
"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"
]
},
"blocks": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Start"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Text"
},
{
"$ref": "#/components/schemas/Image"
},
{
"$ref": "#/components/schemas/Video"
},
{
"$ref": "#/components/schemas/Embed"
},
{
"$ref": "#/components/schemas/Audio"
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"$ref": "#/components/schemas/NumberInput"
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"$ref": "#/components/schemas/RatingInput"
},
{
"$ref": "#/components/schemas/Cards"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {}
},
"options": {
"type": "object",
"properties": {
"variableId": {},
"isMultipleChoice": {},
"buttonLabel": {},
"dynamicVariableId": {},
"isSearchable": {},
"searchInputPlaceholder": {},
"areInitialSearchButtonsVisible": {}
}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "file input"
},
"options": {
"type": "object",
"properties": {
"variableId": {},
"isRequired": {},
"isMultipleAllowed": {},
"labels": {},
"allowedFileTypes": {},
"capture": {},
"sizeLimit": {},
"visibility": {}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"picture choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {}
},
"options": {
"type": "object",
"properties": {
"variableId": {},
"isMultipleChoice": {},
"isSearchable": {},
"buttonLabel": {},
"searchInputPlaceholder": {},
"dynamicItems": {}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Code"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/SetVariable"
},
{
"$ref": "#/components/schemas/TypebotLink"
},
{
"$ref": "#/components/schemas/Wait"
},
{
"$ref": "#/components/schemas/Jump"
},
{
"$ref": "#/components/schemas/Return"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Condition"
],
"type": "string"
},
"items": {
"type": "array",
"items": {}
},
"options": {
"not": {}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"AB test"
],
"type": "string"
},
"items": {
"type": "array",
"prefixItems": [
{},
{}
]
},
"options": {
"type": "object",
"properties": {
"aPercent": {}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Chatwoot"
},
{
"$ref": "#/components/schemas/GoogleAnalytics"
},
{
"$ref": "#/components/schemas/Openai"
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/Pixel"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Google Sheets"
],
"type": "string"
},
"options": {
"anyOf": [
{},
{},
{},
{}
]
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Make.com"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {},
"responseVariableMapping": {},
"isCustomBody": {},
"isExecutedOnClient": {},
"webhook": {},
"timeout": {},
"proxyCredentialsId": {}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Pabbly"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {},
"responseVariableMapping": {},
"isCustomBody": {},
"isExecutedOnClient": {},
"webhook": {},
"timeout": {},
"proxyCredentialsId": {}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Webhook"
],
"type": "string",
"description": "Legacy name for HTTP Request block"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {},
"responseVariableMapping": {},
"isCustomBody": {},
"isExecutedOnClient": {},
"webhook": {},
"timeout": {},
"proxyCredentialsId": {}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"Zapier"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variablesForTest": {},
"responseVariableMapping": {},
"isCustomBody": {},
"isExecutedOnClient": {},
"webhook": {},
"timeout": {},
"proxyCredentialsId": {}
}
},
"webhookId": {
"type": "string"
}
},
"required": [
"id",
"type"
]
}
]
}
]
}
}
},
"required": [
"id",
"title",
"graphCoordinates",
"blocks"
]
}
},
"events": {
"type": "null"
},
"edges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"from": {
"anyOf": [
{
"type": "object",
"properties": {
"blockId": {
"type": "string"
},
"itemId": {
"type": "string"
},
"pathId": {
"type": "string"
}
},
"required": [
"blockId"
]
},
{
"type": "object",
"properties": {
"eventId": {
"type": "string"
}
},
"required": [
"eventId"
]
}
]
},
"to": {
"type": "object",
"properties": {
"groupId": {
"type": "string"
},
"blockId": {
"type": "string"
}
},
"required": [
"groupId"
]
}
},
"required": [
"id",
"from",
"to"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"isSessionVariable": {
"type": "boolean"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name"
]
}
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"favIconUrl": {
"type": "string"
},
"customHeadCode": {
"type": "string"
},
"googleTagManagerId": {
"type": "string"
},
"allowIndexing": {
"type": "boolean"
}
}
},
"whatsApp": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"startCondition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"comparisonOperator": {
"enum": [
"Equal to",
"Not equal",
"Contains",
"Does not contain",
"Greater than",
"Greater or equal to",
"Less than",
"Less or equal to",
"Is set",
"Is empty",
"Starts with",
"Ends with",
"Matches regex",
"Does not match regex"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id"
]
}
}
},
"required": [
"comparisons"
]
},
"sessionExpiryTimeout": {
"type": "number",
"minimum": 0.01,
"maximum": 48,
"description": "Expiration delay in hours after latest interaction"
},
"errorAndMarketingStatusWebhookForwardUrl": {
"type": "string",
"format": "uri"
},
"isWebhookForwardingEnabled": {
"type": "boolean"
},
"webhookForwardingEventTypes": {
"type": "array",
"items": {
"enum": [
"all",
"errorStatuses",
"marketingStatuses"
],
"type": "string"
}
}
}
},
"publicShare": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
}
}
},
"security": {
"type": "object",
"properties": {
"allowedOrigins": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"workspaceId": {
"type": "string",
"minLength": 1
}
},
"required": [
"version",
"id",
"groups",
"events",
"edges",
"variables",
"settings",
"theme",
"updatedAt",
"workspaceId"
]
}
]
},
{
"type": "object",
"properties": {
"publicTypebotId": {
"type": "string"
}
}
}
],
"description": "If set, it will override the typebot that is used to start the chat."
},
"sessionId": {
"type": "string",
"description": "If provided, will be used as the session ID and will overwrite any existing session with the same ID."
},
"startFrom": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"const": "group"
},
"groupId": {
"type": "string"
}
},
"required": [
"type",
"groupId"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "event"
},
"eventId": {
"type": "string"
}
},
"required": [
"type",
"eventId"
]
}
]
},
"message": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"const": "text"
},
"text": {
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"replyId": {
"type": "string"
}
}
},
"attachedFileUrls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Can only be provided if current input block is a text input block that allows attachments"
}
},
"required": [
"type",
"text"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "audio"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"description": "Can only be provided if current input block is a text input block that allows audio clips"
},
{
"type": "object",
"properties": {
"type": {
"const": "command"
},
"command": {
"type": "string"
}
},
"required": [
"type",
"command"
]
}
],
"description": "Only provide it if your flow starts with an input block and you'd like to directly provide an answer to it."
},
"isStreamEnabled": {
"type": "boolean",
"default": false,
"description": "If enabled, you will be required to stream OpenAI completions on a client and send the generated response back to the API."
},
"isOnlyRegistering": {
"type": "boolean",
"default": false,
"description": "If set to `true`, it will only register the session and not start the bot. This is used for 3rd party chat platforms as it can require a session to be registered before sending the first message."
},
"prefilledVariables": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {},
"description": "[More info about prefilled variables.](../../editor/variables#prefilled-variables)"
},
"textBubbleContentFormat": {
"enum": [
"richText",
"markdown"
],
"type": "string",
"default": "richText"
}
},
"required": []
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sessionId": {
"type": "string",
"description": "To save and use for /continueChat requests."
},
"typebot": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"version": {
"anyOf": [
{
"enum": [
"3",
"4",
"5"
],
"type": "string"
},
{
"enum": [
"6",
"6.1"
],
"type": "string"
}
]
},
"theme": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"font": {
"anyOf": [
{
"type": "string"
},
{
"anyOf": [
{
"$ref": "#/components/schemas/Google"
},
{
"type": "object",
"properties": {
"type": {
"const": "Custom"
},
"family": {
"type": "string"
},
"css": {
"type": "string"
},
"url": {
"type": "string",
"description": "Deprecated, use `css` instead"
}
},
"required": [
"type"
]
}
]
}
]
},
"background": {
"type": "object",
"properties": {
"type": {
"enum": [
"Color",
"Image",
"None"
],
"type": "string"
},
"content": {
"type": "string"
}
}
},
"progressBar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"color": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"placement": {
"enum": [
"Top",
"Bottom"
],
"type": "string"
},
"thickness": {
"type": "number"
},
"position": {
"enum": [
"fixed",
"absolute"
],
"type": "string"
}
}
}
}
},
"chat": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"maxWidth": {
"type": "string"
},
"maxHeight": {
"type": "string"
},
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"hostAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"guestAvatar": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"url": {
"type": "string"
}
}
},
"hostBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"guestBubbles": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"buttons": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
}
}
},
"inputs": {
"type": "object",
"properties": {
"backgroundColor": {
"type": "string"
},
"color": {
"type": "string"
},
"blur": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
},
"shadow": {
"enum": [
"none",
"sm",
"md",
"lg",
"xl",
"2xl"
],
"type": "string"
},
"border": {
"type": "object",
"properties": {
"thickness": {
"type": "number"
},
"color": {
"type": "string"
},
"roundeness": {
"enum": [
"none",
"medium",
"large",
"custom"
],
"type": "string"
},
"customRoundeness": {
"type": "number"
},
"opacity": {
"type": "number",
"minimum": 0,
"maximum": 1
}
}
},
"placeholderColor": {
"type": "string"
}
}
},
"roundness": {
"enum": [
"none",
"medium",
"large"
],
"type": "string",
"description": "Deprecated, use `container.border.roundeness` instead"
},
"buttonsInput": {
"type": "object",
"properties": {
"layout": {
"enum": [
"wrap",
"vertical"
],
"type": "string"
}
}
}
}
},
"customCss": {
"type": "string"
}
}
},
"settings": {
"type": "object",
"properties": {
"general": {
"type": "object",
"properties": {
"isBrandingEnabled": {
"type": "boolean"
},
"isTypingEmulationEnabled": {
"type": "boolean"
},
"isInputPrefillEnabled": {
"type": "boolean"
},
"isHideQueryParamsEnabled": {
"type": "boolean"
},
"isNewResultOnRefreshEnabled": {
"type": "boolean"
},
"rememberUser": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"storage": {
"enum": [
"session",
"local"
],
"type": "string"
}
}
},
"systemMessages": {
"type": "object",
"properties": {
"invalidMessage": {
"type": "string"
},
"botClosed": {
"type": "string"
},
"networkErrorTitle": {
"type": "string"
},
"networkErrorMessage": {
"type": "string"
},
"popupBlockedTitle": {
"type": "string"
},
"popupBlockedDescription": {
"type": "string"
},
"popupBlockedButtonLabel": {
"type": "string"
},
"fileUploadError": {
"type": "string"
},
"fileUploadSizeError": {
"type": "string"
},
"whatsAppPictureChoiceSelectLabel": {
"type": "string"
}
}
}
}
},
"typingEmulation": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"speed": {
"type": "number"
},
"maxDelay": {
"type": "number"
},
"delayBetweenBubbles": {
"type": "number",
"minimum": 0,
"maximum": 5
},
"isDisabledOnFirstMessage": {
"type": "boolean"
}
}
}
}
},
"publishedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"id",
"version",
"theme",
"settings"
]
},
"lastMessageNewFormat": {
"type": "string",
"description": "The sent message is validated and formatted on the backend. For example, if for a date input you replied something like `tomorrow`, the backend will convert it to a date string. This field returns the formatted message."
},
"messages": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"const": "text"
},
"content": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"const": "richText"
},
"richText": {}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "markdown"
},
"markdown": {
"type": "string"
}
},
"required": [
"type",
"markdown"
]
}
]
}
},
"required": [
"type",
"content"
]
},
{
"type": "object",
"properties": {
"type": {
"enum": [
"image"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"clickLink": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"alt": {
"type": "string"
}
}
}
}
}
},
"required": [
"type",
"content"
]
},
{
"type": "object",
"properties": {
"type": {
"enum": [
"video"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"enum": [
"url",
"youtube",
"vimeo",
"tiktok",
"gumlet"
],
"type": "string"
},
"height": {},
"aspectRatio": {
"type": "string"
},
"maxWidth": {
"type": "string"
},
"queryParamsStr": {
"type": "string"
},
"areControlsDisplayed": {
"type": "boolean"
},
"isAutoplayEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"type",
"content"
]
},
{
"type": "object",
"properties": {
"type": {
"enum": [
"audio"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"isAutoplayEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"type",
"content"
]
},
{
"type": "object",
"properties": {
"type": {
"enum": [
"embed"
],
"type": "string"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"height": {},
"waitForEvent": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"name": {
"type": "string"
},
"saveDataInVariableId": {
"type": "string"
}
}
}
}
}
},
"required": [
"type",
"content"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "custom-embed"
},
"content": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"waitForEventFunction": {
"type": "object",
"properties": {
"args": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"content": {
"type": "string"
}
},
"required": [
"args",
"content"
]
},
"initFunction": {
"type": "object",
"properties": {
"args": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"content": {
"type": "string"
}
},
"required": [
"args",
"content"
]
}
},
"required": [
"initFunction"
]
}
},
"required": [
"type",
"content"
]
}
]
}
]
}
},
"input": {
"allOf": [
{
"anyOf": [
{
"anyOf": [
{
"$ref": "#/components/schemas/TextInput"
},
{
"$ref": "#/components/schemas/ChoiceInput"
},
{
"$ref": "#/components/schemas/EmailInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"number input"
],
"type": "string"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"labels": {
"type": "object",
"properties": {
"placeholder": {
"type": "string"
},
"button": {
"type": "string"
}
}
},
"min": {},
"max": {},
"step": {},
"locale": {
"type": "string",
"pattern": "^[a-z]{2}(-[A-Z]{2})?$"
},
"style": {
"enum": [
"decimal",
"currency",
"percent",
"unit"
],
"type": "string"
},
"currency": {
"type": "string"
},
"unit": {
"enum": [
"acre",
"bit",
"byte",
"celsius",
"centimeter",
"day",
"degree",
"fahrenheit",
"fluid-ounce",
"foot",
"gallon",
"gigabit",
"gigabyte",
"gram",
"hectare",
"hour",
"inch",
"kilobit",
"kilobyte",
"kilogram",
"kilometer",
"liter",
"megabit",
"megabyte",
"meter",
"microsecond",
"mile",
"mile-scandinavian",
"milliliter",
"millimeter",
"millisecond",
"minute",
"month",
"nanosecond",
"ounce",
"percent",
"petabyte",
"pound",
"second",
"stone",
"terabit",
"terabyte",
"week",
"yard",
"year"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/UrlInput"
},
{
"$ref": "#/components/schemas/PhoneNumberInput"
},
{
"$ref": "#/components/schemas/DateInput"
},
{
"$ref": "#/components/schemas/TimeInput"
},
{
"$ref": "#/components/schemas/PaymentInput"
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "rating input"
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"buttonType": {
"anyOf": [
{
"const": "Icons"
},
{
"const": "Numbers"
}
]
},
"length": {
"type": "number"
},
"startsAt": {},
"labels": {
"type": "object",
"properties": {
"left": {
"type": "string"
},
"right": {
"type": "string"
},
"button": {
"type": "string"
}
}
},
"customIcon": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"svg": {
"type": "string"
}
}
},
"isOneClickSubmitEnabled": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"$ref": "#/components/schemas/FileInput"
},
{
"$ref": "#/components/schemas/PictureChoiceInput"
},
{
"$ref": "#/components/schemas/Cards"
}
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"content": {
"type": "string"
},
"value": {
"type": "string"
},
"displayCondition": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"condition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"variableId": {},
"comparisonOperator": {},
"value": {}
}
}
}
}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"dynamicVariableId": {
"type": "string"
},
"isSearchable": {
"type": "boolean"
},
"searchInputPlaceholder": {
"type": "string"
},
"areInitialSearchButtonsVisible": {
"type": "boolean"
}
}
}
},
"required": [
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"const": "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"
},
"success": {
"type": "object",
"properties": {
"single": {
"type": "string"
},
"multiple": {
"type": "string"
}
}
}
}
},
"allowedFileTypes": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"capture": {
"enum": [
"environment",
"user"
],
"type": "string"
},
"sizeLimit": {
"type": "number"
},
"visibility": {
"enum": [
"Auto",
"Public",
"Private"
],
"type": "string"
}
}
}
},
"required": [
"id",
"type"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"type": {
"enum": [
"picture choice input"
],
"type": "string"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"blockId": {
"type": "string"
},
"outgoingEdgeId": {
"type": "string"
},
"pictureSrc": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"value": {
"type": "string"
},
"displayCondition": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"condition": {
"type": "object",
"properties": {
"logicalOperator": {
"enum": [
"OR",
"AND"
],
"type": "string"
},
"comparisons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {},
"variableId": {},
"comparisonOperator": {},
"value": {}
}
}
}
}
}
}
}
},
"required": [
"id"
]
}
},
"options": {
"type": "object",
"properties": {
"variableId": {
"type": "string"
},
"isMultipleChoice": {
"type": "boolean"
},
"isSearchable": {
"type": "boolean"
},
"buttonLabel": {
"type": "string"
},
"searchInputPlaceholder": {
"type": "string"
},
"dynamicItems": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"titlesVariableId": {
"type": "string"
},
"descriptionsVariableId": {
"type": "string"
},
"pictureSrcsVariableId": {
"type": "string"
}
}
}
}
}
},
"required": [
"id",
"type",
"items"
]
}
]
}
]
},
{
"type": "object",
"properties": {
"prefilledValue": {
"type": "string"
},
"runtimeOptions": {
"type": "object",
"properties": {
"paymentIntentSecret": {
"type": "string"
},
"amountLabel": {
"type": "string"
},
"publicKey": {
"type": "string"
}
},
"required": [
"paymentIntentSecret",
"amountLabel",
"publicKey"
]
}
}
}
]
},
"clientSideActions": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"type": {
"const": "scriptToExecute"
},
"scriptToExecute": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"isUnsafe": {
"type": "boolean"
},
"isCode": {
"type": "boolean"
},
"args": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
{
"type": "boolean"
}
]
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id"
]
}
}
},
"required": [
"content",
"args"
]
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"scriptToExecute"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "redirect"
},
"redirect": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"isNewTab": {
"type": "boolean"
}
}
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"redirect"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "chatwoot"
},
"chatwoot": {
"type": "object",
"properties": {
"scriptToExecute": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"isUnsafe": {
"type": "boolean"
},
"isCode": {
"type": "boolean"
},
"args": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{},
{}
]
},
{
"type": "boolean"
}
]
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id"
]
}
}
},
"required": [
"content",
"args"
]
}
},
"required": [
"scriptToExecute"
]
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"chatwoot"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "googleAnalytics"
},
"googleAnalytics": {
"type": "object",
"properties": {
"trackingId": {
"type": "string"
},
"category": {
"type": "string"
},
"action": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {},
"sendTo": {
"type": "string"
}
}
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"googleAnalytics"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "wait"
},
"wait": {
"type": "object",
"properties": {
"secondsToWaitFor": {
"type": "number"
}
},
"required": [
"secondsToWaitFor"
]
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"wait"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "setVariable"
},
"setVariable": {
"type": "object",
"properties": {
"scriptToExecute": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"isUnsafe": {
"type": "boolean"
},
"isCode": {
"type": "boolean"
},
"args": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"value": {
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{
"anyOf": [
{},
{}
]
},
{
"type": "boolean"
}
]
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
]
},
{
"type": "null"
}
]
}
},
"required": [
"id"
]
}
}
},
"required": [
"content",
"args"
]
}
},
"required": [
"scriptToExecute"
]
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"setVariable"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "streamOpenAiChatCompletion"
},
"streamOpenAiChatCompletion": {
"type": "object",
"properties": {
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"role": {
"enum": [
"system",
"user",
"assistant"
],
"type": "string"
}
}
}
}
},
"required": [
"messages"
]
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"streamOpenAiChatCompletion"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "httpRequestToExecute"
},
"httpRequestToExecute": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"headers": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"body": {},
"method": {
"enum": [
"POST",
"GET",
"PUT",
"DELETE",
"PATCH",
"HEAD",
"CONNECT",
"OPTIONS",
"TRACE"
],
"type": "string"
}
},
"required": [
"url"
]
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"httpRequestToExecute"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "startPropsToInject"
},
"startPropsToInject": {
"type": "object",
"properties": {
"googleAnalyticsId": {
"type": "string"
},
"pixelIds": {
"type": "array",
"items": {
"type": "string"
}
},
"gtmId": {
"type": "string"
},
"customHeadCode": {
"type": "string"
}
}
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"startPropsToInject"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "pixel"
},
"pixel": {
"anyOf": [
{
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"not": {}
}
}
},
{
"$ref": "#/components/schemas/Lead"
},
{
"type": "object",
"properties": {
"pixelId": {
"type": "string"
},
"isInitSkip": {
"type": "boolean"
},
"params": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"value": {}
},
"required": [
"id"
]
}
},
"eventType": {
"enum": [
"Custom"
],
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"eventType"
]
}
]
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"pixel"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "stream"
},
"stream": {
"const": true
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"stream"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "codeToExecute"
},
"codeToExecute": {
"type": "object",
"properties": {
"args": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"content": {
"type": "string"
}
},
"required": [
"args",
"content"
]
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type",
"codeToExecute"
]
},
{
"type": "object",
"properties": {
"type": {
"const": "listenForWebhook"
},
"lastBubbleBlockId": {
"type": "string"
},
"expectsDedicatedReply": {
"type": "boolean"
}
},
"required": [
"type"
]
}
]
},
"description": "Actions to execute on the client side"
},
"logs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"description": {
"type": "string"
},
"details": {
"type": "string"
},
"context": {
"type": "string"
}
},
"required": [
"description"
]
},
"description": "Logs that were saved during the last execution"
},
"dynamicTheme": {
"type": "object",
"properties": {
"hostAvatarUrl": {
"type": "string"
},
"guestAvatarUrl": {
"type": "string"
},
"backgroundUrl": {
"type": "string"
}
},
"description": "If the typebot contains dynamic avatars, dynamicTheme returns the new avatar URLs whenever their variables are updated."
},
"progress": {
"type": "number",
"description": "If progress bar is enabled, this field will return a number between 0 and 100 indicating the current progress based on the longest remaining path of the flow."
}
},
"required": [
"sessionId",
"typebot",
"messages"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/{blockType}/oauth/authorize": {
"get": {
"operationId": "credentials.authorizeOAuth",
"parameters": [
{
"name": "blockType",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "clientId",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "state",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"307": {
"description": "OK",
"headers": {
"location": {
"schema": {
"type": "string"
},
"required": true
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
}
}
},
"/stripe/webhook": {
"post": {
"operationId": "billing.webhook",
"summary": "Handle webhook",
"tags": [
"Billing"
],
"parameters": [
{
"name": "stripe-signature",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
}
}
},
"/v1/billing/usage": {
"get": {
"operationId": "billing-getUsage",
"summary": "Get current plan usage",
"tags": [
"Billing"
],
"parameters": [
{
"name": "workspaceId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"totalChatsUsed": {
"type": "number"
},
"resetsAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"totalChatsUsed",
"resetsAt"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
},
"/v1/billing/invoices": {
"get": {
"operationId": "billing-listInvoices",
"summary": "List invoices",
"tags": [
"Billing"
],
"parameters": [
{
"name": "workspaceId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"description": "[Where to find my workspace ID?](../how-to#how-to-find-my-workspaceid)"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"invoices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
},
"amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"date": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"url",
"amount",
"currency",
"date"
]
}
}
},
"required": [
"invoices"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Bad Request"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"401": {
"description": "401",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "UNAUTHORIZED"
},
"status": {
"const": 401
},
"message": {
"type": "string",
"default": "Unauthorized"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "Forbidden"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "Not Found"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"500": {
"description": "500",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "INTERNAL_SERVER_ERROR"
},
"status": {
"const": 500
},
"message": {
"type": "string",
"default": "Internal Server Error"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
}
},
"security": [
{
"Authorization": []
}
]
}
}
}
}