Prudai Developer API: kantoormodules
Private and published office modules and app availability; personal tokens only, following the existing app access and approval rules.
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/modules | List office modules and organization apps | Binnenkort |
POST | /v1/modules | Build a private module draft | Binnenkort |
POST | /v1/modules/{id}/publish | Publish an office module | Binnenkort |
POST | /v1/modules/{id}/runs | Run an accessible module | Binnenkort |
List office modules and organization apps
GET /v1/modules
Lists published workflow modules for the selected product plus IRMA, ORDO, VERA, ZIA and BEVER with effective enabled status. Workflow entries require the existing workflow capability; app entries remain visible without it. Product activation stays a request, never an entitlement change. ORDO has no chat product slug; its activation request uses the Console URL.
- Stand: binnenkort, nog niet op productie.
- Scope:
prudai:modules:read - Goedkeuring:
none, geen extra stap.
Parameters
X-Product-Slug
Optional workflow product context; defaults to the first entitled chat product. Apps are always listed. Een van:leo,leo-fiscaal,zia,vera,bever,irma,maialimit
standaard:20· min. 1 · max. 100cursor
max. lengte 200
Antwoorden
| Status | Betekenis |
|---|---|
200 | Requested data with completeness and follow-up actions. |
400 | Malformed request or unsupported parameter (for example client-sent tools). |
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 | Workflow, run or deliverable not found or inaccessible. |
409 | State conflict, stale If-Match, or cancellation unavailable for the current run state. |
422 | Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body). |
429 | Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded. |
503 | Developer API or a required backing service is unavailable. |
curl -s "https://api.prudai.com/v1/modules" \ -H "Authorization: Bearer $PRUDAI_TOKEN"prudai leo modules listBuild a private module draft
POST /v1/modules
Creates an own private module workflow through the existing builder validation. All step model tiers are standard or cheaper. Creating a private draft needs no approval; running spends credits and needs confirm, publication needs one Owner/Admin confirmation.
- Stand: binnenkort, nog niet op productie.
- Scope:
prudai:modules:write - Goedkeuring:
none, geen extra stap. - Dry run:
?dryRun=truelaat zien wat er zou gebeuren en slaat niets op. - Idempotentie: stuur
Idempotency-Keymee; dezelfde sleutel met dezelfde body voert de actie niet twee keer uit.
Parameters
X-Product-Slugverplicht
Product context, checked against the current user and the workflow capability. Een van:leo,leo-fiscaal,zia,vera,bever,irma,maiadryRun
Validate and preview without changing definitions, enqueuing jobs or recording gate decisions. Een van:true,falseIdempotency-Keyverplicht
Client-chosen key. Retry the same request safely; changed arguments with the same key are rejected. min. lengte 8 · max. lengte 255 · patroon^[\x21-\x7E]+$
Body
JSON, verplicht.
nameverplicht
max. lengte 200description
max. lengte 2000 · kannullzijngraphverplichtgraph.nodesverplichtgraph.nodes[].idverplicht
max. lengte 128graph.nodes[].typeverplicht
Een van:input,persona,output,condition,hitlgraph.nodes[].labelverplicht
max. lengte 300graph.nodes[].prompt
max. lengte 20000graph.nodes[].artifact_ref
Exact immutable source version or expected current output version. Version zero denotes the historical empty baseline where supported.graph.nodes[].conditiongraph.nodes[].hitlgraph.nodes[].v1Execution
Een van:noop-passthroughgraph.nodes[].description
max. lengte 4000graph.nodes[].presetId
max. lengte 100graph.nodes[].style
Een van:onderzoekend,strategisch,adversarieelgraph.nodes[].modelTier
Een van:mini,standard,prograph.nodes[].runWhenIntakegraph.nodes[].machineTranslationgraph.nodes[].documentPipelinegraph.nodes[].slotsgraph.nodes[].statuteCheckgraph.nodes[].inputSectionsgraph.nodes[].dossierToolsgraph.nodes[].promptAxesgraph.nodes[].sourceIdsgraph.nodes[].deliverygraph.nodes[].positionverplichtgraph.edgesverplichtgraph.edges[].idverplicht
max. lengte 256graph.edges[].sourceverplicht
max. lengte 128graph.edges[].targetverplicht
max. lengte 128graph.edges[].branch
Een van:ja,nee
Antwoorden
| Status | Betekenis |
|---|---|
200 | Idempotent replay or dry-run preview. |
201 | Completed. With dryRun=true, returns a preview without side effects. |
400 | Malformed request or unsupported parameter (for example client-sent tools). |
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 | Workflow, run or deliverable not found or inaccessible. |
409 | State conflict, stale If-Match, or cancellation unavailable for the current run state. |
422 | Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body). |
429 | Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded. |
503 | Developer API or a required backing service is unavailable. |
curl -s -X POST "https://api.prudai.com/v1/modules" \ -H "Authorization: Bearer $PRUDAI_TOKEN" \ -H "X-Product-Slug: leo" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ ... }'prudai leo modules createPublish an office module
POST /v1/modules/{id}/publish
Requires one Owner/Admin confirmation through the existing approval service, including the creator when they hold that role. The recorded approval is the audit trail. Publishes the exact approved private module revision in the organization library; another organization cannot see it. A changed revision invalidates the grant.
- Stand: binnenkort, nog niet op productie.
- Scope:
prudai:modules:write - Goedkeuring:
confirm, de gebruiker bevestigt precies deze aanroep. - Dry run:
?dryRun=truelaat zien wat er zou gebeuren en slaat niets op.
Parameters
X-Product-Slugverplicht
Product context, checked against the current user and the workflow capability. Een van:leo,leo-fiscaal,zia,vera,bever,irma,maiaidverplichtdryRun
Validate and preview without changing definitions, enqueuing jobs or recording gate decisions. Een van:true,falsex-prudai-approval
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, optioneel.
Antwoorden
| Status | Betekenis |
|---|---|
200 | Idempotent replay or dry-run preview. |
202 | Waiting for human approval. Replay the exact request with its one-use approval grant. |
400 | Malformed request or unsupported parameter (for example client-sent tools). |
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 | Workflow, run or deliverable not found or inaccessible. |
409 | State conflict, stale If-Match, or cancellation unavailable for the current run state. |
422 | Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body). |
429 | Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded. |
503 | Developer API or a required backing service is unavailable. |
curl -s -X POST "https://api.prudai.com/v1/modules/<id>/publish" \ -H "Authorization: Bearer $PRUDAI_TOKEN" \ -H "X-Product-Slug: leo" \ -H "Content-Type: application/json" \ -d '{}'prudai leo modules publishRun an accessible module
POST /v1/modules/{id}/runs
Starts an own private or published organization module as the signed-in person through the existing workflow engine and capability gates. Requires confirm approval because execution spends credits. The grant binds product, input, module version and exact revision.
- Stand: binnenkort, nog niet op productie.
- Scope:
prudai:modules:write - Goedkeuring:
confirm, de gebruiker bevestigt precies deze aanroep. - Dry run:
?dryRun=truelaat zien wat er zou gebeuren en slaat niets op. - Idempotentie: stuur
Idempotency-Keymee; dezelfde sleutel met dezelfde body voert de actie niet twee keer uit.
Parameters
X-Product-Slugverplicht
Product context, checked against the current user and the workflow capability. Een van:leo,leo-fiscaal,zia,vera,bever,irma,maiaidverplichtdryRun
Validate and preview without changing definitions, enqueuing jobs or recording gate decisions. Een van:true,falsex-prudai-approval
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}$Idempotency-Keyverplicht
Client-chosen key. Retry the same request safely; changed arguments with the same key are rejected. min. lengte 8 · max. lengte 255 · patroon^[\x21-\x7E]+$
Body
JSON, verplicht.
inputverplichtinput.queryverplicht
max. lengte 100000input.projectIdinput.documentIdsinput.artifact_ref
Exact immutable source version or expected current output version. Version zero denotes the historical empty baseline where supported.input.artifact_ref.artifact_idverplichtinput.artifact_ref.versionverplicht
min. 0input.output_artifact_ref
Exact immutable source version or expected current output version. Version zero denotes the historical empty baseline where supported.input.output_artifact_ref.artifact_idverplichtinput.output_artifact_ref.versionverplicht
min. 0
Antwoorden
| Status | Betekenis |
|---|---|
200 | Idempotent replay or dry-run preview. |
201 | Completed. With dryRun=true, returns a preview without side effects. |
202 | Waiting for human approval. Replay the exact request with its one-use approval grant. |
400 | Malformed request or unsupported parameter (for example client-sent tools). |
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 | Workflow, run or deliverable not found or inaccessible. |
409 | State conflict, stale If-Match, or cancellation unavailable for the current run state. |
422 | Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body). |
429 | Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded. |
503 | Developer API or a required backing service is unavailable. |
curl -s -X POST "https://api.prudai.com/v1/modules/<id>/runs" \ -H "Authorization: Bearer $PRUDAI_TOKEN" \ -H "X-Product-Slug: leo" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "input": { "query": "string", "projectId": "00000000-0000-4000-8000-000000000000", "documentIds": [ "00000000-0000-4000-8000-000000000000" ], "artifact_ref": { "artifact_id": "00000000-0000-4000-8000-000000000000", "version": 1 }, "output_artifact_ref": { "artifact_id": "00000000-0000-4000-8000-000000000000", "version": 1 } } }'prudai leo modules runs