Sign in

4e064cf81dae

latestOpenAPI 3.1.02026-08-131831,331960.0 KB
workflows

Update a workflow

Update a workflow family. name, description, and is_starred are family metadata and propagate to every version. Structural fields edit the current draft; committed-only families must create a new draft first.

patch/api/workflows/{workflow_id}/

Path parameters

workflow_idstring required

Logical workflow-family ID.

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

namestring nullable
descriptionstring nullable
type'automations' | 'monitors' | 'evaluators' | 'reports' | 'exports' | 'ingests'

Workflow category. Defaults to automations.

trigger_event_type'request_log' | 'trace_completed' | 'customer_budget_limit_reached' | 'credit_low_balance_threshold_reached' | 'spend_cap_warning_threshold_reached' | 'limit_policy_soft_triggered' | 'limit_policy_hard_triggered' | 'on_eval_result_ingested' | 'custom_event' | 'eval_only' | 'scheduled'

Event that triggers the workflow. Use scheduled with schedule_cron.

schedule_cronstring nullable

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_starredboolean

Response

Workflow updated.

idstring required
workflow_idstring required
versioninteger required
namestring nullable
descriptionstring nullable
version_descriptionstring

Commit message for this version. Set only through the commit endpoint.

type'automations' | 'monitors' | 'evaluators' | 'reports' | 'exports' | 'ingests' required

Workflow category. Defaults to automations.

trigger_event_type'request_log' | 'trace_completed' | 'customer_budget_limit_reached' | 'credit_low_balance_threshold_reached' | 'spend_cap_warning_threshold_reached' | 'limit_policy_soft_triggered' | 'limit_policy_hard_triggered' | 'on_eval_result_ingested' | 'custom_event' | 'eval_only' | 'scheduled'

Event that triggers the workflow. Use scheduled with schedule_cron.

schedule_cronstring nullable

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_enabledboolean required
is_starredboolean
is_read_onlyboolean required
is_publicboolean
unique_organization_idstring nullable
has_async_stepsboolean
created_atstring date-time
updated_atstring date-time
deployed_versioninteger nullable
has_write_accessboolean

Whether the authenticated caller may edit this workflow family.