Skip to main content
PUT
/
api
/
v2
/
agents
/
{agent_name}
Update an agent
curl --request PUT \
  --url https://agp.eu.hcompany.ai/api/v2/agents/{agent_name} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://agp.eu.hcompany.ai/api/v2/agents/{agent_name}"

headers = {"Authorization": "Bearer <token>"}

response = requests.put(url, headers=headers)

print(response.text)
const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};

fetch('https://agp.eu.hcompany.ai/api/v2/agents/{agent_name}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://agp.eu.hcompany.ai/api/v2/agents/{agent_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://agp.eu.hcompany.ai/api/v2/agents/{agent_name}"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://agp.eu.hcompany.ai/api/v2/agents/{agent_name}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://agp.eu.hcompany.ai/api/v2/agents/{agent_name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
Updates an existing agent. This is a full replacement of the Agent object. The name must match the URL identifier: renames are not supported. Returns the updated Agent object.

​
Path parameters

​
agent_name
string
required
The agent’s name (e.g. my-research-bot or myorg/web-helper). Slash-containing names are supported.

​
Request body

A full replacement of the Agent object. The name in the body must equal the URL identifier. Any field you omit is reset to its default, not preserved: leaving out instructions, model, skills, or answer_format clears them. To change individual fields without resending the rest, use Patch instead.

​
Examples

curl -X PUT https://agp.eu.hcompany.ai/api/v2/agents/my-research-bot \
  -H "Authorization: Bearer $HAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-research-bot",
    "description": "Researches a topic and returns a sourced summary.",
    "environments": ["h/browser"],
    "instructions": "Always cite the page you took each claim from.",
    "skills": ["web-browse", "extract-data"]
  }'

from hai_agents import Client

client = Client()

agent = client.agents.update_agent(
    agent_name="my-research-bot",
    name="my-research-bot",
    description="Researches a topic and returns a sourced summary.",
    environments=["h/browser"],
    instructions="Always cite the page you took each claim from.",
    skills=["web-browse", "extract-data"],
)
print(agent.name)

import { HaiAgentsClient } from "hai-agents";

const client = new HaiAgentsClient();

const agent = await client.agents.updateAgent({
  agentName: "my-research-bot",
  body: {
    name: "my-research-bot",
    description: "Researches a topic and returns a sourced summary.",
    environments: ["h/browser"],
    instructions: "Always cite the page you took each claim from.",
    skills: ["web-browse", "extract-data"],
  },
});
console.log(agent.name);
Response
{
  "name": "my-research-bot",
  "description": "Researches a topic and returns a sourced summary.",
  "environments": ["h/browser"],
  "model": null,
  "instructions": "Always cite the page you took each claim from.",
  "skills": ["web-browse", "extract-data"],
  "subagents": null,
  "answer_format": null
}

​
Errors

StatusCause
400The name in the body does not match the URL identifier (renames are not supported).
403The agent is reserved (h/) and read-only.
404Agent not found or you don’t have access.
422Body fails validation; common cases: environments empty, invalid name shape.