Create a twin

POST

/voice/twins

• Production
• QA

SPENDS CREDITS when a writing sample is attached: voice analyses it with a paid model and charges the organisation. Multipart because voice binds every field as a form field so the optional sample can travel with them.

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

object

agent_id

required

The id the new twin takes; 409 if it exists.

string

>= 1 characters

assertiveness

required

number

<= 1

avatar_url

Any of:

string

string

null

null

background

Any of:

string

string

null

null

calendar

Any of:

string

string

null

null

collections

Any of:

string

string

null

null

company_name_pronunciation

Any of:

string

string

null

null

conciseness

required

number

<= 1

created_by_email

Any of:

string

string

null

null

description

required

string

linkedin_data

Any of:

string

string

null

null

linkedin_url

Any of:

string

string

null

null

name

required

string

outbound_voicemail_prompt

Any of:

string

string

null

null

persona

required

string

phone

Any of:

string

string

null

null

role

required

string

tone

required

number

<= 1

use_company_knowledge

boolean

default: true

voice

Any of:

string

string

null

null

writing_style_file

Any of:

string

string format: binary

null

null

Responses

201

Successful Response

object

data

required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

object

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string