Prudai Developer API: modules
The operations of this part (Modules).
Base URL https://api.prudai.com/v1. Logging in is in Login, scopes in Scopes and permissions, errors in Errors. Overview.
| Method | Path | What it does | State |
|---|---|---|---|
GET | /v1/modules | List office modules and organization apps | Coming soon |
POST | /v1/modules | Build a private module draft | Coming soon |
POST | /v1/modules/{id}/publish | Publish an office module | Coming soon |
POST | /v1/modules/{id}/runs | Run an accessible module | Coming soon |
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.
- State: coming soon, not in production yet.
- Scope:
prudai:modules:read - Approval:
none, no extra step.
Parameters
X-Product-Slug
Optional workflow product context; defaults to the first entitled chat product. Apps are always listed. One of:leo,leo-fiscaal,zia,vera,bever,irma,maialimit
default:20· min 1 · max 100cursor
max length 200
Responses
| Status | Meaning |
|---|---|
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.
- State: coming soon, not in production yet.
- Scope:
prudai:modules:write - Approval:
none, no extra step. - Dry run:
?dryRun=trueshows what would happen and stores nothing. - Idempotency: send
Idempotency-Key; the same key with the same body does not run the action twice.
Parameters
X-Product-Slugrequired
Product context, checked against the current user and the workflow capability. One of:leo,leo-fiscaal,zia,vera,bever,irma,maiadryRun
Validate and preview without changing definitions, enqueuing jobs or recording gate decisions. One of:true,falseIdempotency-Keyrequired
Client-chosen key. Retry the same request safely; changed arguments with the same key are rejected. min length 8 · max length 255 · pattern^[\x21-\x7E]+$
Body
JSON, required.
namerequired
max length 200description
max length 2000 · may benullgraphrequiredgraph.nodesrequiredgraph.nodes[].idrequired
max length 128graph.nodes[].typerequired
One of:input,persona,output,condition,hitlgraph.nodes[].labelrequired
max length 300graph.nodes[].prompt
max length 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
One of:noop-passthroughgraph.nodes[].description
max length 4000graph.nodes[].presetId
max length 100graph.nodes[].style
One of:onderzoekend,strategisch,adversarieelgraph.nodes[].modelTier
One of:mini,standard,prograph.nodes[].runWhenIntakegraph.nodes[].machineTranslationgraph.nodes[].documentPipelinegraph.nodes[].slotsgraph.nodes[].statuteCheckgraph.nodes[].inputSectionsgraph.nodes[].dossierToolsgraph.nodes[].promptAxesgraph.nodes[].sourceIdsgraph.nodes[].deliverygraph.nodes[].positionrequiredgraph.edgesrequiredgraph.edges[].idrequired
max length 256graph.edges[].sourcerequired
max length 128graph.edges[].targetrequired
max length 128graph.edges[].branch
One of:ja,nee
Responses
| Status | Meaning |
|---|---|
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.
- State: coming soon, not in production yet.
- Scope:
prudai:modules:write - Approval:
confirm, the user confirms exactly this call. - Dry run:
?dryRun=trueshows what would happen and stores nothing.
Parameters
X-Product-Slugrequired
Product context, checked against the current user and the workflow capability. One of:leo,leo-fiscaal,zia,vera,bever,irma,maiaidrequireddryRun
Validate and preview without changing definitions, enqueuing jobs or recording gate decisions. One of: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. pattern^apr_[A-Za-z0-9]{24}$
Body
JSON, optional.
Responses
| Status | Meaning |
|---|---|
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.
- State: coming soon, not in production yet.
- Scope:
prudai:modules:write - Approval:
confirm, the user confirms exactly this call. - Dry run:
?dryRun=trueshows what would happen and stores nothing. - Idempotency: send
Idempotency-Key; the same key with the same body does not run the action twice.
Parameters
X-Product-Slugrequired
Product context, checked against the current user and the workflow capability. One of:leo,leo-fiscaal,zia,vera,bever,irma,maiaidrequireddryRun
Validate and preview without changing definitions, enqueuing jobs or recording gate decisions. One of: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. pattern^apr_[A-Za-z0-9]{24}$Idempotency-Keyrequired
Client-chosen key. Retry the same request safely; changed arguments with the same key are rejected. min length 8 · max length 255 · pattern^[\x21-\x7E]+$
Body
JSON, required.
inputrequiredinput.queryrequired
max length 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_idrequiredinput.artifact_ref.versionrequired
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_idrequiredinput.output_artifact_ref.versionrequired
min 0
Responses
| Status | Meaning |
|---|---|
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