Skip to main content

​
Retrieve Agent

Get an agent by ID. 
agent = client.agents.retrieve("agent-id")
Parameters:
  • agent_id (str): Agent UUID
Returns: Agent

​
List Agents

List agents in a namespace. 
agents = client.agents.list(
    namespace_id="ns-123",
    limit=20,
)
Parameters:
  • namespace_id (str, optional): Filter by namespace
  • limit (int, optional): Max results
  • page_number (int, optional): Page number
  • order_by (str, optional): Sort field
  • order_direction (str, optional): “asc” or “desc”
Returns: AgentListResponse

​
Delete Agent

Delete an agent by ID. 
client.agents.delete("agent-id")
Parameters:
  • agent_id (str): Agent UUID
Returns: DeleteResponse

​
Retrieve by Name

Get agent by namespace and name. 
agent = client.agents.retrieve_by_name(
    namespace_slug="my-namespace",
    agent_name="my-agent",
)

​
Deploy Agent

Deploy a new version of an agent. 
response = client.agents.deploy(
    agent_name="my-namespace/my-agent",
    branch="main",
    git_hash="abc123",
    image_url="registry.example.com/agent:tag",
    author_name="Your Name",
    author_email="[email protected]",
    replicas=2,
)
Parameters:
  • agent_name (str): Full agent name (namespace/agent)
  • branch (str): Git branch
  • git_hash (str): Git commit hash
  • image_url (str): Container image URL
  • author_name (str): Deployer name
  • author_email (str): Deployer email
  • replicas (int, optional): Number of replicas
Returns: DeployResponse

​
Handle RPC

Execute RPC method on agent. 
response = client.agents.handle_rpc(
    agent_id="agent-id",
    namespace_id="ns-123",
    method="create_task",
    params={"name": "my-task"},
)
Parameters:
  • agent_id (str): Agent UUID
  • namespace_id (str): Namespace UUID
  • method (str): RPC method name
  • params (dict): Method parameters
Returns: AgentRpcResponse

​
Schedules

Manage agent schedules. 
# Create schedule
schedule = client.agents.schedules.create(
    agent_id="agent-id",
    cron="0 9 * * *",
    params={"type": "daily"},
)

# List schedules
schedules = client.agents.schedules.list(agent_id="agent-id")

# Trigger schedule
client.agents.schedules.trigger(schedule_id="schedule-id")

​
Secrets

Manage agent secrets. 
# Set secret
client.agents.secrets.create(
    agent_id="agent-id",
    key="API_KEY",
    value="secret",
    environment="production",
)