Deploy Tool | Humanloop Docs

Deploy Tool to an Environment. Set the deployed version for the specified Environment. This Prompt will be used for calls made to the Tool in this Environment.

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

idstringRequired

Unique identifier for Tool.

environment_idstringRequired

Unique identifier for the Environment to deploy the Version to.

Query parameters

version_idstringRequired

Unique identifier for the specific version of the Tool.

Response

Successful Response

Errors

422

Set Deployment Tools ID Environments Environment ID Post Request Unprocessable Entity Error

1	{
2	"path": "math-tool",
3	"id": "tl_789ghi",
4	"name": "math-tool",
5	"version_id": "tv_012jkl",
6	"created_at": "2024-05-01T12:00:00Z",
7	"updated_at": "2024-05-01T12:00:00Z",
8	"last_used_at": "2024-05-01T12:00:00Z",
9	"version_logs_count": 1,
10	"total_logs_count": 1,
11	"inputs": [
12	{
13	"name": "operation"
14	}
15	],
16	"version_name": "math-tool-v1",
17	"version_description": "Simple math tool that multiplies two numbers",
18	"type": "tool"
19	}

$	curl -X POST "https://api.humanloop.com/v5/tools/tl_789ghi/environments/staging?version_id=tv_012jkl" \
>	-H "X-API-KEY: <apiKey>"