Quick Start
Get Agent
Retrieve an agent by its ID.Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
agent_id | str | Yes | The agent’s unique identifier |
Example
List Agents
List all agents in your account.Example
Filtering Agents
Update Agent
Update an agent’s configuration.Parameters
| Parameter | Type | Description |
|---|---|---|
name | str | New agent name |
description | str | New description |
temperature | float | Creativity (0.0-2.0) |
top_p | float | Nucleus sampling (0.0-1.0) |
role | str | Agent role |
goal | str | Agent goal |
instructions | str | Agent instructions |
response_model | BaseModel | Pydantic model for structured outputs |
file_output | bool | Enable file generation |
image_output_config | dict | Image generation config |
memory | int | Memory message count |
contexts | List[Context] | Background contexts |
reflection | bool | Enable self-reflection |
bias_check | bool | Enable bias detection |
llm_judge | bool | Enable LLM judge |
groundedness_facts | List[str] | Facts for validation |
rai_policy | RAIPolicy | RAI guardrails policy |
image_model | ImageModelConfig | Image generation model |
Examples
Update Basic Properties
Update Instructions
Enable Features
Update with Structured Output
Delete Agent
Delete an agent permanently.Example
Delete by ID
Bulk Delete
Delete multiple agents at once.Example
Delete All Agents (Careful!)
Clone Agent
Create a copy of an agent with a new name.Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
new_name | str | No | ” (Clone)“ | Name for the cloned agent |