Pular para o conteúdo principal

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 2xx indicam sucesso
  • Códigos na faixa 4xx indicam um erro que falhou com as informações fornecidas
  • Códigos na faixa 5xx indicam um erro com nossos servidores (estes são raros)

Códigos de Status HTTP

Código de StatusDescriçãoCausas Comuns
200Sucesso - A requisição foi bem-sucedidaRequisição concluída conforme esperado
201Criado - O recurso foi criado com sucessoNovo webhook criado com sucesso
400Requisição Inválida - A requisição era inválidaCampos obrigatórios ausentes, valores de parâmetros inválidos
403Proibido - Autenticação falhouChave de API inválida, token expirado, permissões insuficientes
429Limite de Taxa - Muitas requisiçõesLimites de taxa da API excedidos
500Erro Interno do Servidor - Problema no servidorErro 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"
}