Erros
Os erros seguem a convenção do GraphQL: um array errors, cada entrada com um extensions.code legível por máquina. O status HTTP espelha esse código.
Formato do erro
json
{"errors": [{"message": "Conversation not found","extensions": { "code": "CONVERSATION_NOT_FOUND" }}],"data": null}
Códigos e status
| Código | HTTP | Significado |
|---|---|---|
UNAUTHENTICATED | 401 | Chave de API ausente ou não reconhecida. |
*_NOT_FOUND | 404 | O recurso solicitado não existe na sua organização. |
DOCUMENT.TOO_LARGE | 413 | O arquivo passa do limite de 25 MiB por documento; nada foi armazenado. |
DOCUMENT.VALIDATION_FAILED | 200 | Um campo obrigatório do documento veio vazio, ou a subpasta informada é inválida. |
GRAPHQL_VALIDATION_FAILED | 200 | A operação não segue o schema: campo obrigatório ausente, tipo errado, valor fora de um enum ou campo inexistente. A mensagem diz qual. |
BAD_USER_INPUT | 200 | Um argumento viola uma regra de formato ou limite. A lista de problemas vem em extensions.details. |
BAD_REQUEST | 400 | A requisição não é GraphQL válido: corpo vazio, JSON quebrado ou sem query. |
(other) | 200 | Erros de validação e execução retornam 200 com um array errors, conforme a especificação do GraphQL. |
Limite de uso
Exceder uma cota retorna HTTP 429 antes de a consulta ser executada — veja Limites de uso.