Get Workflow

GET

https://api.vapi.ai/workflow/:id

GET

/workflow/:id

1 curl https://api.vapi.ai/workflow/id \
2      -H "Authorization: Bearer <token>"

Try it

200Retrieved

1 {
2   "nodes": [
3     {
4       "type": "say",
5       "name": "name",
6       "exact": "exact",
7       "metadata": {
8         "key": "value"
9       },
10       "prompt": "prompt"
11     }
12   ],
13   "id": "id",
14   "orgId": "orgId",
15   "createdAt": "2024-01-15T09:30:00Z",
16   "updatedAt": "2024-01-15T09:30:00Z",
17   "name": "name",
18   "edges": [
19     {
20       "from": "from",
21       "to": "to",
22       "condition": {
23         "type": "ai",
24         "prompt": "prompt"
25       },
26       "metadata": {
27         "key": "value"
28       }
29     }
30   ],
31   "model": {
32     "provider": "anthropic",
33     "model": "claude-3-opus-20240229",
34     "emotionRecognitionEnabled": true,
35     "knowledgeBase": {
36       "server": {
37         "url": "url",
38         "timeoutSeconds": 20,
39         "backoffPlan": {
40           "maxRetries": 0,
41           "type": {
42             "key": "value"
43           },
44           "baseDelaySeconds": 1
45         }
46       }
47     },
48     "knowledgeBaseId": "knowledgeBaseId",
49     "maxTokens": 1.1,
50     "messages": [
51       {
52         "role": "assistant"
53       }
54     ],
55     "numFastTurns": 1.1,
56     "temperature": 1.1,
57     "thinking": {
58       "type": "enabled",
59       "budgetTokens": 1.1
60     },
61     "toolIds": [
62       "toolIds"
63     ],
64     "tools": [
65       {
66         "type": "dtmf",
67         "async": false
68       }
69     ]
70   }
71 }

Path parameters

idstringRequired

Response

nodeslist of objects

idstring

orgIdstring

createdAtdatetime

updatedAtdatetime

namestring<=80 characters

edgeslist of objects

modelobjectOptional

These are the options for the workflow’s LLM.

Path parameters

Headers

Response