Get latest workflow draft

GET

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

GET

/api/workflows/:workflow_id/

$ curl https://api.respan.ai/api/workflows/workflow_id/ \
>      -H "Authorization: Bearer <respanApiKey>" \
>      -H "Content-Type: application/json"

1 {
2   "id": "a3f47c2e-9b1d-4f3a-8c2e-5d7b9f1a2c3d",
3   "workflow_id": "wf_20240615_001",
4   "version": 3,
5   "name": "Customer Support Automation",
6   "description": "Automates ticket routing and response suggestions for customer support.",
7   "type": "automations",
8   "trigger_event_type": "ticket_created",
9   "tasks": [
10     {
11       "task_id": "task_001",
12       "name": "Classify Ticket",
13       "type": "classification",
14       "parameters": {
15         "model": "text-classifier-v2",
16         "threshold": 0.85
17       }
18     }
19   ],
20   "graph": {
21     "nodes": [
22       {
23         "id": "node_1",
24         "task_id": "task_001"
25       }
26     ],
27     "edges": []
28   },
29   "workflow_activities": [
30     {
31       "timestamp": "2024-06-10T14:22:00Z",
32       "feature_type": "task_execution",
33       "object_id": "task_001",
34       "activity_type": "completed",
35       "message": "Task 'Classify Ticket' executed successfully."
36     }
37   ],
38   "is_enabled": true,
39   "is_starred": false,
40   "is_read_only": false,
41   "has_async_steps": true,
42   "created_at": "2024-05-01T08:00:00Z",
43   "updated_at": "2024-06-14T16:45:00Z",
44   "deployed_version": 2
45 }

Get the latest editable (draft) version of a workflow.

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

Path parameters

workflow_idstringRequired

Workflow ID.

Response

Successful response for Get workflow

idstring

workflow_idstring

versioninteger

namestring

descriptionstring or null

typeenum

trigger_event_typestring or null

taskslist of maps from strings to any

graphmap from strings to any or null

workflow_activitieslist of objects

is_enabledboolean

is_starredboolean

is_read_onlyboolean

has_async_stepsboolean

created_atdatetime

updated_atdatetime

deployed_versioninteger or null

Errors

401

Unauthorized Error

404

Not Found Error