Criar TypeBot na instancia

curl --request POST \ --url https://api.vzaps.com/instances/{id}/typebots \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "enabled": true, "description": "Welcome", "typebot_url": "https://typebot.io", "public_id": "my-public-flow", "trigger_type": "keyword", "trigger_operator": "", "trigger_value": "hello", "priority": 10, "expire_in_minutes": 30, "keyword_finish": "exit", "default_delay_ms": 800, "unknown_message": "Sorry, I did not understand. Could you rephrase?", "transcribe_audio": true, "listen_from_me": false, "stop_bot_from_me": true, "keep_open": false, "debounce_ms": 1500, "ignore_groups": false } '

{ "id": "00000000-0000-0000-0000-000000000001", "instance_id": "INSTANCE_ID", "enabled": true, "description": "Welcome", "typebot_url": "https://typebot.io", "public_id": "my-public-flow", "trigger_type": "keyword", "trigger_operator": "", "trigger_value": "hello", "priority": 10, "expire_in_minutes": 30, "keyword_finish": "exit", "default_delay_ms": 800, "unknown_message": "Sorry, I did not understand. Could you rephrase?", "transcribe_audio": true, "listen_from_me": false, "stop_bot_from_me": true, "keep_open": false, "debounce_ms": 1500, "ignore_groups": false, "created_at": "2026-06-04T00:00:00Z", "updated_at": "2026-06-04T00:00:00Z" }

Autorizações

Authorization

string

header

obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

string

obrigatório

Identificador publico da instancia no formato gerado pela plataforma: prefixo VZ seguido de caracteres alfanumericos.

Exemplo:

"VZ9K2M4N8P1Q3R5S7T0WABCD01EF"

Corpo

application/json

description

string

obrigatório

typebot_url

string

obrigatório

public_id

string

obrigatório

trigger_type

enum<string>

obrigatório

Tipo de gatilho que decide quando o TypeBot deve responder uma mensagem recebida.

Opções disponíveis:

all,

keyword,

contains,

starts_with,

regex,

advanced,

none

enabled

boolean

trigger_operator

enum<string>

Operador usado apenas quando trigger_type = advanced.

Opções disponíveis:

equals,

contains,

starts_with,

regex,

trigger_value

string

priority

integer

expire_in_minutes

integer

keyword_finish

string

default_delay_ms

integer

unknown_message

string

listen_from_me

boolean

stop_bot_from_me

boolean

keep_open

boolean

Controla o que acontece com a sessao quando ela e finalizada (expira por expire_in_minutes, recebe keyword_finish ou o fluxo chega num bloco terminal): true preserva a row com status=closed para consulta historica; false apaga a row por completo. A expiracao por tempo continua valendo em ambos os casos — keep_open nao impede o timeout.

debounce_ms

integer

transcribe_audio

boolean

padrão:false

Enables transcription of incoming audio messages to text for this TypeBot configuration.

Exemplo:

false

Resposta

TypeBot criado

string<uuid>

instance_id

string

enabled

boolean

description

string

typebot_url

string

URL base do TypeBot (ex.: https://typebot.io).

public_id

string

Identificador publico do flow no TypeBot.

trigger_type

enum<string>

Tipo de gatilho que decide quando o TypeBot deve responder uma mensagem recebida.

Opções disponíveis:

all,

keyword,

contains,

starts_with,

regex,

advanced,

none

trigger_operator

enum<string>

Operador usado apenas quando trigger_type = advanced.

Opções disponíveis:

equals,

contains,

starts_with,

regex,

trigger_value

string

priority

integer

Maior valor e avaliado primeiro.

expire_in_minutes

integer

0 = sessao nao expira automaticamente.

keyword_finish

string

default_delay_ms

integer

unknown_message

string

listen_from_me

boolean

stop_bot_from_me

boolean

keep_open

boolean

debounce_ms

integer

created_at

string<date-time>

updated_at

string<date-time>

transcribe_audio

boolean

padrão:false

When true, incoming audio messages can be transcribed and handled as text by TypeBot.

Exemplo:

false