Smart Agent Teams
EndpointsAgents

Get Agent

Get one agent with its month-to-date spend and open task count. Answers 404 `NOT_FOUND` when the agent does not belong to this company.

GET
/api/companies/{company_id}/agents/{agent_id}

Get one agent with its month-to-date spend and open task count.

Answers 404 NOT_FOUND when the agent does not belong to this company.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Path Parameters

agent_id*Agent Id
Formatuuid
company_id*Company Id
Formatuuid

Response Body

Successful Response

application/json
  1. response
adapter*string|null
avatar_seed*Avatar Seed
capabilities*array<unknown>|null
company_id*|null
created_at*|null
heartbeat_cron*string|null
id*Id
Formatuuid
instructions*string|null
last_activity*|null
monthly_budget_cents*Monthly Budget Cents
name*Name
open_tasks?Open Tasks
Default0
reports_to_id*|null
role*string|null
spend_mtd_cents?Spend Mtd Cents
Default0
status*Status
title*string|null
curl -X GET "https://example.com/api/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "adapter": "string",  "avatar_seed": 0,  "capabilities": [    null  ],  "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",  "created_at": "2019-08-24T14:15:22Z",  "heartbeat_cron": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "instructions": "string",  "last_activity": "2019-08-24T14:15:22Z",  "monthly_budget_cents": 0,  "name": "string",  "open_tasks": 0,  "reports_to_id": "9a08cb01-6bdc-412f-ad45-35a6f5d74f8e",  "role": "string",  "spend_mtd_cents": 0,  "status": "string",  "title": "string"}

Create Agent POST

Hire an agent into the company. The agent starts `idle`. With `request_approval: true` it starts `pending_approval` instead and a `hire_agent` approval is opened; approving it makes the agent `idle`, rejecting it terminates the agent. `reports_to_id` must be an agent in this company (404 `NOT_FOUND` otherwise). `monthly_budget_cents` is in integer cents; `0` means no limit. Any member may call this. Publishes `agent.created` (and `approval.created` when an approval was opened).

Update Agent PATCH

Update an agent's profile, manager, instructions, capabilities or budget. Only fields present in the body are changed. A new `reports_to_id` must be an agent in this company and must not create a reporting cycle (400 `ORG_CYCLE`); `null` makes the agent a root of the org chart. Status is not changed here; use pause, resume and terminate. Publishes `agent.updated` when something changed.