Agents
List agents
List your custom agents and the pre-built h/ agents.
GET
/
api
/
v2
/
agents
from hai_agents import Client
client = Client()
agents = client.agents.list_agents()
print(agents.items)
import { HaiAgentsClient } from "hai-agents";
const client = new HaiAgentsClient();
const agents = await client.agents.listAgents();
console.log(agents.items);
curl "https://agp.eu.hcompany.ai/api/v2/agents" \
-H "Authorization: Bearer $HAI_API_KEY"
{
"items": [
{
"name": "h/web-surfer-flash",
"description": "Visual web agent for interactive or visually rendered pages.",
"environments": ["h/browser"],
"model": "holo4-35b-a3b",
"reasoning_effort": null,
"instructions": null,
"subagents": null,
"skills": ["h/company", "h/user-collaboration", "h/answering", "h/planning"],
"answer_format": null,
"tools": null
},
{
"name": "price-checker",
"description": "Compares product prices across e-commerce sites.",
"environments": ["h/browser"],
"model": null,
"reasoning_effort": null,
"instructions": null,
"subagents": null,
"skills": null,
"answer_format": null,
"tools": null
}
],
"page": 1,
"total": 8
}
Query parameters
string
Case-insensitive substring match on the agent name.
string
Case-insensitive match on the agent name or description.
boolean
true: only H’s reserved h/ agents. false: only your organization’s agents. Omit for both.string
revision: each item also carries revision, the agent’s current revision number. The SDKs still type items as agents, so revision is an untyped extra field: agent.revision in Python, (agent as any).revision in TypeScript.integer
default:"1"
Page number (1-based).
integer
default:"10"
Items per page. Maximum:
1000.string
default:"-created_at"
Sort order. Options:
created_at, -created_at, agent_name, -agent_name.Response
200 with a page envelope whose items are agent objects.
from hai_agents import Client
client = Client()
agents = client.agents.list_agents()
print(agents.items)
import { HaiAgentsClient } from "hai-agents";
const client = new HaiAgentsClient();
const agents = await client.agents.listAgents();
console.log(agents.items);
curl "https://agp.eu.hcompany.ai/api/v2/agents" \
-H "Authorization: Bearer $HAI_API_KEY"
{
"items": [
{
"name": "h/web-surfer-flash",
"description": "Visual web agent for interactive or visually rendered pages.",
"environments": ["h/browser"],
"model": "holo4-35b-a3b",
"reasoning_effort": null,
"instructions": null,
"subagents": null,
"skills": ["h/company", "h/user-collaboration", "h/answering", "h/planning"],
"answer_format": null,
"tools": null
},
{
"name": "price-checker",
"description": "Compares product prices across e-commerce sites.",
"environments": ["h/browser"],
"model": null,
"reasoning_effort": null,
"instructions": null,
"subagents": null,
"skills": null,
"answer_format": null,
"tools": null
}
],
"page": 1,
"total": 8
}
List only your organization’s agents
agents = client.agents.list_agents(reserved=False)
const agents = await client.agents.listAgents({ reserved: false });
curl "https://agp.eu.hcompany.ai/api/v2/agents?reserved=false" \
-H "Authorization: Bearer $HAI_API_KEY"
Was this page helpful?
⌘I
from hai_agents import Client
client = Client()
agents = client.agents.list_agents()
print(agents.items)
import { HaiAgentsClient } from "hai-agents";
const client = new HaiAgentsClient();
const agents = await client.agents.listAgents();
console.log(agents.items);
curl "https://agp.eu.hcompany.ai/api/v2/agents" \
-H "Authorization: Bearer $HAI_API_KEY"
{
"items": [
{
"name": "h/web-surfer-flash",
"description": "Visual web agent for interactive or visually rendered pages.",
"environments": ["h/browser"],
"model": "holo4-35b-a3b",
"reasoning_effort": null,
"instructions": null,
"subagents": null,
"skills": ["h/company", "h/user-collaboration", "h/answering", "h/planning"],
"answer_format": null,
"tools": null
},
{
"name": "price-checker",
"description": "Compares product prices across e-commerce sites.",
"environments": ["h/browser"],
"model": null,
"reasoning_effort": null,
"instructions": null,
"subagents": null,
"skills": null,
"answer_format": null,
"tools": null
}
],
"page": 1,
"total": 8
}