Skip to content

Prudai Developer API: models

The model is the product: LEO, LEO Fiscaal, ZIA, VERA, BEVER and MAIA. You only see what your organisation has and what your token may use.

Base URL https://api.prudai.com/v1. Logging in is in Login, scopes in Scopes and permissions, errors in Errors. Overview.

MethodPathWhat it doesState
GET/v1/modelsList the models your key may useIn production
GET/v1/models/{model}Retrieve one modelIn production

List the models your key may use

GET /v1/models

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.

  • State: in production.
  • Scope: prudai:models:read
  • Approval: none, no extra step.

Responses

StatusMeaning
200The models available to this key.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, 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).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
500Unexpected error on Prudai’s side. Not charged, except work that completed before the failure (reported in details.charged_credits).
503Temporarily unavailable (maintenance, overload, or the credit check could not be performed). Nothing ran, nothing is charged.

Fields in the response (200)

  • object string
    list
  • data array<Model>
  • data[].id string
    A product, optionally followed by / and a specialisation slug (e.g. leo/arbeidsrecht). max length 80 · pattern ^(leo|leo-fiscaal|zia|vera|bever|maia)(/[a-z0-9]+(-[a-z0-9]+)*)?$
  • data[].object string
    model
  • data[].created integer
    Unix seconds at which this model id became available.
  • data[].owned_by string
    prudai
  • data[].prudai ModelPrudai
  • data[].prudai.product string
    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, for leo, ORDO dossiers. A chat turn never writes to connected systems; the model only keeps its own notes and task list within the conversation. One of: leo, leo-fiscaal, zia, vera, bever, maia
  • data[].prudai.specialization string
    Specialisation slug, or null for the product itself. may be null
  • data[].prudai.display_name string
  • data[].prudai.reasoning_efforts array<string>
    The reasoning_effort values that map to a distinct depth for this model; higher values are clamped to the highest listed one. One of: low, medium, high
  • data[].prudai.default_reasoning_effort string
    One of: low, medium, high
  • data[].prudai.ultra_available boolean
    Whether prudai.depth: "ultra" is allowed for your organisation on this model.
curl
curl -s "https://api.prudai.com/v1/models" \
-H "Authorization: Bearer $PRUDAI_TOKEN"
CLI (coming soon)
prudai leo models list
Response 200
{
"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
}
}
]
}

Retrieve one model

GET /v1/models/{model}

  • State: in production.
  • Scope: prudai:models:read
  • Approval: none, no extra step.

Parameters

  • model path · string required
    Model id. A specialisation contains a slash; URL-encode it (leo%2Farbeidsrecht) or pass it as leo/arbeidsrecht. A product, optionally followed by / and a specialisation slug (e.g. leo/arbeidsrecht). max length 80 · pattern ^(leo|leo-fiscaal|zia|vera|bever|maia)(/[a-z0-9]+(-[a-z0-9]+)*)?$

Responses

StatusMeaning
200The model.
401Missing, malformed, unknown, expired or revoked key, or a key used against the wrong environment.
403Authenticated, 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).
404Unknown model, source or document.
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
500Unexpected error on Prudai’s side. Not charged, except work that completed before the failure (reported in details.charged_credits).

Fields in the response (200)

  • id string
    A product, optionally followed by / and a specialisation slug (e.g. leo/arbeidsrecht). max length 80 · pattern ^(leo|leo-fiscaal|zia|vera|bever|maia)(/[a-z0-9]+(-[a-z0-9]+)*)?$
  • object string
    model
  • created integer
    Unix seconds at which this model id became available.
  • owned_by string
    prudai
  • prudai ModelPrudai
  • prudai.product string
    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, for leo, ORDO dossiers. A chat turn never writes to connected systems; the model only keeps its own notes and task list within the conversation. One of: leo, leo-fiscaal, zia, vera, bever, maia
  • prudai.specialization string
    Specialisation slug, or null for the product itself. may be null
  • prudai.display_name string
  • prudai.reasoning_efforts array<string>
    The reasoning_effort values that map to a distinct depth for this model; higher values are clamped to the highest listed one. One of: low, medium, high
  • prudai.default_reasoning_effort string
    One of: low, medium, high
  • prudai.ultra_available boolean
    Whether prudai.depth: "ultra" is allowed for your organisation on this model.
curl
curl -s "https://api.prudai.com/v1/models/<model>" \
-H "Authorization: Bearer $PRUDAI_TOKEN"
CLI (coming soon)
prudai leo models get
Response 200
{
"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
}
}