Pular para o conteúdo principal
Todos os endpoints da API DeepXL exigem autenticação. Você pode autenticar usando uma chave de API ou um token Bearer (Clerk JWT).

Autenticação por chave de API

Passe sua chave de API no cabeçalho x-api-key:
curl https://api.deepxl.ai/v1/detection \
  -H "x-api-key: YOUR_API_KEY"

Gerenciando chaves de API

Use os endpoints de chaves de API para gerenciar suas chaves de forma programática:
AçãoMétodoEndpoint
Listar chavesGET/v1/api-keys
Criar chavePOST/v1/api-keys
Atualizar chavePUT/v1/api-keys/{id}
Excluir chaveDELETE/v1/api-keys/{id}
Os endpoints de gerenciamento de chaves de API exigem autenticação por token Bearer (Clerk JWT). Você não pode gerenciar chaves de API usando outra chave de API.

Autenticação por token Bearer

Passe um Clerk JWT no cabeçalho Authorization:
curl https://api.deepxl.ai/v1/detection \
  -H "Authorization: Bearer YOUR_CLERK_JWT"
Os tokens Bearer são emitidos pela Clerk e contêm o contexto da sua organização. Eles são tipicamente usados pelo DeepXL Dashboard e por integrações de frontend.

Autenticação dupla

Todos os endpoints de análise (/v1/detection, /v1/parse, /v1/verification, /v1/files) aceitam ou uma chave de API ou um token Bearer. Se ambos forem fornecidos, o token Bearer tem prioridade.

Respostas de erro

StatusDescrição
401 UnauthorizedChave de API / token Bearer ausente ou inválido
403 ForbiddenCredenciais válidas, mas permissões insuficientes
{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Unauthorized"
}