Get an agent
Returns a single agent by id. A cross-tenant, soft-deleted, or different-site id is a 404.
Authorization
ApiKeyAuth A WorkOS org-scoped API key, created from the dashboard's organization settings page. Identifies the tenant every read and write is scoped to. Missing, malformed, unknown, revoked, expired, or non-organization-owned keys all return 401 (no distinction, so the response can't be used to probe which keys or org ids exist).
In: header
Path Parameters
The site id (prefixed site_). A site id that isn't yours is a 404, same as any other cross-tenant id.
The agent id (prefixed agt_).
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/v1/sites/string/agents/string"{ "data": { "id": "string", "siteId": "string", "name": "string", "type": "shopping_assistant", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deletedAt": "2019-08-24T14:15:22Z" }}Create an agent
Creates an agent on this site and its first configuration version, V1 (empty instructions, stored with the status `champion` because it is the agent's current version). The new agent is offline: it answers no shopper and no live period starts. V1 can still change: save on it with `POST …/agents/{id}/versions` and `target` `{ "mode": "append", "lineId": …, "expectedHeadId": … }`, using the `lineId` and `id` returned here. Try it in the dashboard playground, then put it live with `POST …/agents/{id}/go-live`. Returns both.
Rename an agent
Updates the agent's non-versioned fields. Only the `name` can change here: the `type` is fixed at creation, and changing the configuration is creating a new version, not patching the agent.