Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.43.0.
Start a run of a served workflow
const url = 'https://example.com/v1/runs';const options = { method: 'POST', headers: { 'Idempotency-Key': 'example', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"input":"example","workflow":"example","workflowRevision":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/v1/runs \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: example' \ --data '{ "input": "example", "workflow": "example", "workflowRevision": "example" }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Header Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”object
Example generated
{ "input": "example", "workflow": "example", "workflowRevision": "example"}Responses
Section titled “Responses”Authorized result
object
An authorized cancellation took a parked wait’s authored onCancel path; cleanup on that path remains runnable.
Ordinary cancellation is irreversible and prevents later workflow effects; an uncertain evaluation may still have run at its provider.
Example
{ "state": "running"}A problem: idempotency.key-invalid, input.invalid, request.invalid.
object
Example
{ "code": "idempotency.key-invalid", "type": "https://id.registrystack.org/problems/registry-coordinator/admission/held"}A problem: authentication.refused.
object
Example
{ "code": "authentication.refused", "type": "https://id.registrystack.org/problems/registry-coordinator/admission/held"}Headers
Section titled “Headers”Bearer authentication challenge for missing or refused credentials.
A problem: operation.not-authorized.
object
Example
{ "code": "operation.not-authorized", "type": "https://id.registrystack.org/problems/registry-coordinator/admission/held"}A problem: workflow.not-served.
object
Example
{ "code": "workflow.not-served", "type": "https://id.registrystack.org/problems/registry-coordinator/admission/held"}A problem: request.method-not-allowed.
object
Example
{ "code": "request.method-not-allowed", "type": "https://id.registrystack.org/problems/registry-coordinator/admission/held"}A problem: admission.held, admission.recovery-only, binding.conflict, binding.live-conflict, definition.refused, deployment.activation-changed, deployment.refused, execution.held, idempotency.key-reused, workflow.revision-mismatch.
object
Example
{ "code": "admission.held", "type": "https://id.registrystack.org/problems/registry-coordinator/admission/held"}A problem: request.body-too-large.
object
Example
{ "code": "request.body-too-large", "type": "https://id.registrystack.org/problems/registry-coordinator/admission/held"}A problem: request.unsupported-media-type.
object
Example
{ "code": "request.unsupported-media-type", "type": "https://id.registrystack.org/problems/registry-coordinator/admission/held"}A problem: runtime.failure.
object
Example
{ "code": "runtime.failure", "type": "https://id.registrystack.org/problems/registry-coordinator/admission/held"}A problem: audit.response-unavailable, service.unavailable.
object
Example
{ "code": "audit.response-unavailable", "type": "https://id.registrystack.org/problems/registry-coordinator/admission/held"}Headers
Section titled “Headers”Whole seconds to wait before trying again.