Create Tool

1 from vapi import CreateApiRequestToolDto, Vapi 2 3 client = Vapi( 4 token="YOUR_TOKEN", 5 ) 6 client.tools.create( 7 request=CreateApiRequestToolDto( 8 method="POST", 9 url="url", 10 ), 11 )

1 { 2 "messages": [ 3 { 4 "contents": [ 5 { 6 "type": "text", 7 "text": "string", 8 "language": "aa" 9 } 10 ], 11 "type": "request-start", 12 "blocking": false, 13 "content": "string", 14 "conditions": [ 15 { 16 "operator": "eq", 17 "param": "string", 18 "value": "string" 19 } 20 ] 21 } 22 ], 23 "type": "apiRequest", 24 "method": "POST", 25 "timeoutSeconds": 20, 26 "credentialId": "550e8400-e29b-41d4-a716-446655440000", 27 "id": "string", 28 "orgId": "string", 29 "createdAt": "2024-01-15T09:30:00Z", 30 "updatedAt": "2024-01-15T09:30:00Z", 31 "rejectionPlan": { 32 "conditions": [ 33 { 34 "type": "regex", 35 "regex": "\\\\b(cancel|stop|wait)\\\\b - Matches whole words", 36 "target": { 37 "role": "user", 38 "position": -1 39 }, 40 "negate": "true - Reject if user hasn\"t said goodbye: { regex: \"\\\\b(bye|goodbye)\\\\b\", negate: true }" 41 } 42 ] 43 }, 44 "name": "string", 45 "description": "string", 46 "url": "string", 47 "body": { 48 "type": "string", 49 "items": {}, 50 "properties": {}, 51 "description": "string", 52 "pattern": "string", 53 "format": "date-time", 54 "required": [ 55 "string" 56 ], 57 "enum": [ 58 "string" 59 ], 60 "title": "string" 61 }, 62 "headers": { 63 "type": "string", 64 "items": {}, 65 "properties": {}, 66 "description": "string", 67 "pattern": "string", 68 "format": "date-time", 69 "required": [ 70 "string" 71 ], 72 "enum": [ 73 "string" 74 ], 75 "title": "string" 76 }, 77 "backoffPlan": { 78 "type": "fixed", 79 "maxRetries": 0, 80 "baseDelaySeconds": 1, 81 "excludedStatusCodes": [ 82 400, 83 401, 84 403, 85 404 86 ] 87 }, 88 "variableExtractionPlan": { 89 "schema": { 90 "type": "string", 91 "items": {}, 92 "properties": {}, 93 "description": "string", 94 "pattern": "string", 95 "format": "date-time", 96 "required": [ 97 "string" 98 ], 99 "enum": [ 100 "string" 101 ], 102 "title": "string" 103 }, 104 "aliases": [ 105 { 106 "key": "string", 107 "value": "string" 108 } 109 ] 110 } 111 }

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Request

This endpoint expects an object.

ApiRequestToolobjectRequired

DtmfToolobjectRequired

EndCallToolobjectRequired

FunctionToolobjectRequired

TransferCallToolobjectRequired

HandoffToolobjectRequired

BashToolobjectRequired

ComputerToolobjectRequired

TextEditorToolobjectRequired

QueryToolobjectRequired

GoogleCalendarCreateEventToolobjectRequired

GoogleSheetsRowAppendToolobjectRequired

GoogleCalendarCheckAvailabilityToolobjectRequired

SlackSendMessageToolobjectRequired

SmsSendToolobjectRequired

McpToolobjectRequired

GoHighLevelCalendarAvailabilityToolobjectRequired

GoHighLevelCalendarEventCreateToolobjectRequired

GoHighLevelContactCreateToolobjectRequired

GoHighLevelContactGetToolobjectRequired

Response

ApiRequestToolobject

DtmfToolobject

EndCallToolobject

FunctionToolobject

GhlToolobject

TransferCallToolobject

HandoffToolobject

BashToolobject

ComputerToolobject

TextEditorToolobject

QueryToolobject

GoogleCalendarCreateEventToolobject

GoogleSheetsRowAppendToolobject

GoogleCalendarCheckAvailabilityToolobject

SlackSendMessageToolobject

SmsSendToolobject

McpToolobject

GoHighLevelCalendarAvailabilityToolobject

GoHighLevelCalendarEventCreateToolobject

GoHighLevelContactCreateToolobject

GoHighLevelContactGetToolobject