Criar Fallback

Endpoint utilizado para criar uma credencial de fallback.

Exemplo de Requisição

curl --request POST \
  --url https://chat.api.toolzz.com.br/api/v1/bot/configuration/fallback \
  --header 'Authorization: Bearer TOKEN_AQUI' \
  --header 'Content-Type: application/json' \
  --data '
    {
        "botId": "uuid",
        "fallBacks": [
            {
                "order": "<string>",
                "credentialId": "uuid",
                "model": "<string>"
            }
        ]
    }
'

Exemplo de Resposta

[
    {
        "id": "uuid",
        "botId": "uuid",
        "order": 123,
        "credentialId": "uuid",
        "model": "<string>",
        "createdAt": "ISO8601_DATETIME",
        "credential": {
            "status": false,
            "id": "uuid",
            "name": "<string>",
            "userId": "uuid",
            "unityId": "uuid",
            "integrationId": "uuid",
            "secretId": "uuid",
            "createdAt": "ISO8601_DATETIME",
            "updatedAt": "ISO8601_DATETIME",
            "virtualKey": "<string>",
            "integration": {
                "status": true,
                "id": "uuid",
                "name": "<string>",
                "type": "<string>",
                "form": [
                    {
                        "name": "<string>",
                        "type": "<string>",
                        "label": "<string>",
                        "maxLenght": "<string>",
                        "required": true
                    }
                ],
                "createdAt": "ISO8601_DATETIME",
                "updatedAt": "ISO8601_DATETIME",
                "iconId": "uuid",
                "slug": "<string>",
                "file": {
                    "id": "uuid",
                    "url": "<url>",
                    "extension": "<string>",
                    "size": 123
                }
            }
        }
    }
]

Descrição da requisição

Token de Acesso

Parâmetro	Tipo	Descrição	Obrigatório
`Authorization`	String	Token de acesso (“Bearer” deve estar antes do token)	Sim

Parâmetros do corpo (Body)

Parâmetro	Tipo	Descrição	Obrigatório
`botId`	UUID	Identificador único do Agente principal que receberá a configuração.	Sim
`fallBacks`	Array	Lista de modelos de reserva que serão acionados em caso de falha do principal.	Sim
`fallBacks[].order`	String	Ordem de prioridade para o acionamento (ex: “1”, “2”).	Sim
`fallBacks[].credentialId`	UUID	Identificador da credencial (provedor) que será usada neste fallback.	Sim
`fallBacks[].model`	String	Nome técnico do modelo de IA a ser utilizado (ex: “gpt-4o”, “gemini-pro”).	Sim

Descrição da resposta

Chave	Tipo	Descrição
`id`	UUID	Identificador único do registro de fallback.
`botId`	UUID	Identificador do Agente ao qual o transbordo está vinculado.
`order`	Number	Ordem de prioridade na execução do transbordo.
`credentialId`	UUID	Identificador da credencial vinculada a este fallback.
`model`	String	Nome técnico do modelo de IA (ex: `gemini-2.5-pro`).
`createdAt`	String	Data e hora de criação da configuração de fallback.
`credential`	Object	Objeto contendo os detalhes da credencial de acesso utilizada.
`credential.name`	String	Nome amigável da credencial no sistema.
`credential.virtualKey`	String	Chave virtual de identificação interna.
`credential.status`	Boolean	Indica se a credencial específica do fallback está ativa.
`credential.integration`	Object	Detalhes do provedor de serviço (integração) da credencial.
`credential.integration.name`	String	Nome do provedor (ex: “Gemini”, “OpenAI”).
`credential.integration.type`	String	Categoria da integração (ex: `llm`).
`credential.integration.slug`	String	Identificador textual simplificado do provedor.
`credential.integration.form`	Array	Lista de campos técnicos exigidos pelo provedor.
`credential.integration.icon`	Object	Metadados do ícone do provedor de integração.
`credential.integration.icon.url`	URL	Link direto para a imagem do logotipo do provedor.

Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para proteger os dados dos usuários.

Para acessar o seu token de acesso siga os seguintes passos:

Faça login na plataforma ToolzzAI
Clique em “Configurações”
Clique em “Token de Acesso”
Copie o token de acesso

Página de token de acesso