Ga naar inhoud

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.

MethodePadWat het doetStand
GET/v1/modelsModellen opvragen die je sleutel mag gebruikenOp productie
GET/v1/models/{model}Eén model opvragenOp 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

StatusBetekenis
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.

Velden in het antwoord (200)

  • object string
    list
  • data array<Model>
  • data[].id string
    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 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. Een van: leo, leo-fiscaal, zia, vera, bever, maia
  • data[].prudai.specialization string
    Specialisation slug, or null for the product itself. kan null zijn
  • 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. Een van: low, medium, high
  • data[].prudai.default_reasoning_effort string
    Een van: 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 (binnenkort)
prudai leo models list
Antwoord 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
}
}
]
}

Eén model opvragen

GET /v1/models/{model}

Retrieve one model.

  • Stand: op productie.
  • Scope: prudai:models:read
  • Goedkeuring: none, geen extra stap.

Parameters

  • model path · string verplicht
    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. lengte 80 · patroon ^(leo|leo-fiscaal|zia|vera|bever|maia)(/[a-z0-9]+(-[a-z0-9]+)*)?$

Antwoorden

StatusBetekenis
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).

Velden in het antwoord (200)

  • id string
    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 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. Een van: leo, leo-fiscaal, zia, vera, bever, maia
  • prudai.specialization string
    Specialisation slug, or null for the product itself. kan null zijn
  • 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. Een van: low, medium, high
  • prudai.default_reasoning_effort string
    Een van: 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 (binnenkort)
prudai leo models get
Antwoord 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
}
}