Skip to content

Prudai Developer API: workflow runs

The operations of this part (Workflow runs).

Base URL https://api.prudai.com/v1. Logging in is in Login, scopes in Scopes and permissions, errors in Errors. Overview.

MethodPathWhat it doesState
GET/v1/artifacts/{id}/runsList workflow runs that produced an artifactComing soon
GET/v1/workflow-runsList the caller’s workflow runsComing soon
GET/v1/workflow-runs/{id}Get workflow status, steps and eventsComing soon
POST/v1/workflow-runs/{id}/cancelStop a workflow runComing soon
POST/v1/workflow-runs/{id}/continueContinue a resumable workflow runComing soon
GET/v1/workflow-runs/{id}/deliverablesList workflow run deliverablesComing soon
GET/v1/workflow-runs/{id}/deliverables/{deliverable_id}/downloadDownload a workflow deliverableComing soon
POST/v1/workflow-runs/{id}/gateAnswer a waiting human gateComing soon
GET/v1/workflow-runs/{id}/tablesList named tables produced by a workflow runComing soon
POST/v1/workflows/{id}/runsStart a workflow definition runComing soon
POST/v1/workflows/templates/{id}/runsStart a curated workflow template runComing soon

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.

  • State: coming soon, not in production yet.
  • Scope: prudai:artifacts:read, prudai:workflows:read
  • Approval: none, no extra step.

Parameters

  • X-Product-Slug header · string required
    Product context, checked against the current user and the workflow capability. One of: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • id path · string (uuid) required
  • limit query · integer
    default: 20 · min 1 · max 100
  • cursor query · string
    max length 200

Responses

StatusMeaning
200Requested data with completeness and follow-up actions.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Workflow, run or deliverable not found or inaccessible.
409State conflict, stale If-Match, or cancellation unavailable for the current run state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Developer API or a required backing service is unavailable.
curl
curl -s "https://api.prudai.com/v1/artifacts/<id>/runs" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "X-Product-Slug: leo"
CLI (coming soon)
prudai leo artifacts runs
Response 200
[
{
"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.

  • State: coming soon, not in production yet.
  • Scope: prudai:workflow_runs:read
  • Approval: none, no extra step.

Parameters

  • X-Product-Slug header · string required
    Product context, checked against the current user and the workflow capability. One of: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • projectId query · string (uuid)
  • status query · string
    max length 80
  • limit query · integer
    default: 20 · min 1 · max 100
  • cursor query · string
    max length 200

Responses

StatusMeaning
200Requested data with completeness and follow-up actions.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Workflow, run or deliverable not found or inaccessible.
409State conflict, stale If-Match, or cancellation unavailable for the current run state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Developer API or a required backing service is unavailable.
curl
curl -s "https://api.prudai.com/v1/workflow-runs" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "X-Product-Slug: leo"
CLI (coming soon)
prudai leo workflow-runs list

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

  • State: coming soon, not in production yet.
  • Scope: prudai:workflow_runs:read
  • Approval: none, no extra step.

Parameters

  • X-Product-Slug header · string required
    Product context, checked against the current user and the workflow capability. One of: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • id path · string (uuid) required

Responses

StatusMeaning
200Requested data with completeness and follow-up actions.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Workflow, run or deliverable not found or inaccessible.
409State conflict, stale If-Match, or cancellation unavailable for the current run state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Developer API or a required backing service is unavailable.

Fields in data (200)

  • artifact_ref WorkflowArtifactRef
    Exact immutable source version or expected current output version. Version zero denotes the historical empty baseline where supported.
  • artifact_ref.artifact_id string (uuid)
  • artifact_ref.version integer
    min 0
  • previousAttempt object
  • previousAttempt.status string
  • previousAttempt.finishedAt string
    may be null
  • previousAttempt.archivedAt string
  • previousAttempt.result string
  • previousAttempt.error string
    may be null
  • previousAttempt.deliverableCount number
  • jobId string
  • status string
  • topic string
  • createdAt string
  • projectId string
  • projectDocumentIds array<string>
  • documentMode string
    One of: auto, selection, none
  • effectiveProjectDocumentIds array<string>
  • projectName string
  • logs array<object>
  • logs[].agent string
  • logs[].message string
  • logs[].timestamp string
  • result any
  • error string
    may be null
  • warnings string
    may be null
  • uiUrl string
  • meta object
  • documentScope object
  • queue object
  • queue.state string
  • queue.position number
    may be null
  • queue.etaSeconds number
    may be null
  • queue.reason string
    may be null
  • queue.checkedAt string
    may be null
  • budgetUsage object
  • progress object
  • budget object
  • budget.limits object
  • budget.limits.maxEstimatedTokens number

This list stops after 40 fields.

curl
curl -s "https://api.prudai.com/v1/workflow-runs/<id>" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "X-Product-Slug: leo"
CLI (coming soon)
prudai leo workflow-runs get

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

  • State: coming soon, not in production yet.
  • Scope: prudai:workflow_runs:write
  • Approval: none, no extra step.
  • Dry run: ?dryRun=true shows what would happen and stores nothing.

Parameters

  • X-Product-Slug header · string required
    Product context, checked against the current user and the workflow capability. One of: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • id path · string (uuid) required
  • dryRun query · string
    Validate and preview without changing definitions, enqueuing jobs or recording gate decisions. One of: true, false

Body

JSON, required.

Responses

StatusMeaning
200Completed. With dryRun=true, returns a preview without side effects.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Workflow, run or deliverable not found or inaccessible.
409State conflict, stale If-Match, or cancellation unavailable for the current run state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Developer API or a required backing service is unavailable.
curl
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 '{}'
CLI (coming soon)
prudai leo workflow-runs cancel

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

  • State: coming soon, not in production yet.
  • Scope: prudai:workflow_runs:write
  • Approval: none, no extra step.
  • Dry run: ?dryRun=true shows what would happen and stores nothing.

Parameters

  • X-Product-Slug header · string required
    Product context, checked against the current user and the workflow capability. One of: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • id path · string (uuid) required
  • dryRun query · string
    Validate and preview without changing definitions, enqueuing jobs or recording gate decisions. One of: true, false

Body

JSON, required.

Responses

StatusMeaning
200Completed. With dryRun=true, returns a preview without side effects.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Workflow, run or deliverable not found or inaccessible.
409State conflict, stale If-Match, or cancellation unavailable for the current run state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Developer API or a required backing service is unavailable.
curl
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 '{}'
CLI (coming soon)
prudai leo workflow-runs continue

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

  • State: coming soon, not in production yet.
  • Scope: prudai:workflow_runs:read
  • Approval: none, no extra step.

Parameters

  • X-Product-Slug header · string required
    Product context, checked against the current user and the workflow capability. One of: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • id path · string (uuid) required

Responses

StatusMeaning
200Requested data with completeness and follow-up actions.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Workflow, run or deliverable not found or inaccessible.
409State conflict, stale If-Match, or cancellation unavailable for the current run state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Developer API or a required backing service is unavailable.
curl
curl -s "https://api.prudai.com/v1/workflow-runs/<id>/deliverables" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "X-Product-Slug: leo"
CLI (coming soon)
prudai leo workflow-runs-deliverables list

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

  • State: coming soon, not in production yet.
  • Scope: prudai:workflow_runs:read
  • Approval: none, no extra step.

Parameters

  • X-Product-Slug header · string required
    Product context, checked against the current user and the workflow capability. One of: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • id path · string (uuid) required
  • deliverable_id path · string required
    max length 64
  • format query · string
    One of: docx, csv, json, markdown

Responses

StatusMeaning
200The rendered deliverable.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Workflow, run or deliverable not found or inaccessible.
409State conflict, stale If-Match, or cancellation unavailable for the current run state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Developer API or a required backing service is unavailable.

Response format: application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/csv, text/markdown.

curl
curl -s "https://api.prudai.com/v1/workflow-runs/<id>/deliverables/<deliverable_id>/download" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "X-Product-Slug: leo"
CLI (coming soon)
prudai leo workflow-runs-deliverables download
Response 200
"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.

  • State: coming soon, not in production yet.
  • Scope: prudai:workflow_runs:write
  • Approval: none, no extra step.
  • Dry run: ?dryRun=true shows what would happen and stores nothing.

Parameters

  • X-Product-Slug header · string required
    Product context, checked against the current user and the workflow capability. One of: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • id path · string (uuid) required
  • dryRun query · string
    Validate and preview without changing definitions, enqueuing jobs or recording gate decisions. One of: true, false

Body

JSON, required.

  • nodeId string required
    max length 128
  • decision string required
    One of: approve, revise, abort
  • note string
    max length 4000

Responses

StatusMeaning
200Completed. With dryRun=true, returns a preview without side effects.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Workflow, run or deliverable not found or inaccessible.
409State conflict, stale If-Match, or cancellation unavailable for the current run state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Developer API or a required backing service is unavailable.
curl
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"
}'
CLI (coming soon)
prudai leo workflow-runs gate

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

  • State: coming soon, not in production yet.
  • Scope: prudai:workflow_runs:read
  • Approval: none, no extra step.

Parameters

  • X-Product-Slug header · string required
    Product context, checked against the current user and the workflow capability. One of: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • id path · string (uuid) required

Responses

StatusMeaning
200Requested data with completeness and follow-up actions.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Workflow, run or deliverable not found or inaccessible.
409State conflict, stale If-Match, or cancellation unavailable for the current run state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Developer API or a required backing service is unavailable.
curl
curl -s "https://api.prudai.com/v1/workflow-runs/<id>/tables" \
-H "Authorization: Bearer $PRUDAI_TOKEN" \
-H "X-Product-Slug: leo"
CLI (coming soon)
prudai leo workflow-runs tables

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

  • State: coming soon, not in production yet.
  • Scope: prudai:workflow_runs:write
  • Approval: confirm, the user confirms exactly this call.
  • Dry run: ?dryRun=true shows 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-Slug header · string required
    Product context, checked against the current user and the workflow capability. One of: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • id path · string (uuid) required
  • dryRun query · string
    Validate and preview without changing definitions, enqueuing jobs or recording gate decisions. One of: true, false
  • 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. pattern ^apr_[A-Za-z0-9]{24}$
  • Idempotency-Key header · string required
    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.

  • input object required
  • input.query string required
    max length 100000
  • input.projectId string (uuid)
  • input.documentIds array<string (uuid)>
  • input.artifact_ref WorkflowArtifactRef
    Exact immutable source version or expected current output version. Version zero denotes the historical empty baseline where supported.
  • input.artifact_ref.artifact_id string (uuid) required
  • input.artifact_ref.version integer required
    min 0
  • input.output_artifact_ref WorkflowArtifactRef
    Exact immutable source version or expected current output version. Version zero denotes the historical empty baseline where supported.
  • input.output_artifact_ref.artifact_id string (uuid) required
  • input.output_artifact_ref.version integer required
    min 0

Responses

StatusMeaning
200Idempotent replay or dry-run preview.
201Completed. With dryRun=true, returns a preview without side effects.
202Waiting for human approval. Replay the exact request with its one-use approval grant.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Workflow, run or deliverable not found or inaccessible.
409State conflict, stale If-Match, or cancellation unavailable for the current run state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Developer API or a required backing service is unavailable.
curl
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
}
}
}'
CLI (coming soon)
prudai leo workflows runs

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

  • State: coming soon, not in production yet.
  • Scope: prudai:workflow_runs:write
  • Approval: confirm, the user confirms exactly this call.
  • Dry run: ?dryRun=true shows 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-Slug header · string required
    Product context, checked against the current user and the workflow capability. One of: leo, leo-fiscaal, zia, vera, bever, irma, maia
  • id path · string required
    max length 120 · pattern ^[a-z0-9]+(?:-[a-z0-9]+)*$
  • dryRun query · string
    Validate and preview without changing definitions, enqueuing jobs or recording gate decisions. One of: true, false
  • 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. pattern ^apr_[A-Za-z0-9]{24}$
  • Idempotency-Key header · string required
    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.

  • artifact_ref WorkflowArtifactRef
    Exact immutable source version or expected current output version. Version zero denotes the historical empty baseline where supported.
  • artifact_ref.artifact_id string (uuid) required
  • artifact_ref.version integer required
    min 0
  • output_artifact_ref WorkflowArtifactRef
    Exact immutable source version or expected current output version. Version zero denotes the historical empty baseline where supported.
  • output_artifact_ref.artifact_id string (uuid) required
  • output_artifact_ref.version integer required
    min 0
  • intake object
  • projectId string (uuid)
  • enabledSourceIds array<string>

Responses

StatusMeaning
200Idempotent replay or dry-run preview.
201Completed. With dryRun=true, returns a preview without side effects.
202Waiting for human approval. Replay the exact request with its one-use approval grant.
400Malformed request or unsupported parameter (for example client-sent tools).
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).
404Workflow, run or deliverable not found or inaccessible.
409State conflict, stale If-Match, or cancellation unavailable for the current run state.
422Well-formed request with invalid values (for example an unknown reasoning_effort, empty messages, or an Idempotency-Key reused with a different body).
429Rate limit, concurrency limit, Ultra daily quota or fair-use limit of the free sources operations exceeded.
503Developer API or a required backing service is unavailable.
curl
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"
]
}'
CLI (coming soon)
prudai leo workflows-templates runs