[BETA] Get Workflows

GET

https://api.vapi.ai/workflow

GET

/workflow

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

Try it

200Retrieved

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

Response

nodeslist of objects

idstring

orgIdstring

createdAtdatetime

updatedAtdatetime

namestring<=80 characters

edgeslist of objects

modelobjectOptional

These are the options for the workflow’s LLM.

Headers

Response