post/agents

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/agents
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

orgIdstring

Organization ID that owns this agent (derived from auth if omitted)

namestring required

Human-readable display name for the agent

slugstring required

URL-friendly unique identifier (lowercase alphanumeric and hyphens only)

emailstring email

Optional email address to provision for this agent

provisionPhoneboolean

Whether to automatically provision a phone number for this agent

metadataobject

Arbitrary key-value metadata associated with the agent

voiceIdstring

Voice for this agent's calls, e.g. "thalia". Choose an id from GET /voice/catalog; defaults to the system voice when omitted.

inboxIdstring

ID of an existing inbox to associate with this agent. If omitted, a new inbox is created automatically.

Response

OK

idstring required

Unique identifier of the agent

orgIdstring required

Organization ID that owns this agent

namestring required

Human-readable display name

slugstring required

URL-friendly unique identifier

status'ACTIVE' | 'SUSPENDED' | 'DELETED' required

Current lifecycle status

apiKeyPrefixstring nullable required

Prefix of the agent's API key for identification, or null if no key is set

keyRotatedAtstring date-time nullable required

ISO 8601 timestamp of the last API-key rotation, null if never rotated

metadataobject required

Arbitrary key-value metadata

voiceIdstring nullable required

The agent's chosen voice id, or null for the system default.

createdAtstring date-time required

Timestamp when the agent was created

updatedAtstring date-time required

Timestamp when the agent was last updated

Changes

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