POST /voice-agents/{id}/preview-prompt

POST

/api/v1/voice-agents/{id}/preview-prompt

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/voice-agents/example/preview-prompt \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "lead_id": "example", "call_goal": "example", "style_override": { "voice_speed": 1, "voice_temperature": 1, "responsiveness": 1, "enable_backchannel": true, "backchannel_frequency": 1, "backchannel_words": [ "example" ], "reminder_trigger_ms": 1, "reminder_max_count": 1, "check_in_phrase": "example", "ambient_sound": "none", "ambient_sound_volume": 1, "boosted_keywords": [ "example" ], "pronunciation_dictionary": [ { "word": "example", "pronunciation": "example", "alphabet": "ipa" } ], "pacing_mode": "fast", "enable_filler_words": true } }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

lead_id

string

/^[0-9a-fA-F]{24}$/

call_goal

string

>= 1 characters <= 100 characters

style_override

object

voice_speed

number

>= 0.5 <= 2

voice_temperature

number

<= 2

responsiveness

number

<= 1

enable_backchannel

boolean

backchannel_frequency

number

<= 1

backchannel_words

Array<string>

<= 20 items

reminder_trigger_ms

integer

>= 1000 <= 60000

reminder_max_count

integer

<= 10

check_in_phrase

string

>= 1 characters <= 500 characters

ambient_sound

string

Allowed values: none coffee_shop office static silent call_center

ambient_sound_volume

number

<= 1

boosted_keywords

Array<string>

<= 100 items

pronunciation_dictionary

Array<object>

<= 100 items

object

word

required

string

>= 1 characters <= 200 characters

pronunciation

required

string

>= 1 characters <= 500 characters

alphabet

required

string

Allowed values: ipa cmu

pacing_mode

string

Allowed values: fast natural slow adaptive

enable_filler_words

boolean

Responses

200

OK

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

402

Feature not available on the organization plan

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}