client.agents

Accessed via client.agents.

Methods

create

Create an agent.

create(params: CreateAgentParams): Promise<Agent>

Types: CreateAgentParams · Agent

delete

Soft-delete an agent.

delete(params: DeleteAgentParams): Promise<SuccessResponse>

Types: DeleteAgentParams · SuccessResponse

list

List agents.

list(params?: Omit<ListAgentsParams, "filter" | "orderBy"> & { filter?: AgentFilter; orderBy?: AgentOrderBy[]; } & AgentShorthands): Promise<Page<Agent>>

Types: ListAgentsParams · AgentFilter · AgentOrderBy · AgentShorthands · Page · Agent

purge

Permanently delete a soft-deleted agent.

purge(params: PurgeAgentParams): Promise<SuccessResponse>

Types: PurgeAgentParams · SuccessResponse

restore

Restore a soft-deleted agent.

restore(params: RestoreAgentParams): Promise<Agent>

Types: RestoreAgentParams · Agent

retrieve

Get an agent by ID.

retrieve(params: RetrieveAgentParams): Promise<Agent>

Types: RetrieveAgentParams · Agent

update

Update an agent.

update(params: UpdateAgentParams): Promise<Agent>

Types: UpdateAgentParams · Agent

client.agents.mcpServers

Accessed via client.agents.mcpServers.

sync

Replace all MCP server assignments for an agent. PUT /api/agents/:id/mcp-servers

sync(params: SyncAgentMcpServersParams): Promise<SuccessResponse>

Types: SyncAgentMcpServersParams · SuccessResponse

client.agents.skills

Accessed via client.agents.skills.

sync

Replace all skill assignments for an agent. PUT /api/agents/:id/skills

sync(params: SyncAgentSkillsParams): Promise<SuccessResponse>

Types: SyncAgentSkillsParams · SuccessResponse

client.agents.tools

Accessed via client.agents.tools.

sync

Replace all tool assignments for an agent. PUT /api/agents/:id/tools

Pass the full desired set; anything not in toolIds is unassigned.

sync(params: SyncAgentToolsParams): Promise<SuccessResponse>

Types: SyncAgentToolsParams · SuccessResponse

await client.agents.tools.sync({
  agentId: "agt_abc123",
  toolIds: ["tol_search", "tol_summarize"],
});