Saltar para o conteúdo principal
open-toolsopen-tools

API

API open-tools

Acesso programático a todas as nossas ferramentas. Use-a para integrar trabalhos em lote de PDF ou imagem nos seus próprios pipelines.

Início rápido

  1. Crie uma conta se ainda não tiver uma.
  2. Crie uma chave API em Conta → Chaves API. O token completo é mostrado uma vez; copie-o agora.
  3. Passe o token como Authorization: Bearer otk_… em todos os pedidos.

Referência

A especificação OpenAPI completa — todos os endpoints, todos os parâmetros, todos os formatos de resposta — é gerada automaticamente a partir da app FastAPI e servida como JSON. Swagger UI e ReDoc conseguem apresentá-la.

Abrir a referência interativa da API →

Prefere a especificação em bruto ou uma consola ao vivo? O OpenAPI JSON legível por máquina e os exploradores Swagger / ReDoc estão disponíveis para contas com sessão iniciada:

Exemplo — dividir um PDF

Carregue um ficheiro e consulte o resultado:

# 1. Upload and create the job
curl -X POST 'https://api.open-tools.app/api/upload' \
  -H 'Authorization: Bearer otk_YOUR_KEY' \
  -F 'file=@input.pdf' \
  -F 'job_type=pdf-split' \
  -F 'parameters={"pages": "1-3"}'
# → {"job_id": "abc123", "status": "queued", "ws_token": "..."}

# 2. Poll job status (or subscribe via WebSocket /ws/<job_id>?token=<ws_token>)
curl 'https://api.open-tools.app/api/jobs/abc123' \
  -H 'Authorization: Bearer otk_YOUR_KEY'
# → {"status": "completed", "output_file_url": "https://api.open-tools.app/api/download/users/42/..."}

# 3. Download the result
curl -o output.pdf 'https://api.open-tools.app/api/download/users/42/<uuid>.pdf' \
  -H 'Authorization: Bearer otk_YOUR_KEY'

Códigos de erro

Todos os erros partilham o mesmo formato de envelope:

{
  "detail": {
    "error": {
      "code": "INVALID_FILE_TYPE",
      "message": "image-resize requires PNG, JPG, or WEBP.",
      "details": { "expected_extensions": [".png", ".jpg", ".webp"] }
    }
  }
}
HTTPCódigoSignificado
400INVALID_FILE_TYPEA extensão do ficheiro não está na lista permitida deste trabalho.
400INVALID_FILE_SIGNATUREOs magic bytes não correspondem à extensão.
400INVALID_PARAMETERSO parameters JSON falhou a validação do esquema.
401AUTH_REQUIREDSem cookie de sessão ou chave API no pedido.
403REAUTH_REQUIREDAção sensível; sessão com mais de 15 min.
413FILE_TOO_LARGEO upload excede o limite de 50 MB.
429RATE_LIMITEDJanela do escalão excedida. Veja Retry-After.
500INTERNAL_ERRORBug. Inclua o cabeçalho request_id .

Limites de taxa e utilização

Todas as contas recebem quotas por minuto, por hora, por dia e por mês. A utilização atual está visível em o painel da sua conta. Encontrou um 429? Aguarde que a janela avance; a resposta incluiRetry-After segundos.