Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Retrieve your key from Dashboard.

Body

application/json
template_id
string
required
Required string length: 24
name
string
required
Required string length: 3 - 180
voice
enum<string>
required
Available options:
en-US-Neural2-D,
en-US-Neural2-C,
en-US-Neural2-J,
en-US-News-K,
en-GB-News-M,
en-GB-Neural2-C,
en-GB-Neural2-B,
en-GB-Neural2-F,
es-ES-Neural2-B,
es-ES-Neural2-F,
es-ES-Neural2-C,
es-ES-Neural2-D,
en-US-Eleven-Marcus,
en-US-Eleven-Myra,
en-US-Eleven-Adam,
en-US-OpenAI-alloy,
en-US-OpenAI-echo,
en-GB-OpenAI-fable,
en-US-OpenAI-onyx,
en-US-OpenAI-nova,
en-US-OpenAI-shimmer,
es-ES-OpenAI-alloy,
es-ES-OpenAI-echo,
es-ES-OpenAI-onyx,
es-ES-OpenAI-nova,
es-ES-OpenAI-shimmer
end_screen
string
pre_questions
string[]
Required string length: 3 - 180
structured_data
object[]
webhook
string

We will trigger post request to this webhook url with this data

We generated a signature to secure the webhook payload, please refer to the colab example.

Minimum string length: 5
hidden_fields
string[]

Hidden Fields allows you to use data you already have, track information about your respondents, please refer to our colab example

Required string length: 3 - 180

Response

Successful response

message
string
Example:

"success"

result
object