Prudai Developer API: workflowuitvoeringen
Workflow runs, human gates and deliverables; personal tokens only. Starting or continuing a run spends credits.
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/artifacts/{id}/runs | List workflow runs that produced an artifact | Binnenkort |
GET | /v1/workflow-runs | List the caller’s workflow runs | Binnenkort |
GET | /v1/workflow-runs/{id} | Get workflow status, steps and events | Binnenkort |
POST | /v1/workflow-runs/{id}/cancel | Stop a workflow run | Binnenkort |
POST | /v1/workflow-runs/{id}/continue | Continue a resumable workflow run | Binnenkort |
GET | /v1/workflow-runs/{id}/deliverables | List workflow run deliverables | Binnenkort |
GET | /v1/workflow-runs/{id}/deliverables/{deliverable_id}/download | Download a workflow deliverable | Binnenkort |
POST | /v1/workflow-runs/{id}/gate | Answer a waiting human gate | Binnenkort |
GET | /v1/workflow-runs/{id}/tables | List named tables produced by a workflow run | Binnenkort |
POST | /v1/workflows/{id}/runs | Start a workflow definition run | Binnenkort |
POST | /v1/workflows/templates/{id}/runs | Start a curated workflow template run | Binnenkort |
List workflow runs that produced an artifact
GET /v1/artifacts/{id}/runs
Returns metadata only after checking the artifact source access and the run owner. The exact total is unknown (completeness.total is null); next contains the next page when more rows exist. Personal tokens and signed-in user tokens only; service keys are rejected. The same product, organisation, workflow capability and ownership rules as the app apply, including 403 workflows_upgrade_required for VERA without Pro.
- Stand: binnenkort, nog niet op productie.
- Scope:
prudai:artifacts:read,prudai:workflows:read - Goedkeuring:
none, geen extra stap.
Parameters
X-Product-Slugverplicht
Product context, checked against the current user and the workflow capability. Een van:leo,leo-fiscaal,zia,vera,bever,irma,maiaidverplichtlimit
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/artifacts/<id>/runs" \ -H "Authorization: Bearer $PRUDAI_TOKEN" \ -H "X-Product-Slug: leo"prudai leo artifacts runs[ { "run_id": "00000000-0000-4000-8000-000000000000", "artifact_ref": { "artifact_id": "00000000-0000-4000-8000-000000000000", "version": 1 }, "created_at": "2026-11-05T09:30:00.000Z" }]List the caller's workflow runs
GET /v1/workflow-runs
Only workflow runs are included. The existing app listing is capped; when the complete total is unknown completeness.total is null and notIncluded explains the source limit. Personal tokens and signed-in user tokens only; service keys are rejected. The same product, organisation, workflow capability and ownership rules as the app apply, including 403 workflows_upgrade_required for VERA without Pro.
- Stand: binnenkort, nog niet op productie.
- Scope:
prudai:workflow_runs:read - Goedkeuring:
none, geen extra stap.
Parameters
X-Product-Slugverplicht
Product context, checked against the current user and the workflow capability. Een van:leo,leo-fiscaal,zia,vera,bever,irma,maiaprojectIdstatus
max. lengte 80limit
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/workflow-runs" \ -H "Authorization: Bearer $PRUDAI_TOKEN" \ -H "X-Product-Slug: leo"prudai leo workflow-runs listGet workflow status, steps and events
GET /v1/workflow-runs/{id}
Returns the app run state including logs, progress, budget and any waiting gate. Once completed, next points to listWorkflowRunDeliverables. Personal tokens and signed-in user tokens only; service keys are rejected. The same product, organisation, workflow capability and ownership rules as the app apply, including 403 workflows_upgrade_required for VERA without Pro.
- Stand: binnenkort, nog niet op productie.
- Scope:
prudai:workflow_runs:read - Goedkeuring:
none, geen extra stap.
Parameters
X-Product-Slugverplicht
Product context, checked against the current user and the workflow capability. Een van:leo,leo-fiscaal,zia,vera,bever,irma,maiaidverplicht
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. |
Velden in data (200)
artifact_ref
Exact immutable source version or expected current output version. Version zero denotes the historical empty baseline where supported.artifact_ref.artifact_idartifact_ref.version
min. 0previousAttemptpreviousAttempt.statuspreviousAttempt.finishedAt
kannullzijnpreviousAttempt.archivedAtpreviousAttempt.resultpreviousAttempt.error
kannullzijnpreviousAttempt.deliverableCountjobIdstatustopiccreatedAtprojectIdprojectDocumentIdsdocumentMode
Een van:auto,selection,noneeffectiveProjectDocumentIdsprojectNamelogslogs[].agentlogs[].messagelogs[].timestampresulterror
kannullzijnwarnings
kannullzijnuiUrlmetadocumentScopequeuequeue.statequeue.position
kannullzijnqueue.etaSeconds
kannullzijnqueue.reason
kannullzijnqueue.checkedAt
kannullzijnbudgetUsageprogressbudgetbudget.limitsbudget.limits.maxEstimatedTokens
Deze lijst stopt na 40 velden.
curl -s "https://api.prudai.com/v1/workflow-runs/<id>" \ -H "Authorization: Bearer $PRUDAI_TOKEN" \ -H "X-Product-Slug: leo"prudai leo workflow-runs getStop a workflow run
POST /v1/workflow-runs/{id}/cancel
Stops the caller’s own run. At a waiting human gate it submits the gate abort. A queued or running run is stopped cooperatively: no further step starts, the steps already in flight finish, and the run ends as aborted with everything that completed as partial result (the run history is kept, nothing is deleted); the response is status: stopping and getWorkflowRun shows aborted shortly after. A run that is still waiting in the queue (for example for capacity) starts no step at all: it ends as aborted with an empty partial result, without a model call and therefore without cost, as soon as it is picked up; until then getWorkflowRun still shows queued. A run that has already ended returns 409 workflow_cancel_unavailable. Personal tokens and signed-in user tokens only; service keys are rejected. The same product, organisation, workflow capability and ownership rules as the app apply, including 403 workflows_upgrade_required for VERA without Pro.
- Stand: binnenkort, nog niet op productie.
- Scope:
prudai:workflow_runs:write - Goedkeuring:
none, geen extra stap. - 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,false
Body
JSON, verplicht.
Antwoorden
| Status | Betekenis |
|---|---|
200 | 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/workflow-runs/<id>/cancel" \ -H "Authorization: Bearer $PRUDAI_TOKEN" \ -H "X-Product-Slug: leo" \ -H "Content-Type: application/json" \ -d '{}'prudai leo workflow-runs cancelContinue a resumable workflow run
POST /v1/workflow-runs/{id}/continue
Preserves completed steps and starts a fresh budget window through the existing app continuation service. The owner continues their own run directly, as in the app; the run budget still applies. Personal tokens and signed-in user tokens only; service keys are rejected. The same product, organisation, workflow capability and ownership rules as the app apply, including 403 workflows_upgrade_required for VERA without Pro.
- Stand: binnenkort, nog niet op productie.
- Scope:
prudai:workflow_runs:write - Goedkeuring:
none, geen extra stap. - 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,false
Body
JSON, verplicht.
Antwoorden
| Status | Betekenis |
|---|---|
200 | 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/workflow-runs/<id>/continue" \ -H "Authorization: Bearer $PRUDAI_TOKEN" \ -H "X-Product-Slug: leo" \ -H "Content-Type: application/json" \ -d '{}'prudai leo workflow-runs continueList workflow run deliverables
GET /v1/workflow-runs/{id}/deliverables
A run of your own without deliverables (yet) returns an empty list, not 404. Personal tokens and signed-in user tokens only; service keys are rejected. The same product, organisation, workflow capability and ownership rules as the app apply, including 403 workflows_upgrade_required for VERA without Pro.
- Stand: binnenkort, nog niet op productie.
- Scope:
prudai:workflow_runs:read - Goedkeuring:
none, geen extra stap.
Parameters
X-Product-Slugverplicht
Product context, checked against the current user and the workflow capability. Een van:leo,leo-fiscaal,zia,vera,bever,irma,maiaidverplicht
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/workflow-runs/<id>/deliverables" \ -H "Authorization: Bearer $PRUDAI_TOKEN" \ -H "X-Product-Slug: leo"prudai leo workflow-runs-deliverables listDownload a workflow deliverable
GET /v1/workflow-runs/{id}/deliverables/{deliverable_id}/download
Returns the original rendered bytes with Content-Type and Content-Disposition, as in the app. This binary response is an explicit exception to the JSON envelope. Personal tokens and signed-in user tokens only; service keys are rejected. The same product, organisation, workflow capability and ownership rules as the app apply, including 403 workflows_upgrade_required for VERA without Pro.
- Stand: binnenkort, nog niet op productie.
- Scope:
prudai:workflow_runs:read - Goedkeuring:
none, geen extra stap.
Parameters
X-Product-Slugverplicht
Product context, checked against the current user and the workflow capability. Een van:leo,leo-fiscaal,zia,vera,bever,irma,maiaidverplichtdeliverable_idverplicht
max. lengte 64format
Een van:docx,csv,json,markdown
Antwoorden
| Status | Betekenis |
|---|---|
200 | The rendered deliverable. |
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. |
Formaat van het antwoord: application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/csv, text/markdown.
curl -s "https://api.prudai.com/v1/workflow-runs/<id>/deliverables/<deliverable_id>/download" \ -H "Authorization: Bearer $PRUDAI_TOKEN" \ -H "X-Product-Slug: leo"prudai leo workflow-runs-deliverables download"string"Answer a waiting human gate
POST /v1/workflow-runs/{id}/gate
Approve, request revision or abort the exact waiting node. Decisions use the existing decision-event record and run ownership checks. An abort is final: the response carries status aborted (the run ends with its partial result). Personal tokens and signed-in user tokens only; service keys are rejected. The same product, organisation, workflow capability and ownership rules as the app apply, including 403 workflows_upgrade_required for VERA without Pro.
- Stand: binnenkort, nog niet op productie.
- Scope:
prudai:workflow_runs:write - Goedkeuring:
none, geen extra stap. - 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,false
Body
JSON, verplicht.
nodeIdverplicht
max. lengte 128decisionverplicht
Een van:approve,revise,abortnote
max. lengte 4000
Antwoorden
| Status | Betekenis |
|---|---|
200 | 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/workflow-runs/<id>/gate" \ -H "Authorization: Bearer $PRUDAI_TOKEN" \ -H "X-Product-Slug: leo" \ -H "Content-Type: application/json" \ -d '{ "nodeId": "string", "decision": "approve", "note": "string" }'prudai leo workflow-runs gateList named tables produced by a workflow run
GET /v1/workflow-runs/{id}/tables
Personal tokens and signed-in user tokens only; service keys are rejected. The same product, organisation, workflow capability and ownership rules as the app apply, including 403 workflows_upgrade_required for VERA without Pro.
- Stand: binnenkort, nog niet op productie.
- Scope:
prudai:workflow_runs:read - Goedkeuring:
none, geen extra stap.
Parameters
X-Product-Slugverplicht
Product context, checked against the current user and the workflow capability. Een van:leo,leo-fiscaal,zia,vera,bever,irma,maiaidverplicht
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/workflow-runs/<id>/tables" \ -H "Authorization: Bearer $PRUDAI_TOKEN" \ -H "X-Product-Slug: leo"prudai leo workflow-runs tablesStart a workflow definition run
POST /v1/workflows/{id}/runs
Starting spends credits and requires confirm approval. next points to getWorkflowRun. Per-run costs are not yet listed in /v1/usage (planned); the run budget is shown on getWorkflowRun. Personal tokens and signed-in user tokens only; service keys are rejected. The same product, organisation, workflow capability and ownership rules as the app apply, including 403 workflows_upgrade_required for VERA without Pro.
- Stand: binnenkort, nog niet op productie.
- Scope:
prudai:workflow_runs: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/workflows/<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 workflows runsStart a curated workflow template run
POST /v1/workflows/templates/{id}/runs
Validates intake and selected sources through the same app service. Starting spends credits and requires confirm approval. next points to getWorkflowRun. Personal tokens and signed-in user tokens only; service keys are rejected. The same product, organisation, workflow capability and ownership rules as the app apply, including 403 workflows_upgrade_required for VERA without Pro.
- Stand: binnenkort, nog niet op productie.
- Scope:
prudai:workflow_runs: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,maiaidverplicht
max. lengte 120 · patroon^[a-z0-9]+(?:-[a-z0-9]+)*$dryRun
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.
artifact_ref
Exact immutable source version or expected current output version. Version zero denotes the historical empty baseline where supported.artifact_ref.artifact_idverplichtartifact_ref.versionverplicht
min. 0output_artifact_ref
Exact immutable source version or expected current output version. Version zero denotes the historical empty baseline where supported.output_artifact_ref.artifact_idverplichtoutput_artifact_ref.versionverplicht
min. 0intakeprojectIdenabledSourceIds
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/workflows/templates/<id>/runs" \ -H "Authorization: Bearer $PRUDAI_TOKEN" \ -H "X-Product-Slug: leo" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d '{ "artifact_ref": { "artifact_id": "00000000-0000-4000-8000-000000000000", "version": 1 }, "output_artifact_ref": { "artifact_id": "00000000-0000-4000-8000-000000000000", "version": 1 }, "intake": {}, "projectId": "00000000-0000-4000-8000-000000000000", "enabledSourceIds": [ "string" ] }'prudai leo workflows-templates runs