Api Workflows Commits Create

POST

https://api.respan.ai/api/workflows/:workflow_id/commits/

POST

/api/workflows/:workflow_id/commits/

$ curl -X POST https://api.respan.ai/api/workflows/workflow_id/commits/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "is_enabled": true,
3   "is_public": true,
4   "unique_organization_id": "string",
5   "tasks": [
6     {
7       "id": "string",
8       "type": "sampling",
9       "config": {
10         "rate": 1
11       },
12       "label": "string"
13     }
14   ],
15   "graph": {
16     "node_count": 1,
17     "edge_count": 1,
18     "entry_nodes": [
19       "string"
20     ],
21     "terminal_nodes": [
22       "string"
23     ],
24     "nodes": {}
25   },
26   "created_at": "2024-01-15T09:30:00Z",
27   "updated_at": "2024-01-15T09:30:00Z",
28   "deployed_version": 1,
29   "tags": [
30     {
31       "id": "string",
32       "name": "string",
33       "color": "string",
34       "created_at": "2024-01-15T09:30:00Z",
35       "updated_at": "2024-01-15T09:30:00Z"
36     }
37   ],
38   "id": "string",
39   "workflow_id": "string",
40   "version": 1,
41   "name": "string",
42   "description": "string",
43   "type": "automations",
44   "trigger_event_type": "request_log",
45   "schedule_cron": "string",
46   "is_starred": true,
47   "is_read_only": true,
48   "has_async_steps": true
49 }

Commit the current draft (flip is_read_only True in place).

Authentication

AuthorizationBearer

JWT access token or Respan API key

Path parameters

workflow_idstringRequired

Request

This endpoint expects an object.

descriptionstringOptional<=1000 characters

Commit message stamped on the newly committed version.

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

Errors

409

Conflict Error