Gean nei de haadynhâld
Dokumintaasje fan de REST API

REST API

Flaterkoades

Elke flaterkoade dy’t de API weromjout, mei de HTTP-status, wat er betsjut en wat jo deroan dwaan kinne.

De foarm fan in flater

Flaters binne JSON mei dizze foarm. Fertakje op code, dy’t nea feroaret; message is foar minsken en kin feroarje. details neamt by in 400 elk ûnjildich fjild.

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

Koades

Keppelje streekrjocht nei in koade mei de namme as anker, bygelyks /docs/api/errors#rate_limited.

400invalid_request
De ynhâld, de query of in header is ûnjildich. details neamt elk fjild mei in probleem. Ferbetterje it fersyk; itselde fersyk nochris stjoere mislearret wer.
401api_key_expired
De ferrindatum fan de kaai is foarby. Meitsje in nije kaai oan, of ferfang de kaai om in nij geheim te krijen.
401api_key_revoked
De kaai is ynlutsen. Meitsje in nije kaai oan yn Ynstellings › Ûntwikkelers.
401invalid_api_key
Gjin inkelde kaai komt oerien. Kontrolearje oft de hiele kaai kopiearre is, of meitsje in nije oan yn Ynstellings › Ûntwikkelers.
401unauthorized
De Authorization-header ûntbrekt, of is net it wurd Bearer folge troch de kaai. Stjoer de kaai mei as Bearer-token.
402insufficient_credits
It AI-tegoed fan de eigner fan de kaai is op. Folje oan of wurdearje op yn Attorly en besykje it dan opnij.
402usage_limit_exceeded
In AI-gebrûkslimyt foar de eigner fan de kaai of foar de organisaasje is berikt. Dy wurdt mei de fakturearringsperioade weromset; in behearder fan de organisaasje kin de limyt fan in lid ferheegje.
403forbidden
De kaai mei de boarne lêze, mar net wizigje, of de hanneling is der net foar tastien. Freegje de eigner om bewurkingstagong.
403insufficient_scope
De kaai mist in rjocht dat dizze operaasje nedich hat; it berjocht neamt it. Meitsje in kaai oan mei dat rjocht.
403ip_not_allowed
De kaai hat in list mei tastiene IP-adressen en it fersyk kaam fan in adres dat der net op stiet. Roppe oan fan in tastien adres, of wizigje de list yn Ynstellings › Ûntwikkelers.
403plan_required
It abonnemint fan de eigner fan de kaai befettet gjin API-tagong, of de eigner hat de organisaasje ferlitten. Foar API-tagong is Pro of Enterprise nedich.
404not_found
De boarne bestiet net, of dizze kaai kin him net sjen. Kontrolearje de id en oft de eigner fan de kaai tagong hat.
405method_not_allowed
It paad stipet dizze HTTP-metoade net. De Allow-header neamt de metoaden dy’t it wol stipet.
409conflict
It fersyk is yn striid mei de hjoeddeistige tastân fan de boarne, bygelyks in hanneling dy’t al útfierd is. Lês de boarne en beslút opnij.
409idempotency_request_in_progress
In fersyk mei deselde Idempotency-Key rint noch. Freegje de Location-header geregeld op, of besykje it opnij nei Retry-After sekonden.
413payload_too_large
De ynhâld of it opladen bestân is te grut. Bestannen meie oant 10 MB wêze.
415unsupported_media_type
De ynhâld is yn in formaat dat dizze operaasje net oannimt. Stjoer JSON, of multipart/form-data wêr’t opladen akseptearre wurdt.
422idempotency_key_reused
De Idempotency-Key is al earder brûkt foar in oar fersyk. Brûk foar elk ferskillend fersyk in nije kaai.
422unprocessable
It fersyk is jildich, mar kin net útfierd wurde, bygelyks in analyze fan in dokumint sûnder keazen tapaslik rjocht. It berjocht seit wat der ûntbrekt.
429concurrency_limit_exceeded
Jo organisaasje fiert al safolle AI-operaasjes dy’t lang duorje tagelyk út as tastien is. Wachtsje oant der ien klear is, of de sekonden yn Retry-After, en besykje it dan opnij.
429rate_limited
Te folle fersiken yn ien fan de finsters dêr’t dizze kaai yn meitelt. Wachtsje it tal sekonden yn Retry-After en besykje it dan opnij. De RateLimit-header lit sjen hokker finster fol is.
500internal_error
Der gie by Attorly wat mis. Besykje it opnij mei deselde Idempotency-Key; as it oanhâldt, nim dan kontakt op mei de stipe en neam de requestId.
504timeout
De operaasje wie net op tiid klear. Besykje it opnij mei deselde Idempotency-Key, of stjoer Prefer: respond-async en freegje de operaasje geregeld op.