API REST

Codici di errore

Name: Attorly AI
Availability: InStock

Tutti i codici di errore restituiti dall'API, con stato HTTP, significato e cosa fare.

La forma di un errore

Gli errori sono JSON con questa forma. Basa la logica su code, che non cambia mai; message è per le persone e può cambiare. details elenca ogni campo non valido per un 400.

json

{
  "error": {
    "code": "insufficient_scope",
    "message": "Insufficient permissions. Missing scopes: REDLINES_GENERATE",
    "requestId": "0d6f3c1e-8a9b-4f2d-b7e5-91c4a2d3e6f0"
  }
}

Codici

Collega direttamente un codice usando il suo nome come ancora, per esempio /docs/api/errors#rate_limited.

400invalid_request: Il corpo, la query o un'intestazione non è valido. details indica ogni campo con problemi. Correggi la richiesta: ripetuta invariata fallirà di nuovo.
401api_key_expired: La chiave ha superato la data di scadenza. Crea una nuova chiave, oppure rinnovala per ottenere un nuovo segreto.
401api_key_revoked: La chiave è stata revocata. Crea una nuova chiave in Impostazioni › Sviluppatori.
401invalid_api_key: Nessuna chiave corrisponde. Verifica di aver copiato la chiave completa, oppure creane una nuova in Impostazioni › Sviluppatori.
401unauthorized: L'intestazione Authorization manca, oppure non è la parola Bearer seguita dalla chiave. Invia la chiave come token Bearer.
402insufficient_credits: I crediti IA del titolare della chiave sono esauriti. Ricarica o cambia piano in Attorly e riprova.
402usage_limit_exceeded: È stato raggiunto un limite di utilizzo IA del titolare della chiave o dell'organizzazione. Si azzera con il periodo di fatturazione; un amministratore dell'organizzazione può alzare il limite di un membro.
403ai_consent_withdrawn: Il titolare della chiave, o il proprietario del documento, ha revocato il consenso al trattamento con IA. Può darlo di nuovo nelle impostazioni sulla privacy.
403forbidden: La chiave può leggere la risorsa ma non modificarla, oppure l'azione non è consentita. Chiedi al proprietario l'accesso in modifica.
403insufficient_scope: Alla chiave manca un permesso richiesto da questa operazione; il messaggio lo indica. Crea una chiave con quel permesso.
403ip_not_allowed: La chiave ha un elenco di IP consentiti e la richiesta proviene da un indirizzo esterno all’elenco. Chiama da un indirizzo consentito o modifica l’elenco in Impostazioni › Sviluppatori.
403plan_required: Il piano del titolare della chiave non include l'accesso all'API, oppure ha lasciato l'organizzazione. L'accesso all'API richiede Pro o Enterprise.
404not_found: La risorsa non esiste, oppure questa chiave non può vederla. Verifica l'id e che il titolare della chiave vi abbia accesso.
405method_not_allowed: Il percorso non supporta questo metodo HTTP. L'intestazione Allow elenca i metodi supportati.
409conflict: La richiesta è in conflitto con lo stato attuale della risorsa, per esempio un'azione già eseguita. Rileggi la risorsa e decidi di nuovo.
409idempotency_request_in_progress: Una richiesta con la stessa Idempotency-Key è ancora in corso. Interroga l'intestazione Location, oppure riprova dopo Retry-After secondi.
413payload_too_large: Il corpo o il file caricato è troppo grande. I file possono arrivare a 10 MB.
415unsupported_media_type: Il corpo è in un formato che questa operazione non accetta. Invia JSON, oppure multipart/form-data dove è ammesso il caricamento.
422idempotency_key_reused: La Idempotency-Key è già stata usata per un'altra richiesta. Usa una chiave nuova per ogni richiesta diversa.
422unprocessable: La richiesta è valida ma non può essere eseguita, per esempio l'analisi di un documento senza legge applicabile scelta. Il messaggio indica cosa manca.
429concurrency_limit_exceeded: La tua organizzazione esegue già tutte le operazioni IA di lunga durata consentite in contemporanea. Attendi che una termini, o i secondi indicati in Retry-After, e riprova.
429rate_limited: Troppe richieste in una delle finestre in cui conta questa chiave. Attendi i secondi indicati in Retry-After e riprova. L’intestazione RateLimit mostra quale finestra è piena.
500internal_error: Qualcosa è andato storto in Attorly. Riprova con la stessa Idempotency-Key; se persiste, contatta il supporto indicando il requestId.
504timeout: L'operazione non è terminata in tempo. Riprova con la stessa Idempotency-Key, oppure invia Prefer: respond-async e interroga l'operazione.