List agents
Create an agent
Retrieve an agent
Update an agent
Delete an agent
Run an agent (sync)
Creates a run and polls until completed. Blocks the current thread.Run an agent (async)
Creates a run and returns immediately without waiting.List runs
Retrieve a run
Dispatch actions with a registry
Use anActionRegistry to route agent actions to your service objects:
Agent attributes
| Attribute | Type | Description |
|---|---|---|
id | String | Agent ID |
name | String | Agent name |
system_prompt | String | System prompt for the agent |
model | String | Model used |
status | String | active, inactive |
business_account_id | String | Linked business account |
auto_run | Boolean | Whether auto-run is enabled |
active? | Boolean | Whether agent is active |
auto_run? | Boolean | Whether auto-run is enabled |
AgentRun attributes
| Attribute | Type | Description |
|---|---|---|
id | String | Run ID |
agent_id | String | Parent agent ID |
status | String | pending, running, completed, failed |
input | Hash | Input data sent to the agent |
output | Hash | Agent output (intent, confidence, actions) |
error | String | Error message if failed |
intent | String | Shortcut for output["intent"] |
confidence | Float | Shortcut for output["confidence"] |
actions | Array | Shortcut for output["actions"] |
pending? | Boolean | Status is pending |
running? | Boolean | Status is running |
completed? | Boolean | Status is completed |
failed? | Boolean | Status is failed |
finished? | Boolean | Completed or failed |

