> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Iniciar fluxo

> Inicia manualmente um fluxo do Typebot para um número, disparando o startChat

**Auth:** `TokenAccount` ou `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** não

## Descrição

Inicia manualmente um fluxo do Typebot para um número, sem esperar por uma mensagem de trigger. A RyzeAPI dispara o `startChat` do bot indicado e persiste a sessão. Útil para campanhas de saída (outbound) e para retomar uma conversa a partir do seu backend.

<Info>
  A instância precisa já ter pelo menos um bot cadastrado (uma integração ativa).
</Info>

## Exemplo

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST "https://ryzeapi.cloud/api/typebot/start/suporte" \
    -H "token: $Token_Account" \
    -H "Content-Type: application/json" \
    -d '{
      "number":  "5511999999999",
      "botId":   "8f3a1c2e-...-b7d9",
      "variables": { "nome": "João", "plano": "premium" }
    }'
  ```

  ```javascript JavaScript theme={null}
  await fetch("https://ryzeapi.cloud/api/typebot/start/suporte", {
    method: "POST",
    headers: {
      "token":        process.env.Token_Account,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      number:  "5511999999999",
      botId:   "8f3a1c2e-...-b7d9",
      variables: { nome: "João", plano: "premium" }
    })
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.post(
      "https://ryzeapi.cloud/api/typebot/start/suporte",
      headers={
          "token":        os.environ["Token_Account"],
          "Content-Type": "application/json"
      },
      json={
          "number":  "5511999999999",
          "botId":   "8f3a1c2e-...-b7d9",
          "variables": { "nome": "João", "plano": "premium" }
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
      "strings"
  )

  func main() {
      body := strings.NewReader(`{
          "number":  "5511999999999",
          "botId":   "8f3a1c2e-...-b7d9",
          "variables": { "nome": "João", "plano": "premium" }
      }`)
      req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/typebot/start/suporte", body)
      req.Header.Set("token", os.Getenv("Token_Account"))
      req.Header.Set("Content-Type", "application/json")
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Resposta de sucesso

```json 200 OK theme={null}
{
  "success": true,
  "message": "typebot flow started"
}
```

## Parâmetros de rota

<ParamField path="instance" type="string" required>
  Nome da instância (ex.: `suporte`).
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  `TokenAccount` ou `TokenInstance`.
</ParamField>

<ParamField header="Content-Type" type="string" required>
  `application/json`
</ParamField>

## Request body

<ParamField body="number" type="string" required>
  Número de destino no formato E.164 sem o `+` (ex.: `5511999999999`).
</ParamField>

<ParamField body="botId" type="string" required>
  UUID do bot a iniciar, obtido em [`GET /api/typebot/list/:instance`](/pt/api/typebot/list).
</ParamField>

<ParamField body="variables" type="object">
  Variáveis prefilled passadas ao Typebot (mapa `string → string`). Ex.: `{ "nome": "João", "plano": "premium" }`.
</ParamField>

## Erros

| HTTP | `error.message`                                                | Causa                                            |
| :--: | -------------------------------------------------------------- | ------------------------------------------------ |
|  400 | `invalid body: ...`                                            | Body malformado ou `number` / `botId` ausentes.  |
|  404 | `instance not found`                                           | Instância não existe na RyzeAPI.                 |
|  404 | `no typebot integration for this instance, create a bot first` | A instância ainda não tem nenhum bot/integração. |
|  404 | `bot not found for this instance`                              | O `botId` informado não existe nesta instância.  |
|  500 | Falha ao iniciar o fluxo                                       | Erro interno ao disparar o `startChat` do bot.   |
|  503 | `integration gateway not configured`                           | Serviço de integração indisponível no servidor.  |

## Próximo

<CardGroup cols={2}>
  <Card title="Listar bots" icon="list" href="/pt/api/typebot/list">
    Descubra o `botId` a usar com `GET /api/typebot/list/:instance`.
  </Card>

  <Card title="Sessões ao vivo" icon="comments" href="/pt/api/typebot/sessions">
    Acompanhe e controle a conversa iniciada com `GET/POST /api/typebot/sessions/:instance`.
  </Card>
</CardGroup>