Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

A caller-generated key containing letters, numbers, underscores, or hyphens. Reuse the same key and request body when retrying the same logical agent creation.

Required string length: 1 - 255
Pattern: ^[A-Za-z0-9_-]+$

Body

application/json
brand_id
string<uuid>
required
display_name
string
required
Required string length: 1 - 40
use_case
enum<string>
required
Available options:
MULTI_USE,
PROMOTIONAL,
TRANSACTIONAL,
OTP
configuration
object
required
profile_id
string | null

A Messaging Profile owned by the authenticated organization. When omitted, the agent inherits the brand profile.

Maximum string length: 36
hosting_region
string | null
Maximum string length: 32

Response

The agent draft was created or replayed from the idempotency record.

agent_id
string<uuid>
required
brand_id
string<uuid>
required
display_name
string
required
use_case
enum<string>
required
Available options:
MULTI_USE,
PROMOTIONAL,
TRANSACTIONAL,
OTP
status
enum<string>
required
Available options:
CREATED,
SUBMITTED,
VERIFYING,
VERIFIED,
LAUNCHING,
LAUNCHED,
LIVE,
REJECTED,
FAILED
profile_id
string | null
required
basics_status
enum<string> | null
required
Available options:
SUBMITTED,
APPROVED,
REJECTED
campaign_status
enum<string> | null
required
Available options:
SUBMITTED,
APPROVED,
REJECTED
testing_status
enum<string> | null
required
Available options:
SUBMITTED,
APPROVED,
REJECTED
billing_category
enum<string> | null
required
Available options:
NON_CONVERSATIONAL,
CONVERSATIONAL
hosting_region
string | null
required
configuration
object
required
carrier_approvals
object[]
required
test_devices
object[]
required
capabilities
object
required