v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB

workflows

Deploy Workflow

Deploy a committed workflow version. Sets is_enabled=True on the target version and False on all others in the family.

post/api/workflows/{workflow_id}/deployments/

Path parameters

workflow_idstring required

Headers

Authorizationstring required

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

Request body

versioninteger

Version number to deploy. If omitted, deploys the latest committed version.

Response

idstring required

workflow_idstring required

Logical workflow family key shared across versions

versioninteger required

is_enabledboolean required

Only committed (is_read_only=True) versions may be enabled. At most one version per workflow family should be enabled at a time.

is_read_onlyboolean required

True for committed versions; only the latest version is editable