Atualizar Fallback

Endpoint utilizado para atualizar uma configuração de fallback.

Exemplo de Requisição

curl --request PUT \
  --url https://chat.api.toolzz.com.br/api/v1/bot/{botId}/configuration/fallback/{id} \
  --header 'Authorization: Bearer TOKEN_AQUI' \
  --header 'Content-Type: application/json' \
  --data '
    {
        "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 da URL (Path)

Chave	Tipo	Descrição
`botId`	UUID	Identificador único do Agente.
`fallbackId`	UUID	Identificador do Fallback ao qual o transbordo está vinculado.

Parâmetros do corpo (Body)

Chave	Tipo	Descrição	Obrigatório
`fallBacks`	Array	Lista contendo as configurações de transbordo (modelos de reserva).	Sim
`fallBacks[].order`	String	A posição ou prioridade do modelo na fila de execução (ex: “1”).	Sim
`fallBacks[].credentialId`	UUID	Identificador único da credencial (provedor) vinculada a este modelo.	Sim
`fallBacks[].model`	String	Nome técnico do modelo de IA que servirá como reserva (ex: “gpt-4o-mini”).	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 atualizado (ex: `gemini-2.0-flash-lite`).
`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.id`	UUID	Identificador único da credencial.
`credential.name`	String	Nome amigável da credencial cadastrada.
`credential.virtualKey`	String	Chave virtual de identificação interna.
`credential.integration`	Object	Detalhes do provedor de serviço (integração) da credencial.
`credential.integration.name`	String	Nome do provedor (ex: “Gemini”).
`credential.integration.type`	String	Categoria da integração (ex: `llm`).
`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