Ga naar inhoud

Conventies

Dezelfde regels gelden voor /v1 van elk product. Of een operatie een regel ondersteunt, zie je in de referentie bij die operatie.

Elk JSON-antwoord heeft zes velden:

VeldBetekenis
dataHet resultaat
contextDe context van de aanroep: organisatie, filters, en bij een fout error
completenessHoe volledig het is: total, returned, truncated
notIncludedWat dit resultaat niet vertelt, en welke aanroep dat wel doet
provenanceWaar het vandaan komt
nextLogische vervolgstappen

Uitzonderingen staan in de referentie. In de LEO-familie houden /models en /chat/completions de OpenAI-vorm, en geeft /openapi.json het document zelf. ORDO geeft de envelop als je Accept: application/vnd.prudai.task+json meestuurt; bestanden behouden hun eigen formaat.

completeness.total is het exacte totaal, of null als dat onbekend is; nooit een schatting. De parameters staan per operatie in de referentie: limit met after en next_cursor in de LEO-familie, limit met offset bij IRMA en ORDO.

Een schrijfactie die Idempotency-Key ondersteunt, voert dezelfde sleutel met dezelfde body niet twee keer uit. Dezelfde sleutel met een andere body geeft 422 idempotency_key_reused.

Met ?dryRun=true zie je wat een schrijfactie zou doen. Er wordt niets opgeslagen en de goedkeuring wordt niet geraakt. Niet elke operatie heeft een dry run: dat staat in de referentie.

Een wijziging die If-Match ondersteunt, stuur je mee met de ETag die je las. Is het object intussen gewijzigd, dan krijg je 412. Ontbreekt de header, dan krijg je 428.

DELETE verwijdert zacht: het object is te herstellen via restore. Definitief verwijderen kan alleen in de app. In de LEO-familie blijft een gesprek 30 dagen te herstellen.

/v1 verandert alleen door toevoegen. Antwoorden kunnen nieuwe velden krijgen; negeer wat je niet kent. Aanvragen zijn in de LEO-familie strikt: een onbekend veld geeft 400.

  • X-Request-Id staat op elk antwoord in de LEO-familie. Noem die bij support.
  • RateLimit-Limit, RateLimit-Remaining en RateLimit-Reset geven de strengste limiet die geldt.
  • Tijden zijn RFC 3339 in UTC.