Agents Client

The agents client manages your registered agents on the Kate platform.

Methods

`list()`

List all your agents.

agents = await client.agents.list()
for agent in agents:
    print(f"{agent.name} ({agent.id})  -  {agent.domain}")

Returns: list[Agent]

`get(agent_id)`

Get a single agent by ID.

agent = await client.agents.get(agent_id="your-agent-id")
print(f"{agent.name}: {agent.objective}")

Returns: Agent

`create(name, domain, objective)`

agent = await client.agents.create(
    name="Content Marketing Strategist",
    domain="marketing",
    objective="Generate data-driven content strategies for B2B SaaS",
)
print(f"Created: {agent.id}")

Parameters:

Name	Type	Default	Description
`name`	`str`	required	Agent name
`domain`	`str`	`"general"`	Domain classification
`objective`	`str \| None`	`None`	Agent's objective

Returns: Agent

`update(agent_id, **kwargs)`

Update an agent's properties.

agent = await client.agents.update(
    agent_id="your-agent-id",
    objective="Updated objective",
)

Returns: Agent

`delete(agent_id)`

Delete an agent (soft-delete).

result = await client.agents.delete(agent_id="your-agent-id")

Returns: dict

Data Model

`Agent`

@dataclass
class Agent:
    id: str
    name: str
    domain: str
    objective: str | None = None
    status: str | None = None
    owner_id: str | None = None
    created_at: str | None = None
    updated_at: str | None = None

Next Steps

Artifacts Client - manage knowledge artifacts
Runs Client - manage agent runs

Agents Client

On this page