API ReferenceWorkflows

Create a workflow draft

Create a new editable draft from the submitted workflow content. The server assigns the next version and the family identity. This does not clone, commit, deploy, or modify any existing version.

Authentication

AuthorizationBearer

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.

OR
AuthorizationBearer

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

Path parameters

workflow_idstringRequired

Logical workflow-family ID.

Request

This endpoint expects an object.
namestring or nullOptional
descriptionstring or nullOptional
typeenumOptionalDefaults to automations

Workflow category. Defaults to automations.

trigger_event_typeenum or nullOptional

Event that triggers the workflow. Use scheduled with schedule_cron.

schedule_cronstring or nullOptional

UTC five-field cron expression. Required when trigger_event_type is scheduled, forbidden for other trigger types, and limited to a minimum five-minute cadence. Timezone prefixes such as TZ and CRON_TZ are not supported.

is_starredbooleanOptional
taskslist of objectsOptional

Response

Editable draft created.
idstringRead-only
workflow_idstringRead-only
versionintegerRead-only
typeenumDefaults to automations

Workflow category. Defaults to automations.

is_enabledbooleanRead-only
is_read_onlybooleanRead-only
taskslist of objects
namestring or nullOptional
descriptionstring or nullOptional
version_descriptionstringOptionalRead-only
Commit message for this version. Set only through the commit endpoint.
trigger_event_typeenum or nullOptional

Event that triggers the workflow. Use scheduled with schedule_cron.

schedule_cronstring or nullOptional

UTC five-field cron expression. Required when trigger_event_type is scheduled, forbidden for other trigger types, and limited to a minimum five-minute cadence. Timezone prefixes such as TZ and CRON_TZ are not supported.

is_starredbooleanOptionalDefaults to false
is_publicbooleanOptionalRead-only
unique_organization_idstring or nullOptionalRead-only
has_async_stepsbooleanOptionalRead-only
created_atdatetimeOptionalRead-only
updated_atdatetimeOptionalRead-only
deployed_versioninteger or nullOptionalRead-only
tagslist of objectsOptionalRead-only
graphobject or nullOptionalRead-only

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error