Sign in
workflows

Create a workflow

Create a workflow. Set type to automations, monitors, or evaluators to specify the workflow kind.

post/api/workflows/

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, OpenAI or Azure OpenAI provider credentials go in Settings -> Providers or the request body credential_override field, not in this auth field.

Request body

workflow_idstring

Optional workflow ID. Omit to let the server generate one.

namestring
descriptionstring nullable
type'automations' | 'monitors' | 'evaluators' required

Workflow type.

trigger_event_type'request_log' | 'trace_completed' | 'customer_budget_limit_reached' | 'credit_low_balance_threshold_reached' | 'on_eval_result_ingested' | 'custom_event' | 'eval_only'
is_starredboolean

Response

Workflow created successfully

idstring
workflow_idstring
versioninteger
namestring
descriptionstring nullable
type'automations' | 'monitors' | 'evaluators'
trigger_event_typestring nullable
tasksobject[]
is_enabledboolean
is_read_onlyboolean
created_atstring date-time
updated_atstring date-time

Changes