Ga naar inhoud

Prudai Developer API: ontdekken

De specificatie en de scopecatalogus, openbaar en zonder inloggen.

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/capabilitiesRead available features and activation guidanceOp productie
POST/v1/capabilities/{id}/disableTurn a feature or setting offBinnenkort
POST/v1/capabilities/{id}/enableTurn a feature or setting onBinnenkort
POST/v1/capabilities/{id}/requestRequest a paid feature or extra productBinnenkort
GET/v1/guideRead the caller’s agent guideOp productie
GET/v1/integrationsRead integration availability and connection guidanceOp productie
GET/v1/openapi.jsonDe OpenAPI-specificatie ophalenOp productie
GET/v1/scopesDe scopecatalogus ophalenOp productie
GET/v1/skillsList the Prudai skills available to the callerOp productie
GET/v1/skills/{name}Read one available Prudai skillOp productie

Read available features and activation guidance

GET /v1/capabilities

Uses current product entitlements and feature gates for this organisation and user. Enabled describes current entitlement and configuration status; each operation still checks user and object rights. scope_granted independently describes access through this credential. Activation is guidance only; this operation changes no setting. enable.kind is self for an existing app setting (exact POST, scope and product), connect for a consent flow from GET /v1/integrations, and request for paid features or extra products (human-reviewed POST, never direct entitlement changes). Unknown costs are explicitly unknown and are never a promise of free activation.

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

Parameters

  • product query · string
    Exact entitled product slug. Omit to use all products available to the caller. patroon ^[a-z][a-z0-9-]{0,79}$

Antwoorden

StatusBetekenis
200Feature metadata in the task envelope.
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).
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
curl
curl -s "https://api.prudai.com/v1/capabilities" \
-H "Authorization: Bearer $PRUDAI_TOKEN"
CLI (binnenkort)
prudai leo capabilities list
Antwoord 200
[
{
"id": "string",
"product": "string",
"title": "string",
"description": "string",
"enabled": false,
"reason": "string",
"scope": "string",
"scope_granted": false,
"enable": {
"kind": "self",
"method": "POST",
"path": "string",
"scope": "string",
"params": {
"product": "leo"
},
"url": "https://voorbeeld.nl",
"approval": "none",
"costs": "unknown",
"approver": "string"
},
"disable": {
"kind": "self",
"method": "POST",
"path": "string",
"scope": "string",
"params": {
"product": "leo"
},
"url": "https://voorbeeld.nl",
"approval": "none",
"costs": "unknown",
"approver": "string"
},
"costs": "unknown"
}
]

Turn a feature or setting off

POST /v1/capabilities/{id}/disable

Changes only an existing app setting through its existing service and role checks. Organisation settings require the same owner or administrator role as the app; personal settings affect only the caller. Unsupported settings, paid capabilities and integrations cannot be enabled or disabled here. No entitlement is granted. Personal and signed-in user tokens only; service credentials are rejected. Idempotency-Key is mandatory. dryRun=true validates and previews without changing settings, creating an approval request or granting any capability.

Only the toggles (writing-style, organization-social, feed-quiz) have an off switch: they keep their data. The settings that hold your own content (source-settings, publisher-subscriptions, organization-prompt, escalation-settings) return 422 validation_error here, because switching them off would overwrite that content; clear one with enable and the exact new value instead.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:capabilities:write
  • Goedkeuring: confirm, de gebruiker bevestigt precies deze aanroep.
  • Dry run: ?dryRun=true laat zien wat er zou gebeuren en slaat niets op.
  • Idempotentie: stuur Idempotency-Key mee; dezelfde sleutel met dezelfde body voert de actie niet twee keer uit.

Parameters

  • id path · string verplicht
    Exact id from GET /v1/capabilities; product requests use product:<slug>. max. lengte 160
  • dryRun query · boolean
    Validate and preview without changing settings or creating an approval request. standaard: false
  • Idempotency-Key header · string verplicht
    Client-chosen key, retained for 24 hours. Reusing it for different arguments returns 422 idempotency_key_reused. min. lengte 8 · max. lengte 255 · patroon ^[\x21-\x7E]+$
  • x-prudai-approval header · string
    Approved one-use request id. Repeat the exact method, path, query and body. The grant is consumed before execution; obtain a new approval after a failed execution. Idempotency-Key is excluded from the approval fingerprint. patroon ^apr_[A-Za-z0-9]{24}$

Body

JSON, verplicht.

  • product string
    Exact product slug. Runtime product and staff restrictions still apply. Een van: leo, leo-fiscaal, zia, vera, bever, maia, irma
  • settings object
    Waarden voor de gekozen instelling zoals hierboven beschreven. Andere velden worden geweigerd. Laat weg of geef een leeg object bij de drie aan/uit-schakelaars en bij elke uitzetactie.

Antwoorden

StatusBetekenis
200Validated dry-run preview or the recorded idempotent result.
202Human approval is required; no setting or entitlement has been changed.
400Invalid input or missing Idempotency-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).
404Unknown or unavailable capability or setting.
409Capability needs another activation kind, or the setting cannot be changed.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
curl
curl -s -X POST "https://api.prudai.com/v1/capabilities/<id>/disable" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"product": "leo",
"settings": {
"disabledSourceIds": [
"example-source"
]
}
}'
CLI (binnenkort)
prudai leo capabilities disable

Turn a feature or setting on

POST /v1/capabilities/{id}/enable

Changes only an existing app setting through its existing service and role checks. Organisation settings require the same owner or administrator role as the app; personal settings affect only the caller. Unsupported settings, paid capabilities and integrations cannot be enabled or disabled here. No entitlement is granted. Personal and signed-in user tokens only; service credentials are rejected. Idempotency-Key is mandatory. dryRun=true validates and previews without changing settings, creating an approval request or granting any capability.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:capabilities:write
  • Goedkeuring: confirm, de gebruiker bevestigt precies deze aanroep.
  • Dry run: ?dryRun=true laat zien wat er zou gebeuren en slaat niets op.
  • Idempotentie: stuur Idempotency-Key mee; dezelfde sleutel met dezelfde body voert de actie niet twee keer uit.

Parameters

  • id path · string verplicht
    Exact id from GET /v1/capabilities; product requests use product:<slug>. max. lengte 160
  • dryRun query · boolean
    Validate and preview without changing settings or creating an approval request. standaard: false
  • Idempotency-Key header · string verplicht
    Client-chosen key, retained for 24 hours. Reusing it for different arguments returns 422 idempotency_key_reused. min. lengte 8 · max. lengte 255 · patroon ^[\x21-\x7E]+$
  • x-prudai-approval header · string
    Approved one-use request id. Repeat the exact method, path, query and body. The grant is consumed before execution; obtain a new approval after a failed execution. Idempotency-Key is excluded from the approval fingerprint. patroon ^apr_[A-Za-z0-9]{24}$

Body

JSON, verplicht.

  • product string
    Exact product slug. Runtime product and staff restrictions still apply. Een van: leo, leo-fiscaal, zia, vera, bever, maia, irma
  • settings object
    Waarden voor de gekozen instelling zoals hierboven beschreven. Andere velden worden geweigerd. Laat weg of geef een leeg object bij de drie aan/uit-schakelaars en bij elke uitzetactie.

Antwoorden

StatusBetekenis
200Validated dry-run preview or the recorded idempotent result.
202Human approval is required; no setting or entitlement has been changed.
400Invalid input or missing Idempotency-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).
404Unknown or unavailable capability or setting.
409Capability needs another activation kind, or the setting cannot be changed.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
curl
curl -s -X POST "https://api.prudai.com/v1/capabilities/<id>/enable" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"product": "leo",
"settings": {
"disabledSourceIds": [
"example-source"
]
}
}'
CLI (binnenkort)
prudai leo capabilities enable

Request a paid feature or extra product

POST /v1/capabilities/{id}/request

Records an activation request in the existing human-approval store. Never changes entitlements, starts a subscription or makes a payment. Only a Prudai platform administrator can grant plan capabilities. Costs remain unknown unless an authoritative price is available. Returns the upgrade link https://account.prudai.com/console. Approval or replay never activates the feature. Personal and signed-in user tokens only; service credentials are rejected. Idempotency-Key is mandatory. dryRun=true validates and previews without changing settings, creating an approval request or granting any capability.

  • Stand: binnenkort, nog niet op productie.
  • Scope: prudai:capabilities:request
  • Goedkeuring: review, een tweede persoon of rol keurt goed.
  • Dry run: ?dryRun=true laat zien wat er zou gebeuren en slaat niets op.
  • Idempotentie: stuur Idempotency-Key mee; dezelfde sleutel met dezelfde body voert de actie niet twee keer uit.

Parameters

  • id path · string verplicht
    Exact id from GET /v1/capabilities; product requests use product:<slug>. max. lengte 160
  • dryRun query · boolean
    Validate and preview without changing settings or creating an approval request. standaard: false
  • Idempotency-Key header · string verplicht
    Client-chosen key, retained for 24 hours. Reusing it for different arguments returns 422 idempotency_key_reused. min. lengte 8 · max. lengte 255 · patroon ^[\x21-\x7E]+$
  • x-prudai-approval header · string
    Approved one-use request id. Repeat the exact method, path, query and body. The grant is consumed before execution; obtain a new approval after a failed execution. Idempotency-Key is excluded from the approval fingerprint. patroon ^apr_[A-Za-z0-9]{24}$

Body

JSON, verplicht.

  • product string verplicht
    Exact product slug. Runtime product and staff restrictions still apply. Een van: leo, leo-fiscaal, zia, vera, bever, maia, irma
  • reason string
    Optional reason shown to the human reviewer; never interpreted as permission to activate or pay. max. lengte 1000

Antwoorden

StatusBetekenis
200Validated dry-run preview or the recorded idempotent result.
202Human approval is required; no setting or entitlement has been changed.
400Invalid input or missing Idempotency-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).
404Unknown or unavailable capability or setting.
409Capability needs another activation kind, or the setting cannot be changed.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
curl
curl -s -X POST "https://api.prudai.com/v1/capabilities/<id>/request" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"product": "leo",
"reason": "string"
}'
CLI (binnenkort)
prudai leo capabilities request

Read the caller's agent guide

GET /v1/guide

A short factual guide generated from the same product, scope and integration sources as discovery. Includes device login, approval requests and follow-up calls. Explains self, connect and request activation with examples; org entitlements remain under Prudai platform-admin control and payment always requires a person. Any valid credential may read this guide without an additional scope. It contains no customer content. Send Accept text/markdown for the Markdown text directly; application/json returns the same text under data.markdown in the task envelope.

  • Stand: op productie.
  • Scope: geen aparte scope; inloggen met je sleutel of token is wel nodig.
  • Goedkeuring: none, geen extra stap.

Antwoorden

StatusBetekenis
200Agent guide in the requested representation.
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).

Velden in data (200)

  • markdown string

Formaat van het antwoord: text/markdown.

curl
curl -s "https://api.prudai.com/v1/guide" \
-H "Authorization: Bearer $PRUDAI_TOKEN"
CLI (binnenkort)
prudai leo guide
Antwoord 200
{
"markdown": "string"
}

Read integration availability and connection guidance

GET /v1/integrations

Lists available integrations and the current user or organisation status through their existing integration gates. Does not connect, disconnect or grant consent. Consent links are app routes that require the user’s authenticated browser session; credentials and provider tokens are never returned. An unavailable status check is reported as unknown rather than disconnected.

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

Parameters

  • product query · string
    Exact entitled product slug. Omit to use all products available to the caller. patroon ^[a-z][a-z0-9-]{0,79}$

Antwoorden

StatusBetekenis
200Integration metadata and connection steps in the task envelope.
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).
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
curl
curl -s "https://api.prudai.com/v1/integrations" \
-H "Authorization: Bearer $PRUDAI_TOKEN"
CLI (binnenkort)
prudai leo integrations
Antwoord 200
[
{}
]

De OpenAPI-specificatie ophalen

GET /v1/openapi.json

Read the implemented public API contract.

Public discovery without credentials. Returns the OpenAPI document directly, so spec registries and CLI generators can consume it. Paths contain implemented/live operations; x-prudai-planned-operations lists the planned operation ids, methods and paths with their planned status. This document describes public API metadata only, never tenant data.

  • Stand: op productie.
  • Scope: geen, openbaar zonder inloggen.
  • Goedkeuring: none, geen extra stap.

Antwoorden

StatusBetekenis
200An OpenAPI 3.1 document (a documented raw-response exception).
304The public metadata snapshot has not changed (empty body).

Velden in het antwoord (200)

  • openapi string
    3.1.0
  • info object
  • paths object
  • components object
  • x-prudai-planned-operations array<object>
  • x-prudai-planned-operations[].operationId string
  • x-prudai-planned-operations[].method string
  • x-prudai-planned-operations[].path string
  • x-prudai-planned-operations[].x-prudai-status any
    planned
curl
curl -s "https://api.prudai.com/v1/openapi.json"
CLI (binnenkort)
prudai leo openapi.json
Antwoord 200
{
"openapi": "3.1.0",
"info": {},
"paths": {},
"components": {},
"x-prudai-planned-operations": [
{
"operationId": "string",
"method": "string",
"path": "string",
"x-prudai-status": "planned"
}
]
}

De scopecatalogus ophalen

GET /v1/scopes

Read the public scope catalogue.

Public discovery without credentials. Returns the same generated scope catalogue as the console; issuable and explicit_only describe availability and wildcard matching. The catalogue describes scopes and operations, not the caller’s grants.

  • Stand: op productie.
  • Scope: geen, openbaar zonder inloggen.
  • Goedkeuring: none, geen extra stap.

Antwoorden

StatusBetekenis
200Generated scope catalogue in the task envelope.
304The public metadata snapshot has not changed (empty body).

Velden in data (200)

  • schema any
    1
  • wildcards object
  • products array<object>
curl
curl -s "https://api.prudai.com/v1/scopes"
CLI (binnenkort)
prudai leo scopes
Antwoord 200
{
"schema": 1,
"wildcards": {},
"products": [
{}
]
}

List the Prudai skills available to the caller

GET /v1/skills

Read-only skill discovery using the same product and capability gates as chat. Only the Prudai namespace is currently available; organisation skills will be additive. Omit product to list skills across the caller’s entitled products. The cursor is opaque and bound to that selection. Instructions are returned by getSkill.

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

Parameters

  • product query · string
    Exact entitled product slug. Omit to use all products available to the caller. patroon ^[a-z][a-z0-9-]{0,79}$
  • limit query · integer
    standaard: 100 · min. 1 · max. 100
  • cursor query · string
    max. lengte 200

Antwoorden

StatusBetekenis
200Skills in the task envelope; completeness and next describe pagination.
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).
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
curl
curl -s "https://api.prudai.com/v1/skills" \
-H "Authorization: Bearer $PRUDAI_TOKEN"
CLI (binnenkort)
prudai leo skills list
Antwoord 200
[
{
"namespace": "prudai",
"name": "string",
"title": "string",
"description": "string",
"products": [
"string"
]
}
]

Read one available Prudai skill

GET /v1/skills/{name}

Returns registry frontmatter and instructions through the same product, capability, role and callable-tool gates as the app loader. The specialization focus filters the list only; it does not restrict reading an available skill by name.

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

Parameters

  • name path · string verplicht
    min. lengte 3 · max. lengte 40 · patroon ^[a-z0-9][a-z0-9-]{1,38}[a-z0-9]$
  • product query · string
    Exact entitled product slug. Omit to use all products available to the caller. patroon ^[a-z][a-z0-9-]{0,79}$

Antwoorden

StatusBetekenis
200The available skill and instructions in the task envelope.
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).
404The skill does not exist or is unavailable to the caller.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).

Velden in data (200)

  • namespace string
    prudai
  • name string
  • title string
  • description string
  • products array<string>
  • frontmatter object
  • body string
curl
curl -s "https://api.prudai.com/v1/skills/<name>" \
-H "Authorization: Bearer $PRUDAI_TOKEN"
CLI (binnenkort)
prudai leo skills get
Antwoord 200
{
"namespace": "prudai",
"name": "string",
"title": "string",
"description": "string",
"products": [
"string"
],
"frontmatter": {},
"body": "string"
}