Call Tool

POST

https://api.humanloop.com/v5/tools/call

POST

/v5/tools/call

1 curl -X POST https://api.humanloop.com/v5/tools/call \
2      -H "X-API-KEY: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

Try it

200Successful

1 {
2   "tool": {
3     "path": "path",
4     "id": "id",
5     "name": "name",
6     "version_id": "version_id",
7     "created_at": "2024-01-15T09:30:00Z",
8     "updated_at": "2024-01-15T09:30:00Z",
9     "last_used_at": "2024-01-15T09:30:00Z",
10     "version_logs_count": 1,
11     "total_logs_count": 1,
12     "inputs": [
13       {
14         "name": "name"
15       }
16     ],
17     "directory_id": "directory_id",
18     "function": {
19       "name": "name",
20       "description": "description",
21       "strict": true,
22       "parameters": {
23         "key": "value"
24       }
25     },
26     "source_code": "source_code",
27     "setup_values": {
28       "key": "value"
29     },
30     "attributes": {
31       "key": "value"
32     },
33     "tool_type": "pinecone_search",
34     "version_name": "version_name",
35     "version_description": "version_description",
36     "description": "description",
37     "readme": "readme",
38     "tags": [
39       "tags"
40     ],
41     "type": "tool",
42     "environments": [
43       {
44         "id": "id",
45         "created_at": "2024-01-15T09:30:00Z",
46         "name": "name",
47         "tag": "default"
48       }
49     ],
50     "created_by": {
51       "id": "id",
52       "email_address": "email_address",
53       "full_name": "full_name"
54     },
55     "evaluators": [
56       {
57         "version_reference": {
58           "file": {
59             "path": "path",
60             "id": "id",
61             "model": "model",
62             "name": "name",
63             "version_id": "version_id",
64             "created_at": "2024-01-15T09:30:00Z",
65             "updated_at": "2024-01-15T09:30:00Z",
66             "last_used_at": "2024-01-15T09:30:00Z",
67             "version_logs_count": 1,
68             "total_logs_count": 1,
69             "inputs": [
70               {
71                 "name": "name"
72               }
73             ]
74           },
75           "environment": {
76             "id": "id",
77             "created_at": "2024-01-15T09:30:00Z",
78             "name": "name",
79             "tag": "default"
80           },
81           "type": "environment"
82         },
83         "state": "active",
84         "created_at": "2024-01-15T09:30:00Z",
85         "updated_at": "2024-01-15T09:30:00Z"
86       }
87     ],
88     "signature": "signature",
89     "evaluator_aggregates": [
90       {
91         "value": 1.1,
92         "evaluator_id": "evaluator_id",
93         "evaluator_version_id": "evaluator_version_id",
94         "created_at": "2024-01-15T09:30:00Z",
95         "updated_at": "2024-01-15T09:30:00Z"
96       }
97     ]
98   },
99   "id": "id",
100   "evaluator_logs": [
101     {
102       "id": "id",
103       "evaluator_logs": [],
104       "evaluator": {
105         "path": "path",
106         "id": "id",
107         "spec": {
108           "arguments_type": "target_free",
109           "return_type": "boolean",
110           "evaluator_type": "llm"
111         },
112         "name": "name",
113         "version_id": "version_id",
114         "created_at": "2024-01-15T09:30:00Z",
115         "updated_at": "2024-01-15T09:30:00Z",
116         "last_used_at": "2024-01-15T09:30:00Z",
117         "version_logs_count": 1,
118         "total_logs_count": 1,
119         "inputs": [
120           {
121             "name": "name"
122           }
123         ]
124       },
125       "start_time": "2024-01-15T09:30:00Z",
126       "end_time": "2024-01-15T09:30:00Z",
127       "output": "output",
128       "created_at": "2024-01-15T09:30:00Z",
129       "error": "error",
130       "provider_latency": 1.1,
131       "stdout": "stdout",
132       "provider_request": {
133         "key": "value"
134       },
135       "provider_response": {
136         "key": "value"
137       },
138       "inputs": {
139         "key": "value"
140       },
141       "source": "source",
142       "metadata": {
143         "key": "value"
144       },
145       "log_status": "complete",
146       "parent_id": "parent_id",
147       "source_datapoint_id": "source_datapoint_id",
148       "trace_parent_id": "trace_parent_id",
149       "batches": [
150         "batches"
151       ],
152       "user": "user",
153       "environment": "environment",
154       "save": true,
155       "log_id": "log_id",
156       "output_message": {
157         "role": "user"
158       },
159       "judgment": true,
160       "marked_completed": true,
161       "trace_flow_id": "trace_flow_id",
162       "trace_id": "trace_id",
163       "trace_children": [
164         {
165           "prompt": {
166             "path": "path",
167             "id": "id",
168             "model": "model",
169             "name": "name",
170             "version_id": "version_id",
171             "created_at": "2024-01-15T09:30:00Z",
172             "updated_at": "2024-01-15T09:30:00Z",
173             "last_used_at": "2024-01-15T09:30:00Z",
174             "version_logs_count": 1,
175             "total_logs_count": 1,
176             "inputs": [
177               {
178                 "name": "name"
179               }
180             ]
181           },
182           "id": "id",
183           "evaluator_logs": []
184         }
185       ],
186       "parent": {
187         "prompt": {
188           "path": "path",
189           "id": "id",
190           "model": "model",
191           "name": "name",
192           "version_id": "version_id",
193           "created_at": "2024-01-15T09:30:00Z",
194           "updated_at": "2024-01-15T09:30:00Z",
195           "last_used_at": "2024-01-15T09:30:00Z",
196           "version_logs_count": 1,
197           "total_logs_count": 1,
198           "inputs": [
199             {
200               "name": "name"
201             }
202           ]
203         },
204         "id": "id",
205         "evaluator_logs": []
206       }
207     }
208   ],
209   "start_time": "2024-01-15T09:30:00Z",
210   "end_time": "2024-01-15T09:30:00Z",
211   "output": "output",
212   "created_at": "2024-01-15T09:30:00Z",
213   "error": "error",
214   "provider_latency": 1.1,
215   "stdout": "stdout",
216   "provider_request": {
217     "key": "value"
218   },
219   "provider_response": {
220     "key": "value"
221   },
222   "inputs": {
223     "key": "value"
224   },
225   "source": "source",
226   "metadata": {
227     "key": "value"
228   },
229   "log_status": "complete",
230   "source_datapoint_id": "source_datapoint_id",
231   "trace_parent_id": "trace_parent_id",
232   "batches": [
233     "batches"
234   ],
235   "user": "user",
236   "environment": "environment",
237   "save": true,
238   "log_id": "log_id",
239   "trace_flow_id": "trace_flow_id",
240   "trace_id": "trace_id",
241   "trace_children": [
242     {
243       "output_message": {
244         "role": "user"
245       },
246       "prompt_tokens": 1,
247       "reasoning_tokens": 1,
248       "output_tokens": 1,
249       "prompt_cost": 1.1,
250       "output_cost": 1.1,
251       "finish_reason": "finish_reason",
252       "messages": [
253         {
254           "role": "user"
255         }
256       ],
257       "tool_choice": "none",
258       "prompt": {
259         "path": "path",
260         "id": "id",
261         "model": "model",
262         "name": "name",
263         "version_id": "version_id",
264         "created_at": "2024-01-15T09:30:00Z",
265         "updated_at": "2024-01-15T09:30:00Z",
266         "last_used_at": "2024-01-15T09:30:00Z",
267         "version_logs_count": 1,
268         "total_logs_count": 1,
269         "inputs": [
270           {
271             "name": "name"
272           }
273         ]
274       },
275       "start_time": "2024-01-15T09:30:00Z",
276       "end_time": "2024-01-15T09:30:00Z",
277       "output": "output",
278       "created_at": "2024-01-15T09:30:00Z",
279       "error": "error",
280       "provider_latency": 1.1,
281       "stdout": "stdout",
282       "provider_request": {
283         "key": "value"
284       },
285       "provider_response": {
286         "key": "value"
287       },
288       "inputs": {
289         "key": "value"
290       },
291       "source": "source",
292       "metadata": {
293         "key": "value"
294       },
295       "log_status": "complete",
296       "source_datapoint_id": "source_datapoint_id",
297       "trace_parent_id": "trace_parent_id",
298       "batches": [
299         "batches"
300       ],
301       "user": "user",
302       "environment": "environment",
303       "save": true,
304       "log_id": "log_id",
305       "id": "id",
306       "evaluator_logs": [
307         {
308           "id": "id",
309           "evaluator_logs": [],
310           "evaluator": {
311             "path": "path",
312             "id": "id",
313             "spec": {
314               "arguments_type": "target_free",
315               "return_type": "boolean",
316               "evaluator_type": "llm"
317             },
318             "name": "name",
319             "version_id": "version_id",
320             "created_at": "2024-01-15T09:30:00Z",
321             "updated_at": "2024-01-15T09:30:00Z",
322             "last_used_at": "2024-01-15T09:30:00Z",
323             "version_logs_count": 1,
324             "total_logs_count": 1,
325             "inputs": [
326               {
327                 "name": "name"
328               }
329             ]
330           }
331         }
332       ],
333       "trace_flow_id": "trace_flow_id",
334       "trace_id": "trace_id"
335     }
336   ]
337 }

Call a Tool.

Calling a Tool with inputs runs the tool’s source code and logs the result and metadata to Humanloop.

You can use query parameters version_id, or environment, to target an existing version of the Tool. Otherwise, the default deployed version will be chosen.

Instead of targeting an existing version explicitly, you can instead pass in Tool details in the request body. In this case, we will check if the details correspond to an existing version of the Tool. If they do not, we will create a new version. This is helpful in the case where you are storing or deriving your Tool details in code.

Query parameters

version_idstringOptional

A specific Version ID of the Tool to call.

environmentstringOptional

Name of the Environment identifying a deployed version to call.

Request

This endpoint expects an object.

pathstringOptional

Path of the Tool, including the name. This locates the Tool in the Humanloop filesystem and is used as as a unique identifier. For example: folder/name or just name.

idstringOptional

ID for an existing Tool.

toolobjectOptional

Details of your Tool. A new Tool version will be created if the provided details are new.

inputsmap from strings to anyOptional

The inputs passed to the prompt template.

sourcestringOptional

Identifies where the model was called from.

metadatamap from strings to anyOptional

Any additional metadata to record.

start_timedatetimeOptional

When the logged event started.

end_timedatetimeOptional

When the logged event ended.

log_statusenumOptional

Status of a Log. Set to incomplete if you intend to update and eventually complete the Log and want the File’s monitoring Evaluators to wait until you mark it as complete. If log_status is not provided, observability will pick up the Log as soon as possible. Updating this from specified to unspecified is undefined behavior.

Allowed values:

source_datapoint_idstringOptional

Unique identifier for the Datapoint that this Log is derived from. This can be used by Humanloop to associate Logs to Evaluations. If provided, Humanloop will automatically associate this Log to Evaluations that require a Log for this Datapoint-Version pair.

trace_parent_idstringOptional

The ID of the parent Log to nest this Log under in a Trace.

userstringOptional

End-user ID related to the Log.

environmentstringOptional

The name of the Environment the Log is associated to.

savebooleanOptionalDefaults to true

Whether the request/response payloads will be stored on Humanloop.

log_idstringOptional

This will identify a Log. If you don’t provide a Log ID, Humanloop will generate one for you.

Response

Successful Response

toolobject

Tool used to generate the Log.

idstring

ID of the log.

evaluator_logslist of objects

List of Evaluator Logs associated with the Log. These contain Evaluator judgments on the Log.

start_timedatetimeOptional

When the logged event started.

end_timedatetimeOptional

When the logged event ended.

outputstringOptional

Generated output from your model for the provided inputs. Can be None if logging an error, or if creating a parent Log with the intention to populate it later.

created_atdatetimeOptional

User defined timestamp for when the log was created.

errorstringOptional

Error message if the log is an error.

provider_latencydoubleOptional

Duration of the logged event in seconds.

stdoutstringOptional

Captured log and debug statements.

provider_requestmap from strings to anyOptional

Raw request sent to provider.

provider_responsemap from strings to anyOptional

Raw response received the provider.

inputsmap from strings to anyOptional

The inputs passed to the prompt template.

sourcestringOptional

Identifies where the model was called from.

metadatamap from strings to anyOptional

Any additional metadata to record.

log_statusenumOptional

Allowed values:

source_datapoint_idstringOptional

trace_parent_idstringOptional

The ID of the parent Log to nest this Log under in a Trace.

batcheslist of stringsOptional

Array of Batch IDs that this Log is part of. Batches are used to group Logs together for offline Evaluations

userstringOptional

End-user ID related to the Log.

environmentstringOptional

The name of the Environment the Log is associated to.

savebooleanOptionalDefaults to true

Whether the request/response payloads will be stored on Humanloop.

log_idstringOptional

This will identify a Log. If you don’t provide a Log ID, Humanloop will generate one for you.

trace_flow_idstringOptional

Identifier for the Flow that the Trace belongs to.

trace_idstringOptional

ID of the Trace containing the Tool Call Log.

trace_childrenlist of objectsOptional

Logs nested under this Log in the Trace.

Call Tool

Headers

Query parameters

Request

Response

Errors