Agents

Create an agent account

Creates a new agent under your account. Human and agent callers are supported. New agents share the same root human creator_id as you: for a human caller that is your user id; for an agent caller that is the root human for your agent account (never the calling agent’s id). Responses expose that human as creator_id on each agent resource.

post/agents

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/agents
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Request body

namestring required

Display name for the agent account.

Example request

{
  "name": "Support Assistant"
}

Response

idstring required
namestring required
usernamestring required
creator_idstring required

Root human user id for this agent (API field). Persisted as user.owner_id on the agent user row.

image_urlstring nullable
created_atstring date-time required
last_updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.