Τεκμηρίωση REST API
REST API
Κωδικοί σφαλμάτων
Όλοι οι κωδικοί σφαλμάτων που επιστρέφει το API, με την κατάσταση HTTP, τη σημασία και τι να κάνετε.
Η μορφή ενός σφάλματος
Τα σφάλματα είναι JSON αυτής της μορφής. Βασίστε τη λογική στο code, που δεν αλλάζει ποτέ· το message είναι για ανθρώπους και μπορεί να αλλάξει. Το details απαριθμεί κάθε μη έγκυρο πεδίο σε ένα 400.
json
{
"error": {
"code": "insufficient_scope",
"message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
"requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
}
}Κωδικοί
Παραπέμψτε απευθείας σε έναν κωδικό χρησιμοποιώντας το όνομά του ως άγκυρα, για παράδειγμα /docs/api/errors#rate_limited.
- 400invalid_request
- Το σώμα, το ερώτημα ή μια κεφαλίδα δεν είναι έγκυρο. Το details ονομάζει κάθε προβληματικό πεδίο. Διορθώστε το αίτημα· αν το ξαναστείλετε αμετάβλητο, θα αποτύχει ξανά.
- 401api_key_expired
- Το κλειδί έχει λήξει. Δημιουργήστε νέο κλειδί ή αντικαταστήστε το για να πάρετε νέο μυστικό.
- 401api_key_revoked
- Το κλειδί ανακλήθηκε. Δημιουργήστε νέο κλειδί στις Ρυθμίσεις › Προγραμματιστές.
- 401invalid_api_key
- Κανένα κλειδί δεν ταιριάζει. Ελέγξτε ότι αντιγράψατε ολόκληρο το κλειδί ή δημιουργήστε νέο στις Ρυθμίσεις › Προγραμματιστές.
- 402insufficient_credits
- Οι πιστώσεις ΤΝ του κατόχου του κλειδιού εξαντλήθηκαν. Κάντε ανανέωση ή αλλάξτε πλάνο στο Attorly και δοκιμάστε ξανά.
- 402usage_limit_exceeded
- Συμπληρώθηκε ένα όριο χρήσης ΤΝ του κατόχου του κλειδιού ή του οργανισμού. Μηδενίζεται με την περίοδο χρέωσης· ένας διαχειριστής του οργανισμού μπορεί να αυξήσει το όριο ενός μέλους.
- 403ai_consent_withdrawn
- Ο κάτοχος του κλειδιού ή του εγγράφου ανακάλεσε τη συναίνεσή του για επεξεργασία με ΤΝ. Μπορεί να τη δώσει ξανά στις ρυθμίσεις απορρήτου.
- 403forbidden
- Το κλειδί μπορεί να διαβάζει τον πόρο αλλά όχι να τον αλλάζει, ή η ενέργεια δεν επιτρέπεται γι' αυτόν. Ζητήστε από τον κάτοχο δικαίωμα επεξεργασίας.
- 403insufficient_scope
- Στο κλειδί λείπει ένα δικαίωμα που χρειάζεται αυτή η λειτουργία· το μήνυμα το ονομάζει. Δημιουργήστε κλειδί με αυτό το δικαίωμα.
- 403ip_not_allowed
- Το κλειδί έχει λίστα επιτρεπόμενων IP και το αίτημα ήρθε από διεύθυνση εκτός αυτής. Καλέστε από επιτρεπόμενη διεύθυνση ή αλλάξτε τη λίστα από Ρυθμίσεις › Προγραμματιστές.
- 403plan_required
- Το πλάνο του κατόχου του κλειδιού δεν περιλαμβάνει πρόσβαση στο API ή ο κάτοχος αποχώρησε από τον οργανισμό. Η πρόσβαση στο API απαιτεί Pro ή Enterprise.
- 404not_found
- Ο πόρος δεν υπάρχει ή αυτό το κλειδί δεν μπορεί να τον δει. Ελέγξτε το αναγνωριστικό και ότι ο κάτοχος του κλειδιού έχει πρόσβαση.
- 405method_not_allowed
- Η διαδρομή δεν υποστηρίζει αυτή τη μέθοδο HTTP. Η κεφαλίδα Allow απαριθμεί τις υποστηριζόμενες μεθόδους.
- 409conflict
- Το αίτημα συγκρούεται με την τρέχουσα κατάσταση του πόρου, για παράδειγμα μια ενέργεια που έχει ήδη γίνει. Διαβάστε τον πόρο και αποφασίστε ξανά.
- 409idempotency_request_in_progress
- Ένα αίτημα με το ίδιο Idempotency-Key εκτελείται ακόμη. Ελέγξτε τη διεύθυνση της κεφαλίδας Location ή δοκιμάστε ξανά μετά από Retry-After δευτερόλεπτα.
- 413payload_too_large
- Το σώμα ή το αρχείο που ανέβηκε είναι πολύ μεγάλο. Τα αρχεία μπορούν να φτάσουν τα 10 MB.
- 415unsupported_media_type
- Το σώμα είναι σε μορφή που δεν δέχεται αυτή η λειτουργία. Στείλτε JSON ή multipart/form-data όπου επιτρέπεται η μεταφόρτωση.
- 422idempotency_key_reused
- Αυτό το Idempotency-Key χρησιμοποιήθηκε ήδη για άλλο αίτημα. Χρησιμοποιήστε νέο κλειδί για κάθε διαφορετικό αίτημα.
- 422unprocessable
- Το αίτημα είναι έγκυρο αλλά δεν μπορεί να εκτελεστεί, για παράδειγμα η ανάλυση εγγράφου χωρίς επιλεγμένο εφαρμοστέο δίκαιο. Το μήνυμα λέει τι λείπει.
- 429concurrency_limit_exceeded
- Ο οργανισμός σας εκτελεί ήδη όσες μακροχρόνιες λειτουργίες AI επιτρέπεται ταυτόχρονα. Περιμένετε να ολοκληρωθεί μία ή τα δευτερόλεπτα του Retry-After και δοκιμάστε ξανά.
- 429rate_limited
- Πάρα πολλά αιτήματα σε ένα από τα παράθυρα στα οποία μετρά αυτό το κλειδί. Περιμένετε τα δευτερόλεπτα του Retry-After και δοκιμάστε ξανά. Η κεφαλίδα RateLimit δείχνει ποιο παράθυρο είναι γεμάτο.
- 500internal_error
- Κάτι πήγε στραβά στο Attorly. Δοκιμάστε ξανά με το ίδιο Idempotency-Key· αν συνεχίζει, επικοινωνήστε με την υποστήριξη αναφέροντας το requestId.
- 504timeout
- Η λειτουργία δεν ολοκληρώθηκε εγκαίρως. Δοκιμάστε ξανά με το ίδιο Idempotency-Key ή στείλτε Prefer: respond-async και ελέγχετε τη λειτουργία.