Erros
A API Tess AI usa códigos de resposta HTTP convencionais para indicar o sucesso ou falha de uma requisição de API. Em geral:
- Códigos na faixa
2xxindicam sucesso - Códigos na faixa
4xxindicam um erro que falhou com as informações fornecidas - Códigos na faixa
5xxindicam um erro com nossos servidores (estes são raros)
Códigos de Status HTTP
| Código de Status | Descrição | Causas Comuns |
|---|---|---|
| 200 | Sucesso - A requisição foi bem-sucedida | Requisição concluída conforme esperado |
| 201 | Criado - O recurso foi criado com sucesso | Novo webhook criado com sucesso |
| 400 | Requisição Inválida - A requisição era inválida | Campos obrigatórios ausentes, valores de parâmetros inválidos |
| 403 | Proibido - Autenticação falhou | Chave de API inválida, token expirado, permissões insuficientes |
| 429 | Limite de Taxa - Muitas requisições | Limites de taxa da API excedidos |
| 500 | Erro Interno do Servidor - Problema no servidor | Erro inesperado do servidor (entre em contato com o suporte) |
Tipos de Erro e Exemplos
Erros de Autenticação (403)
Estes erros ocorrem quando há um problema com sua chave de API:
{
"error": "Autenticação inválida"
}
Causas comuns:
- Chave de API inválida
- Chave de API expirada
- Cabeçalho Authorization ausente
- Permissões insuficientes
Erros de Validação (400)
Ocorrem quando os dados da requisição não atendem aos requisitos:
{
"error": "Validação falhou",
"messages": {
"url": ["O campo url deve ser uma URL HTTPS válida"],
"method": ["O método deve ser um de: POST, GET"]
}
}
Regras de validação comuns:
- Webhooks
- URL deve ser uma URL HTTPS válida
- Método deve ser POST ou GET
- Status deve ser "active" ou "inactive"
- Arquivos
- Arquivo deve ser fornecido para upload
- Flag de processamento é opcional (padrão: false)
- Workspace
- Cabeçalho x-workspace-id deve ser um inteiro válido quando fornecido
Erros de Limite de Taxa (429)
Ocorrem quando você excedeu os limites de taxa da API:
{
"error": "Limite de taxa excedido",
"retry_after": 60
}
Erros do Servidor (500)
Indicam um problema do nosso lado:
{
"error": "Erro interno do servidor"
}