API ReferenceWorkflows

Api Workflows Versions List Create

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.

Authentication

AuthorizationBearer
JWT access token or Respan API key

Path parameters

workflow_idstringRequired

Request

This endpoint expects an object.
idstringOptional1-255 characters
taskslist of objectsOptional
workflow_idstringOptional1-255 characters
Logical workflow family key shared across versions
versionintegerOptional0-2147483647Defaults to 1
namestring or nullOptional<=255 characters
descriptionstring or nullOptional
typeenumOptional

Kind of workflow: automation, monitor, or evaluator

  • automations - Automation
  • monitors - Monitor
  • evaluators - Evaluator
  • reports - Report
  • exports - Export
  • ingests - Ingest
trigger_event_typeenum or anyOptional

Event type that triggers this workflow when used as an event responder

  • request_log - LOG_INGESTED
  • trace_completed - TRACE_COMPLETED
  • customer_budget_limit_reached - BUDGET_EXCEEDED
  • credit_low_balance_threshold_reached - CREDIT_LOW
  • spend_cap_warning_threshold_reached - SPEND_CAP_WARNING
  • limit_policy_soft_triggered - LIMIT_POLICY_SOFT_TRIGGERED
  • limit_policy_hard_triggered - LIMIT_POLICY_HARD_TRIGGERED
  • on_eval_result_ingested - EVAL_COMPLETED
  • custom_event - CUSTOM_EVENT
  • eval_only - EVAL_ONLY
  • scheduled - SCHEDULED
schedule_cronstring or nullOptional<=500 characters

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

has_async_stepsbooleanOptional
is_starredbooleanOptional
resource_idslist of stringsOptional

All resource IDs referenced in workflow (for reverse lookup)

Response

is_enabledbooleanRead-only
is_publicbooleanRead-only
unique_organization_idstring<=255 characters
taskslist of objectsRead-only
graphobject or nullRead-only
created_atdatetimeRead-only
updated_atdatetimeRead-only
deployed_versioninteger or nullRead-only
tagslist of objectsRead-only
idstring<=255 characters
workflow_idstring<=255 characters
Logical workflow family key shared across versions
versioninteger0-2147483647Defaults to 1
namestring or null<=255 characters
descriptionstring or null
typeenum

Kind of workflow: automation, monitor, or evaluator

  • automations - Automation
  • monitors - Monitor
  • evaluators - Evaluator
  • reports - Report
  • exports - Export
  • ingests - Ingest
trigger_event_typeenum or any

Event type that triggers this workflow when used as an event responder

  • request_log - LOG_INGESTED
  • trace_completed - TRACE_COMPLETED
  • customer_budget_limit_reached - BUDGET_EXCEEDED
  • credit_low_balance_threshold_reached - CREDIT_LOW
  • spend_cap_warning_threshold_reached - SPEND_CAP_WARNING
  • limit_policy_soft_triggered - LIMIT_POLICY_SOFT_TRIGGERED
  • limit_policy_hard_triggered - LIMIT_POLICY_HARD_TRIGGERED
  • on_eval_result_ingested - EVAL_COMPLETED
  • custom_event - CUSTOM_EVENT
  • eval_only - EVAL_ONLY
  • scheduled - SCHEDULED
schedule_cronstring or null<=500 characters

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

is_starredboolean
is_read_onlyboolean

True for committed versions; only the latest version is editable

has_async_stepsboolean