Create a tool

POST

https://api.smallest.ai/atoms/v1/tool

POST

/atoms/v1/tool

1 import requests
2 
3 url = "https://api.smallest.ai/atoms/v1/tool"
4 
5 payload = { "definition": {
6         "type": "api_call",
7         "name": "get_order_status",
8         "description": "Look up a customer's order by id and read back its status."
9     } }
10 headers = {
11     "Authorization": "Bearer <token>",
12     "Content-Type": "application/json"
13 }
14 
15 response = requests.post(url, json=payload, headers=headers)
16 
17 print(response.json())

1 {
2   "status": true,
3   "data": {
4     "_id": "6a86c89eb3073ea15c328ce0",
5     "toolId": "tool_ab12cd34ef56gh78ij90kl12",
6     "organizationId": "6a5f9c9fcf10167aad404c40",
7     "type": "api_call",
8     "definition": {
9       "type": "api_call",
10       "name": "get_order_status",
11       "description": "Look up a customer's order by id and read back its status.",
12       "enabled": true,
13       "url": "https://api.example.com/orders",
14       "method": "GET",
15       "timeout": 5000,
16       "headers": {
17         "Authorization": "Bearer TOKEN",
18         "Content-Type": "application/json"
19       },
20       "headersArray": [
21         {
22           "key": "Authorization",
23           "value": "Bearer TOKEN"
24         }
25       ],
26       "queryParams": [
27         {
28           "key": "id",
29           "value": "{{order_id}}"
30         }
31       ],
32       "requestBody": "{\"customer_id\": \"{{customer_id}}\"}",
33       "llmParameters": [
34         {
35           "name": "string",
36           "description": "string",
37           "type": "text",
38           "values": [
39             "string"
40           ],
41           "required": false
42         }
43       ],
44       "responseVariables": [
45         {
46           "variableName": "orderStatus",
47           "jsonPath": "$.data.status"
48         }
49       ],
50       "auth": {
51         "type": "none",
52         "token": "ORDER_API_TOKEN",
53         "name": "X-API-Key",
54         "location": "header",
55         "value": "SEARCH_API_KEY",
56         "username": "string",
57         "password": "string"
58       },
59       "timeoutMs": 1000,
60       "expectsResponse": true,
61       "fillerPhrases": [
62         "Let me check that for you",
63         "One moment please"
64       ]
65     },
66     "createdAt": "2024-01-15T09:30:00Z",
67     "updatedAt": "2024-01-15T09:30:00Z"
68   }
69 }

Create a reusable tool in the org Tools library. Two types are supported: api_call and client_tool (system tools like transfer/end-call are configured per-agent, not here). Reference it from an agent by adding its returned toolId to toolRefs on the agent config.

Referencing a tool makes it available; it does not force use. The agent only calls a tool when its prompt tells it to, so describe the tool’s purpose and when to trigger it in the agent’s prompt.

Create a reusable tool in the org Tools library. Two types are supported: `api_call` and `client_tool` (system tools like transfer/end-call are configured per-agent, not here). Reference it from an agent by adding its returned `toolId` to `toolRefs` on the agent config. Referencing a tool makes it available; it does not force use. The agent only calls a tool when its prompt tells it to, so describe the tool's purpose and when to trigger it in the agent's prompt.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Request

This endpoint expects an object.

definitionobjectRequired

The tool body — the same shape used inside an agent’s tools[] (discriminated on type). api_call is the most common; client_tool and the built-in types are also valid.

Response

Tool created.

statusbooleanOptional

dataobjectOptional

A tool in the org-level Tools library. Referenced from agents by toolId (see toolRefs on the agent config). Editing a library tool propagates to every agent that references it.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error