Skip to main content
POST
Create a source

Authorizations

Authorization
string
header
required

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

Body

application/json
audience
enum<string>
required

What the source may read, by audience class: a customer-facing agent, an internal agent, a human desk and others.

Available options:
customer_agent,
internal_agent,
human,
reviewer,
analyst,
trigger_target,
export
name
string
required
Required string length: 1 - 256
space_id
string<uuid>
required
channel
string | null
Required string length: 1 - 256
confirms_before_acting
boolean
default:false

The agent confirms values before acting, so measurement does not count those confirmations as repeated questions.

critical
boolean
default:false

Sessions of this source stay out of control groups and always receive the memory.

navigation_enabled
boolean
default:true

Whether the source may use the history navigation tools.

purposes
string[]

Purposes the policy grants access by, such as customer_service or billing.

Maximum array length: 32
Required string length: 1 - 256
trusted_action_ops
string[]

Operations whose declared actions this source may use to close open items before the system of record confirms them.

Maximum array length: 64
Required string length: 1 - 256
vendor
string | null
Required string length: 1 - 256
verification_ceiling
enum<string>
default:V2

The highest verification level this source may declare: V2 for automated agents, V3 for sources that run OTP, V4 only for human desks and systems of record, no_customer for internal agents.

Available options:
V0,
V1,
V2,
V3,
V4,
no_customer

Response

The source.

audience
enum<string>
required
Available options:
customer_agent,
internal_agent,
human,
reviewer,
analyst,
trigger_target,
export
channel
string | null
required
confirms_before_acting
boolean
required
critical
boolean
required
name
string
required
navigation_enabled
boolean
required
purposes
string[]
required
revoked_at
string<date-time> | null
required
source_id
string<uuid>
required
space_id
string<uuid>
required
trusted_action_ops
string[]
required
vendor
string | null
required
verification_ceiling
enum<string>
required

Session verification levels. no_customer sits outside the V0-V4 scale.

Available options:
V0,
V1,
V2,
V3,
V4,
no_customer