REST API dokümantasyonu
REST API
Hata kodları
API’nin döndürdüğü her hata kodu, HTTP durumu, ne anlama geldiği ve ne yapılacağıyla birlikte.
Hata biçimi
Hatalar bu biçimde JSON’dur. Asla değişmeyen code üzerinden dallanın; message insanlar içindir ve değişebilir. details, bir 400 için her geçersiz alanı listeler.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Kodlar
Bir koda, adını bağlantı olarak kullanarak doğrudan bağlanın, örneğin /docs/api/errors#rate_limited.
- 400invalid_request
- Gövde, sorgu veya bir başlık geçersiz. details her sorunlu alanı belirtir. İsteği düzeltin; değiştirmeden yeniden denemek tekrar başarısız olur.
- 401api_key_expired
- Anahtarın bitiş tarihi geçti. Yeni bir anahtar oluşturun veya yeni bir gizli anahtar almak için anahtarı yenileyin.
- 401api_key_revoked
- Anahtar iptal edildi. Ayarlar › Geliştiriciler’de yeni bir anahtar oluşturun.
- 401invalid_api_key
- Hiçbir anahtar eşleşmiyor. Anahtarın tamamının kopyalandığını kontrol edin veya Ayarlar › Geliştiriciler’de yeni bir tane oluşturun.
- 402insufficient_credits
- Anahtar sahibinin yapay zekâ kredileri tükendi. Attorly’de kredi yükleyin veya planınızı yükseltin, ardından yeniden deneyin.
- 402usage_limit_exceeded
- Anahtar sahibi veya kuruluş için bir yapay zekâ kullanım sınırına ulaşıldı. Faturalandırma döneminde sıfırlanır; bir kuruluş yöneticisi bir üyenin sınırını yükseltebilir.
- 403ai_consent_withdrawn
- Anahtar sahibi veya belgenin sahibi yapay zekâ işlemeye verdiği onayı geri çekti. Ayarlar › Gizlilik altında yeniden verilebilir.
- 403forbidden
- Anahtar kaynağı okuyabilir ancak değiştiremez veya eylem ona izin verilmiyor. Sahibinden düzenleme erişimi isteyin.
- 403insufficient_scope
- Anahtarda bu işlemin gerektirdiği bir izin yok; mesaj onu belirtir. O izne sahip bir anahtar oluşturun.
- 403ip_not_allowed
- Anahtarın bir IP izin listesi var ve istek bunun dışındaki bir adresten geldi. İzin verilen bir adresten çağırın veya Ayarlar › Geliştiriciler’de izin listesini değiştirin.
- 403plan_required
- Anahtar sahibinin planı API erişimini içermiyor veya sahip kuruluştan ayrıldı. API erişimi Pro veya Enterprise gerektirir.
- 404not_found
- Kaynak mevcut değil veya bu anahtar onu göremiyor. Kimliği ve anahtar sahibinin erişimi olduğunu kontrol edin.
- 405method_not_allowed
- Yol bu HTTP yöntemini desteklemiyor. Allow başlığı desteklediği yöntemleri listeler.
- 409conflict
- İstek, kaynağın mevcut durumuyla çelişiyor, örneğin zaten yapılmış bir eylem. Kaynağı okuyun ve yeniden karar verin.
- 409idempotency_request_in_progress
- Aynı Idempotency-Key ile gönderilen bir istek hâlâ çalışıyor. Location başlığını sorgulayın veya Retry-After saniye sonra yeniden deneyin.
- 413payload_too_large
- Gövde veya yüklenen dosya çok büyük. Dosyalar en fazla 10 MB olabilir.
- 415unsupported_media_type
- Gövde, bu işlemin kabul etmediği bir biçimde. JSON gönderin veya yüklemenin kabul edildiği yerlerde multipart/form-data kullanın.
- 422idempotency_key_reused
- Idempotency-Key daha önce farklı bir istek için kullanıldı. Her farklı istek için yeni bir anahtar kullanın.
- 422unprocessable
- İstek geçerli ancak yapılamıyor, örneğin uygulanacak hukuku seçilmemiş bir belgenin analizi. Mesaj neyin eksik olduğunu söyler.
- 429concurrency_limit_exceeded
- Kuruluşunuz aynı anda çalıştırabileceği kadar uzun süren yapay zekâ işlemi zaten çalıştırıyor. Birinin bitmesini veya Retry-After’daki saniye kadar bekleyin, sonra yeniden deneyin.
- 429rate_limited
- Bu anahtarın tabi olduğu pencerelerden birinde çok fazla istek var. Retry-After içindeki saniye kadar bekleyin, sonra yeniden deneyin. RateLimit başlığı hangi pencerenin dolu olduğunu gösterir.
- 500internal_error
- Attorly’de bir şeyler ters gitti. Aynı Idempotency-Key ile yeniden deneyin; devam ederse requestId ile destekle iletişime geçin.
- 504timeout
- İşlem zamanında bitmedi. Aynı Idempotency-Key ile yeniden deneyin veya Prefer: respond-async gönderip işlemi sorgulayın.