Create organization tool

POST

https://app.lumenia.net/api/v1/organizations/:orgId/tools

POST

/api/v1/organizations/:orgId/tools

$ curl -X POST https://app.lumenia.net/api/v1/organizations/orgId/tools \
>      -H "X-Account-Id: X-Account-Id" \
>      -H "Authorization: Bearer <API_KEY>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "ask_lumenone",
>   "method": "POST",
>   "url": "https://app.lumenia.tech/api/v1/vapi/ask_lumenone",
>   "description": "Query the knowledge base",
>   "headers": {
>     "properties": {
>       "Authorization": {
>         "type": "string",
>         "value": "Bearer SECRET"
>       }
>     },
>     "type": "object"
>   },
>   "requestSchema": {
>     "properties": {
>       "query": {
>         "description": "The caller question",
>         "type": "string"
>       }
>     },
>     "required": [
>       "query"
>     ],
>     "type": "object"
>   },
>   "responseSchema": {
>     "properties": {
>       "answer": {
>         "description": "Answer to read back to the caller",
>         "type": "string"
>       }
>     },
>     "required": [
>       "answer"
>     ],
>     "type": "object"
>   },
>   "aliases": [
>     {
>       "key": "kb_answer",
>       "value": "{{ $.answer }}"
>     }
>   ]
> }'

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     "createdAt": "2026-06-15T05:24:00.000Z",
48     "updatedAt": "2026-06-15T05:24:00.000Z"
49   }
50 }

Create a tool in an organization.

Authentication

AuthorizationBearer

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

Path parameters

orgIdstringRequired

Organization that will own the tool.

Request

This endpoint expects an object.

namestringRequired

Tool name. 1-64 characters of letters, digits, underscores or hyphens (no spaces). This is the name the assistant uses to call the tool.

methodenumRequired

The HTTP method the tool uses.

Allowed values:

urlstringRequired

The HTTP endpoint the tool calls.

descriptionstringOptional

Human-readable description of what the tool does.

headersobjectOptional

HTTP headers to send with the request, JSON-Schema-shaped: a type plus properties keyed by header name, each header being a type and value. Header values are masked when the tool is read back.

requestSchemaobjectOptional

JSON Schema of the request payload the tool sends.

responseSchemaobjectOptional

JSON Schema of the fields to extract from the tool JSON response.

aliaseslist of objectsOptional

Named values created from the tool response. Each value is a Liquid template; the response body is available as $(for example,$ .data.id).

Named values created from the tool response. Each value is a Liquid template; the response body is available as $ (for example, $.data.id).

Response

The created tool.

toolobject

The newly created tool.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors