Update tool

PATCH

https://app.lumenia.net/api/v1/tools/:toolId

PATCH

/api/v1/tools/:toolId

$ curl -X PATCH https://app.lumenia.net/api/v1/tools/toolId \
>      -H "Authorization: Bearer <API_KEY>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "aliases": [
>     {
>       "key": "kb_answer",
>       "value": "{{ $.answer }}"
>     },
>     {
>       "key": "kb_score",
>       "value": "{{ $.confidence }}"
>     }
>   ]
> }'

1 {
2   "tool": {
3     "id": "b2c3d4e5-6f70-4a1b-8c2d-3e4f5a6b7c8d",
4     "name": "ask_lumenone",
5     "description": "Query the knowledge base",
6     "method": "POST",
7     "url": "https://app.lumenia.tech/api/v1/vapi/ask_lumenone",
8     "headers": {
9       "properties": {
10         "Authorization": {
11           "type": "string",
12           "value": "••••••"
13         }
14       },
15       "type": "object"
16     },
17     "requestSchema": {
18       "properties": {
19         "query": {
20           "description": "The caller question",
21           "type": "string"
22         }
23       },
24       "required": [
25         "query"
26       ],
27       "type": "object"
28     },
29     "responseSchema": {
30       "properties": {
31         "answer": {
32           "description": "Answer to read back to the caller",
33           "type": "string"
34         }
35       },
36       "required": [
37         "answer"
38       ],
39       "type": "object"
40     },
41     "aliases": [
42       {
43         "key": "kb_answer",
44         "value": "{{ $.answer }}"
45       },
46       {
47         "key": "kb_score",
48         "value": "{{ $.confidence }}"
49       }
50     ],
51     "createdAt": "2026-06-15T05:24:00.000Z",
52     "updatedAt": "2026-06-15T05:24:00.000Z"
53   }
54 }

Update selected tool fields.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <API_KEY>, where API_KEY is your API key.

Path parameters

toolIdstringRequired

Tool to update.

Request

Fields to change on the tool. Every field is optional but you must send at least one field. Only the fields you send are updated and the rest are left untouched.

namestringOptional

The tool name the assistant calls it by. Must be unique within the scope that owns the tool.

descriptionstringOptional

Natural-language description of what the tool does. This is what the assistant uses to decide when to call it, so make it specific.

methodenumOptional

HTTP method the tool uses to call its endpoint.

Allowed values:

urlstringOptionalformat: "uri"

The endpoint the tool calls.

headersobjectOptional

HTTP headers sent with the request, JSON-Schema-shaped: a type plus properties keyed by header name, each header being a type and value. Values are masked when the tool is read back. Sending this replaces the existing headers.

requestSchemaobject or nullOptional

JSON Schema of the payload the tool sends. Defines the arguments the assistant must supply when calling the tool.

responseSchemaobject or nullOptional

JSON Schema of response fields to make available. Send null or an empty object to reset it. Omit aliases to leave them unchanged.

aliaseslist of objectsOptional

Variable bindings evaluated over the parsed JSON response, where the response body is the $root (e.g.$ .data.id). Each entry maps a variable key to a Liquid template. Send an empty array to clear all aliases. Independent of responseSchema.

Variable bindings evaluated over the parsed JSON response, where the response body is the $ root (e.g. $.data.id). Each entry maps a variable key to a Liquid template. Send an empty array to clear all aliases. Independent of responseSchema.

Response

The updated tool.

toolobject

The updated tool.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors