Create Block

POST

Headers

Auth

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

Conversation

Tool Call

Workflow

Response

Conversation

Tool Call

Workflow

POST

1 curl -X POST https://api.vapi.ai/block \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "type": "workflow"
6 }'

200Successful

1 {
2   "type": "workflow",
3   "createdAt": "2024-01-15T09:30:00Z",
4   "id": "string",
5   "orgId": "string",
6   "updatedAt": "2024-01-15T09:30:00Z",
7   "inputSchema": {
8     "type": "string",
9     "items": {
10       "key": "value"
11     },
12     "properties": {
13       "key": "value"
14     },
15     "description": "description",
16     "required": [
17       "required"
18     ]
19   },
20   "messages": [
21     {
22       "type": "block-complete",
23       "conditions": [
24         {
25           "type": "rule-based",
26           "leftSide": "string",
27           "operator": "eq",
28           "rightSide": "string"
29         }
30       ],
31       "content": "string",
32       "contents": [
33         {
34           "type": "text",
35           "text": "text",
36           "language": "aa"
37         }
38       ]
39     }
40   ],
41   "name": "string",
42   "outputSchema": {
43     "type": "string",
44     "items": {
45       "key": "value"
46     },
47     "properties": {
48       "key": "value"
49     },
50     "description": "description",
51     "required": [
52       "required"
53     ]
54   },
55   "steps": [
56     {
57       "type": "callback",
58       "name": "string",
59       "block": {
60         "type": "workflow"
61       },
62       "blockId": "string",
63       "input": {
64         "key": "value"
65       },
66       "mutations": [
67         {
68           "type": "assignment",
69           "variable": "variable",
70           "value": "value"
71         }
72       ]
73     }
74   ]
75 }

Get Block

Up Next

Built with

1	curl -X POST https://api.vapi.ai/block \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"type": "workflow"
6	}'

1	{
2	"type": "workflow",
3	"createdAt": "2024-01-15T09:30:00Z",
4	"id": "string",
5	"orgId": "string",
6	"updatedAt": "2024-01-15T09:30:00Z",
7	"inputSchema": {
8	"type": "string",
9	"items": {
10	"key": "value"
11	},
12	"properties": {
13	"key": "value"
14	},
15	"description": "description",
16	"required": [
17	"required"
18	]
19	},
20	"messages": [
21	{
22	"type": "block-complete",
23	"conditions": [
24	{
25	"type": "rule-based",
26	"leftSide": "string",
27	"operator": "eq",
28	"rightSide": "string"
29	}
30	],
31	"content": "string",
32	"contents": [
33	{
34	"type": "text",
35	"text": "text",
36	"language": "aa"
37	}
38	]
39	}
40	],
41	"name": "string",
42	"outputSchema": {
43	"type": "string",
44	"items": {
45	"key": "value"
46	},
47	"properties": {
48	"key": "value"
49	},
50	"description": "description",
51	"required": [
52	"required"
53	]
54	},
55	"steps": [
56	{
57	"type": "callback",
58	"name": "string",
59	"block": {
60	"type": "workflow"
61	},
62	"blockId": "string",
63	"input": {
64	"key": "value"
65	},
66	"mutations": [
67	{
68	"type": "assignment",
69	"variable": "variable",
70	"value": "value"
71	}
72	]
73	}
74	]
75	}