Prudai Developer API: modellen
Het model is het product: LEO, LEO Fiscaal, ZIA, VERA, BEVER en MAIA. Je ziet alleen wat je organisatie heeft en wat je token mag.
Basis-URL https://api.prudai.com/v1. Inloggen staat in Inloggen, scopes in Scopes en rechten, fouten in Fouten. Overzicht.
| Methode | Pad | Wat het doet | Stand |
|---|---|---|---|
GET | /v1/models | Modellen opvragen die je sleutel mag gebruiken | Op productie |
GET | /v1/models/{model} | Eén model opvragen | Op productie |
Modellen opvragen die je sleutel mag gebruiken
GET /v1/models
List the models your key may use.
Returns the products (and their specialisations) that both your organisation is entitled to and your key is allowed to use. Products your organisation does not have are never listed.
- Stand: op productie.
- Scope:
prudai:models:read - Goedkeuring:
none, geen extra stap.
Antwoorden
| Status | Betekenis |
|---|---|
200 | The models available to this key. |
401 | Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment. |
403 | Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution). |
429 | Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded. |
500 | Unexpected error on Prudai’s side. Not charged, except work that completed before the failure (reported in details.charged_credits). |
503 | Temporarily unavailable (maintenance, overload, or the credit check could not be performed). Nothing ran, nothing is charged. |
Velden in het antwoord (200)
object
listdatadata[].id
A product, optionally followed by/and a specialisation slug (e.g.leo/arbeidsrecht). max. lengte 80 · patroon^(leo|leo-fiscaal|zia|vera|bever|maia)(/[a-z0-9]+(-[a-z0-9]+)*)?$data[].object
modeldata[].created
Unix seconds at which this model id became available.data[].owned_by
prudaidata[].prudaidata[].prudai.product
LEO-family product offered through the shared chat API. IRMA and ORDO use their own operation sets, but a chat turn runs with the rights of the signed-in user and can read what that user’s product connects: for example mail, calendar, SharePoint and, forleo, ORDO dossiers. A chat turn never writes to connected systems; the model only keeps its own notes and task list within the conversation. Een van:leo,leo-fiscaal,zia,vera,bever,maiadata[].prudai.specialization
Specialisation slug, or null for the product itself. kannullzijndata[].prudai.display_namedata[].prudai.reasoning_efforts
Thereasoning_effortvalues that map to a distinct depth for this model; higher values are clamped to the highest listed one. Een van:low,medium,highdata[].prudai.default_reasoning_effort
Een van:low,medium,highdata[].prudai.ultra_available
Whetherprudai.depth: "ultra"is allowed for your organisation on this model.
curl -s "https://api.prudai.com/v1/models" \ -H "Authorization: Bearer $PRUDAI_TOKEN"prudai leo models list{ "object": "list", "data": [ { "id": "leo", "object": "model", "created": 1, "owned_by": "prudai", "prudai": { "product": "leo", "specialization": "string", "display_name": "LEO, Arbeidsrecht", "reasoning_efforts": [ "low" ], "default_reasoning_effort": "low", "ultra_available": false } } ]}Eén model opvragen
GET /v1/models/{model}
Retrieve one model.
- Stand: op productie.
- Scope:
prudai:models:read - Goedkeuring:
none, geen extra stap.
Parameters
modelverplicht
Model id. A specialisation contains a slash; URL-encode it (leo%2Farbeidsrecht) or pass it asleo/arbeidsrecht. A product, optionally followed by/and a specialisation slug (e.g.leo/arbeidsrecht). max. lengte 80 · patroon^(leo|leo-fiscaal|zia|vera|bever|maia)(/[a-z0-9]+(-[a-z0-9]+)*)?$
Antwoorden
| Status | Betekenis |
|---|---|
200 | The model. |
401 | Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment. |
403 | Authenticated, but not allowed (missing scope, product not on the key or organisation, organisation suspended, Developer API switched off for the organisation, IP not on the allowlist, depth not permitted, licence does not permit redistribution). |
404 | Unknown model, source or document. |
429 | Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded. |
500 | Unexpected error on Prudai’s side. Not charged, except work that completed before the failure (reported in details.charged_credits). |
Velden in het antwoord (200)
id
A product, optionally followed by/and a specialisation slug (e.g.leo/arbeidsrecht). max. lengte 80 · patroon^(leo|leo-fiscaal|zia|vera|bever|maia)(/[a-z0-9]+(-[a-z0-9]+)*)?$object
modelcreated
Unix seconds at which this model id became available.owned_by
prudaiprudaiprudai.product
LEO-family product offered through the shared chat API. IRMA and ORDO use their own operation sets, but a chat turn runs with the rights of the signed-in user and can read what that user’s product connects: for example mail, calendar, SharePoint and, forleo, ORDO dossiers. A chat turn never writes to connected systems; the model only keeps its own notes and task list within the conversation. Een van:leo,leo-fiscaal,zia,vera,bever,maiaprudai.specialization
Specialisation slug, or null for the product itself. kannullzijnprudai.display_nameprudai.reasoning_efforts
Thereasoning_effortvalues that map to a distinct depth for this model; higher values are clamped to the highest listed one. Een van:low,medium,highprudai.default_reasoning_effort
Een van:low,medium,highprudai.ultra_available
Whetherprudai.depth: "ultra"is allowed for your organisation on this model.
curl -s "https://api.prudai.com/v1/models/<model>" \ -H "Authorization: Bearer $PRUDAI_TOKEN"prudai leo models get{ "id": "leo", "object": "model", "created": 1, "owned_by": "prudai", "prudai": { "product": "leo", "specialization": "string", "display_name": "LEO, Arbeidsrecht", "reasoning_efforts": [ "low" ], "default_reasoning_effort": "low", "ultra_available": false }}