Przejdź do treści
open-toolsopen-tools

API

open-tools API

Programowy dostęp do wszystkich narzędzi. Użyj go, aby wpiąć masowe zadania PDF lub obrazów we własne pipelines.

Szybki start

  1. Utwórz konto jeśli jeszcze go nie masz.
  2. Wygeneruj klucz API z Konto → Klucze API. Pełny token jest wyświetlany raz; skopiuj go teraz.
  3. Przekaż token jako Authorization: Bearer otk_… przy każdym żądaniu.

Dokumentacja

Pełna specyfikacja OpenAPI — każdy endpoint, każdy parametr, każdy kształt odpowiedzi — jest generowana automatycznie z aplikacji FastAPI i serwowana jako JSON. Swagger UI i ReDoc obsługują jej renderowanie.

Otwórz interaktywne odniesienie API →

Wolisz surową specyfikację lub żywą konsolę? Czytelny dla maszyn plik OpenAPI JSON oraz eksploratory Swagger / ReDoc są dostępne dla zalogowanych kont:

Przykład — podział PDF

Prześlij plik i sprawdzaj wynik:

# 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'

Kody błędów

Wszystkie błędy mają ten sam kształt odpowiedzi:

{
  "detail": {
    "error": {
      "code": "INVALID_FILE_TYPE",
      "message": "image-resize requires PNG, JPG, or WEBP.",
      "details": { "expected_extensions": [".png", ".jpg", ".webp"] }
    }
  }
}
HTTPKodZnaczenie
400INVALID_FILE_TYPERozszerzenie pliku nie jest na liście dozwolonych dla tego zadania.
400INVALID_FILE_SIGNATUREBajty magic nie pasują do rozszerzenia.
400INVALID_PARAMETERSParametry parameters JSON nie przeszły walidacji schematu.
401AUTH_REQUIREDBrak ciasteczka sesji lub klucza API w żądaniu.
403REAUTH_REQUIREDWrażliwa akcja; sesja starsza niż 15 minut.
413FILE_TOO_LARGEPlik przekracza limit 50 MB.
429RATE_LIMITEDPrzekroczono limit okna czasowego. Zobacz Retry-After.
500INTERNAL_ERRORBłąd. Dołącz nagłówek request_id do zgłoszenia.

Limity i użycie

Każde konto ma zasobniki na minutę, godzinę, dzień i miesiąc. Bieżące użycie widoczne jest na pulpicie konta. Otrzymałeś 429? Poczekaj na przesunięcie okna; odpowiedź zawieraRetry-After sekund.