Deploy Agent | Humanloop Docs

curl -X POST "https://api.humanloop.com/v5/agents/id/environments/environment_id?version_id=version_id" \
     -H "X-API-KEY: <apiKey>"

{
  "path": "path",
  "id": "id",
  "model": "model",
  "tools": [
    {
      "type": "file",
      "link": {
        "file_id": "file_id"
      },
      "on_agent_call": "stop",
      "file": {
        "path": "path",
        "id": "id",
        "model": "model",
        "name": "name",
        "version_id": "version_id",
        "created_at": "2024-01-15T09:30:00Z",
        "updated_at": "2024-01-15T09:30:00Z",
        "last_used_at": "2024-01-15T09:30:00Z",
        "version_logs_count": 1,
        "total_logs_count": 1,
        "inputs": [
          {
            "name": "name"
          }
        ]
      }
    }
  ],
  "name": "name",
  "version_id": "version_id",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "status": "uncommitted",
  "last_used_at": "2024-01-15T09:30:00Z",
  "version_logs_count": 1,
  "total_logs_count": 1,
  "inputs": [
    {
      "name": "name"
    }
  ],
  "directory_id": "directory_id",
  "endpoint": "complete",
  "template": "template",
  "template_language": "default",
  "provider": "anthropic",
  "max_tokens": 1,
  "temperature": 1.1,
  "top_p": 1.1,
  "stop": "stop",
  "presence_penalty": 1.1,
  "frequency_penalty": 1.1,
  "other": {
    "key": "value"
  },
  "seed": 1,
  "response_format": {
    "type": "json_object",
    "json_schema": {
      "key": "value"
    }
  },
  "reasoning_effort": "high",
  "attributes": {
    "key": "value"
  },
  "max_iterations": 1,
  "version_name": "version_name",
  "version_description": "version_description",
  "description": "description",
  "tags": [
    "tags"
  ],
  "readme": "readme",
  "schema": {
    "key": "value"
  },
  "type": "agent",
  "environments": [
    {
      "id": "id",
      "created_at": "2024-01-15T09:30:00Z",
      "name": "name",
      "tag": "default"
    }
  ],
  "created_by": {
    "id": "id",
    "email_address": "email_address",
    "full_name": "full_name"
  },
  "committed_by": {
    "id": "id",
    "email_address": "email_address",
    "full_name": "full_name"
  },
  "committed_at": "2024-01-15T09:30:00Z",
  "evaluators": [
    {
      "version_reference": {
        "file": {
          "path": "path",
          "id": "id",
          "model": "model",
          "name": "name",
          "version_id": "version_id",
          "created_at": "2024-01-15T09:30:00Z",
          "updated_at": "2024-01-15T09:30:00Z",
          "last_used_at": "2024-01-15T09:30:00Z",
          "version_logs_count": 1,
          "total_logs_count": 1,
          "inputs": [
            {
              "name": "name"
            }
          ]
        },
        "environment": {
          "id": "id",
          "created_at": "2024-01-15T09:30:00Z",
          "name": "name",
          "tag": "default"
        },
        "type": "environment"
      },
      "state": "active",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "version": {
        "path": "path",
        "id": "id",
        "spec": {
          "arguments_type": "target_free",
          "return_type": "boolean",
          "evaluator_type": "llm"
        },
        "name": "name",
        "version_id": "version_id",
        "created_at": "2024-01-15T09:30:00Z",
        "updated_at": "2024-01-15T09:30:00Z",
        "last_used_at": "2024-01-15T09:30:00Z",
        "version_logs_count": 1,
        "total_logs_count": 1,
        "inputs": [
          {
            "name": "name"
          }
        ]
      }
    }
  ],
  "evaluator_aggregates": [
    {
      "value": 1.1,
      "evaluator_id": "evaluator_id",
      "evaluator_version_id": "evaluator_version_id",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z"
    }
  ],
  "raw_file_content": "raw_file_content"
}

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

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

idstringRequired

Unique identifier for Agent.

environment_idstringRequired

Unique identifier for the Environment to deploy the Version to.

Query parameters

version_idstringRequired

Unique identifier for the specific version of the Agent.

Response

Successful Response

Errors

422

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

1	{
2	"path": "path",
3	"id": "id",
4	"model": "model",
5	"tools": [
6	{
7	"type": "file",
8	"link": {
9	"file_id": "file_id"
10	},
11	"on_agent_call": "stop",
12	"file": {
13	"path": "path",
14	"id": "id",
15	"model": "model",
16	"name": "name",
17	"version_id": "version_id",
18	"created_at": "2024-01-15T09:30:00Z",
19	"updated_at": "2024-01-15T09:30:00Z",
20	"last_used_at": "2024-01-15T09:30:00Z",
21	"version_logs_count": 1,
22	"total_logs_count": 1,
23	"inputs": [
24	{
25	"name": "name"
26	}
27	]
28	}
29	}
30	],
31	"name": "name",
32	"version_id": "version_id",
33	"created_at": "2024-01-15T09:30:00Z",
34	"updated_at": "2024-01-15T09:30:00Z",
35	"status": "uncommitted",
36	"last_used_at": "2024-01-15T09:30:00Z",
37	"version_logs_count": 1,
38	"total_logs_count": 1,
39	"inputs": [
40	{
41	"name": "name"
42	}
43	],
44	"directory_id": "directory_id",
45	"endpoint": "complete",
46	"template": "template",
47	"template_language": "default",
48	"provider": "anthropic",
49	"max_tokens": 1,
50	"temperature": 1.1,
51	"top_p": 1.1,
52	"stop": "stop",
53	"presence_penalty": 1.1,
54	"frequency_penalty": 1.1,
55	"other": {
56	"key": "value"
57	},
58	"seed": 1,
59	"response_format": {
60	"type": "json_object",
61	"json_schema": {
62	"key": "value"
63	}
64	},
65	"reasoning_effort": "high",
66	"attributes": {
67	"key": "value"
68	},
69	"max_iterations": 1,
70	"version_name": "version_name",
71	"version_description": "version_description",
72	"description": "description",
73	"tags": [
74	"tags"
75	],
76	"readme": "readme",
77	"schema": {
78	"key": "value"
79	},
80	"type": "agent",
81	"environments": [
82	{
83	"id": "id",
84	"created_at": "2024-01-15T09:30:00Z",
85	"name": "name",
86	"tag": "default"
87	}
88	],
89	"created_by": {
90	"id": "id",
91	"email_address": "email_address",
92	"full_name": "full_name"
93	},
94	"committed_by": {
95	"id": "id",
96	"email_address": "email_address",
97	"full_name": "full_name"
98	},
99	"committed_at": "2024-01-15T09:30:00Z",
100	"evaluators": [
101	{
102	"version_reference": {
103	"file": {
104	"path": "path",
105	"id": "id",
106	"model": "model",
107	"name": "name",
108	"version_id": "version_id",
109	"created_at": "2024-01-15T09:30:00Z",
110	"updated_at": "2024-01-15T09:30:00Z",
111	"last_used_at": "2024-01-15T09:30:00Z",
112	"version_logs_count": 1,
113	"total_logs_count": 1,
114	"inputs": [
115	{
116	"name": "name"
117	}
118	]
119	},
120	"environment": {
121	"id": "id",
122	"created_at": "2024-01-15T09:30:00Z",
123	"name": "name",
124	"tag": "default"
125	},
126	"type": "environment"
127	},
128	"state": "active",
129	"created_at": "2024-01-15T09:30:00Z",
130	"updated_at": "2024-01-15T09:30:00Z",
131	"version": {
132	"path": "path",
133	"id": "id",
134	"spec": {
135	"arguments_type": "target_free",
136	"return_type": "boolean",
137	"evaluator_type": "llm"
138	},
139	"name": "name",
140	"version_id": "version_id",
141	"created_at": "2024-01-15T09:30:00Z",
142	"updated_at": "2024-01-15T09:30:00Z",
143	"last_used_at": "2024-01-15T09:30:00Z",
144	"version_logs_count": 1,
145	"total_logs_count": 1,
146	"inputs": [
147	{
148	"name": "name"
149	}
150	]
151	}
152	}
153	],
154	"evaluator_aggregates": [
155	{
156	"value": 1.1,
157	"evaluator_id": "evaluator_id",
158	"evaluator_version_id": "evaluator_version_id",
159	"created_at": "2024-01-15T09:30:00Z",
160	"updated_at": "2024-01-15T09:30:00Z"
161	}
162	],
163	"raw_file_content": "raw_file_content"
164	}