Sign in

v3

latestOpenAPI 3.1.02026-07-311,4541,5202.3 MB
workflows

Create Workflow Version

Create a new draft row from the client payload.

Pure CRUD: inserts one new row with is_read_only=False using the content the client sends (name, tasks, description, type, trigger_event_type, is_starred). Does NOT clone from other rows and does NOT touch other rows.

The FE owns the "draft dance" — when the user wants to edit a committed workflow, the FE reads the current state locally and sends it here as the new draft's content.

The view forces identity/scope fields (workflow_id from the URL, organization from the caller) so the client can't reparent a row into another family or org.

post/api/workflows/{workflow_id}/versions/

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

idstring
tasksWorkflowCreateRequestTasksItems[]
workflow_idstring

Logical workflow family key shared across versions

versioninteger
namestring nullable
descriptionstring nullable
type'automations' | 'monitors' | 'evaluators' | 'reports' | 'exports' | 'ingests'
  • automations - Automation
  • monitors - Monitor
  • evaluators - Evaluator
  • reports - Report
  • exports - Export
  • ingests - Ingest
schedule_cronstring nullable

UTC cron schedule (5-field). Populated when trigger_event_type='scheduled'.

has_async_stepsboolean
is_starredboolean
resource_idsstring[]

All resource IDs referenced in workflow (for reverse lookup)

Response

idstring
workflow_idstring

Logical workflow family key shared across versions

versioninteger
namestring nullable
descriptionstring nullable
type'automations' | 'monitors' | 'evaluators' | 'reports' | 'exports' | 'ingests'
  • automations - Automation
  • monitors - Monitor
  • evaluators - Evaluator
  • reports - Report
  • exports - Export
  • ingests - Ingest
schedule_cronstring nullable

UTC cron schedule (5-field). Populated when trigger_event_type='scheduled'.

is_enabledboolean required
is_starredboolean
is_read_onlyboolean

True for committed versions; only the latest version is editable

is_publicboolean required
unique_organization_idstring required
tasksWorkflowDetailTasksItems[] required
has_async_stepsboolean
created_atstring date-time required
updated_atstring date-time required
deployed_versioninteger nullable required