Create partner tool

POST

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

POST

/api/v1/tools

$ curl -X POST https://app.lumenia.net/api/v1/tools \
>      -H "Authorization: Bearer <API_KEY>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "get_order_status",
>   "method": "GET",
>   "url": "https://api.partner.example/orders/status",
>   "description": "Look up an order by its number",
>   "headers": {
>     "properties": {
>       "Authorization": {
>         "type": "string",
>         "value": "Bearer SECRET"
>       }
>     },
>     "type": "object"
>   },
>   "requestSchema": {
>     "properties": {
>       "order_number": {
>         "description": "The order number",
>         "type": "string"
>       }
>     },
>     "required": [
>       "order_number"
>     ],
>     "type": "object"
>   }
> }'

1 {
2   "tool": {
3     "id": "b2c3d4e5-6f70-4a1b-8c2d-3e4f5a6b7c8d",
4     "name": "get_order_status",
5     "description": "Look up an order by its number",
6     "method": "GET",
7     "url": "https://api.partner.example/orders/status",
8     "headers": {
9       "properties": {
10         "Authorization": {
11           "type": "string",
12           "value": "••••••"
13         }
14       },
15       "type": "object"
16     },
17     "requestSchema": {
18       "properties": {
19         "order_number": {
20           "description": "The order number",
21           "type": "string"
22         }
23       },
24       "required": [
25         "order_number"
26       ],
27       "type": "object"
28     },
29     "responseSchema": {
30       "properties": {},
31       "required": [],
32       "type": "object"
33     },
34     "aliases": [],
35     "createdAt": "2026-06-15T05:24:00.000Z",
36     "updatedAt": "2026-06-15T05:24:00.000Z"
37   }
38 }

Create a partner-level tool.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

namestringRequired

Unique tool name used by the assistant. Avoid names that differ only by letter case.

methodenumRequired

HTTP method the tool uses to call its endpoint.

Allowed values:

urlstringRequiredformat: "uri"

The endpoint the tool calls.

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.

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.

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 the fields to extract from the tool response.

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.

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.

Response

The created tool.

toolobject

The newly created partner tool.

Errors

400

Bad Request Error

403

Forbidden Error

409

Conflict Error

500

Internal Server Error