Dokumentacja API REST
API REST
Kody błędów
Wszystkie kody błędów zwracane przez API, ze statusem HTTP, znaczeniem i tym, co zrobić.
Kształt błędu
Błędy to JSON w tym kształcie. Opieraj logikę na code, który nigdy się nie zmienia; message jest dla ludzi i może się zmienić. details wymienia każde nieprawidłowe pole przy 400.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Kody
Linkuj bezpośrednio do kodu, używając jego nazwy jako kotwicy, na przykład /docs/api/errors#rate_limited.
- 400invalid_request
- Treść, zapytanie lub nagłówek są nieprawidłowe. details wskazuje każde pole z problemem. Popraw żądanie; wysłane ponownie bez zmian znów się nie powiedzie.
- 401api_key_expired
- Klucz wygasł. Utwórz nowy klucz albo wymień go, aby dostać nowy sekret.
- 401api_key_revoked
- Klucz został unieważniony. Utwórz nowy klucz w Ustawienia › Deweloperzy.
- 401invalid_api_key
- Żaden klucz nie pasuje. Sprawdź, czy skopiowano cały klucz, lub utwórz nowy w Ustawienia › Deweloperzy.
- 402insufficient_credits
- Kredyty AI właściciela klucza się skończyły. Doładuj je lub zmień plan w Attorly i spróbuj ponownie.
- 402usage_limit_exceeded
- Osiągnięto limit użycia AI właściciela klucza lub organizacji. Odnawia się wraz z okresem rozliczeniowym; administrator organizacji może podnieść limit członka.
- 403ai_consent_withdrawn
- Właściciel klucza lub dokumentu wycofał zgodę na przetwarzanie przez AI. Można ją wyrazić ponownie w ustawieniach prywatności.
- 403forbidden
- Klucz może odczytać zasób, ale nie może go zmienić, albo akcja jest niedozwolona. Poproś właściciela o uprawnienia do edycji.
- 403insufficient_scope
- Kluczowi brakuje zakresu wymaganego przez tę operację; komunikat go wskazuje. Utwórz klucz z tym zakresem.
- 403ip_not_allowed
- Klucz ma listę dozwolonych adresów IP, a żądanie przyszło z adresu spoza niej. Wywołaj z dozwolonego adresu lub zmień listę w Ustawienia › Deweloperzy.
- 403plan_required
- Plan właściciela klucza nie obejmuje dostępu do API albo właściciel opuścił organizację. Dostęp do API wymaga planu Pro lub Enterprise.
- 404not_found
- Zasób nie istnieje albo ten klucz go nie widzi. Sprawdź identyfikator i to, czy właściciel klucza ma dostęp.
- 405method_not_allowed
- Ścieżka nie obsługuje tej metody HTTP. Nagłówek Allow wymienia obsługiwane metody.
- 409conflict
- Żądanie jest sprzeczne z bieżącym stanem zasobu, na przykład akcja została już wykonana. Odczytaj zasób i zdecyduj ponownie.
- 409idempotency_request_in_progress
- Żądanie z tym samym Idempotency-Key wciąż trwa. Odpytuj adres z nagłówka Location albo spróbuj ponownie po Retry-After sekundach.
- 413payload_too_large
- Treść lub przesłany plik jest za duży. Pliki mogą mieć do 10 MB.
- 415unsupported_media_type
- Treść ma format, którego ta operacja nie przyjmuje. Wyślij JSON lub multipart/form-data, gdy przesyłanie jest dozwolone.
- 422idempotency_key_reused
- Ten Idempotency-Key był już użyty dla innego żądania. Dla każdego innego żądania używaj nowego klucza.
- 422unprocessable
- Żądanie jest poprawne, ale nie można go wykonać, na przykład analiza dokumentu bez wybranego prawa właściwego. Komunikat mówi, czego brakuje.
- 429concurrency_limit_exceeded
- Twoja organizacja wykonuje już tyle długotrwałych operacji AI jednocześnie, ile może. Poczekaj, aż jedna się zakończy, lub odczekaj sekundy z Retry-After, i spróbuj ponownie.
- 429rate_limited
- Zbyt wiele żądań w jednym z okien, w których liczy się ten klucz. Odczekaj liczbę sekund z Retry-After i spróbuj ponownie. Nagłówek RateLimit pokazuje, które okno jest pełne.
- 500internal_error
- Coś poszło nie tak po stronie Attorly. Spróbuj ponownie z tym samym Idempotency-Key; jeśli problem nie ustąpi, skontaktuj się z pomocą techniczną, podając requestId.
- 504timeout
- Operacja nie zakończyła się na czas. Spróbuj ponownie z tym samym Idempotency-Key albo wyślij Prefer: respond-async i odpytuj operację.