Skip to content
vocapable.Docs

Hear a saved draft greeting in a selected voice without publishing or calling

POST
/v1/agents/{agent_id}/voice-preview
curl --request POST \
  --url https://api.vocapable.com/v1/agents/example/voice-preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_updated_at": "2026-04-15T12:00:00Z", "stock_voice_id": "example", "voice_profile_id": "example", "language": "en" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
agent_id
required
Agent Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
AgentVoicePreviewRequest

Audition the saved draft greeting with a selected voice, without editing it.

object
expected_updated_at
required
Expected Updated At
string format: date-time
stock_voice_id
Any of:
string
>= 1 characters <= 128 characters
voice_profile_id
Any of:
string
>= 1 characters <= 128 characters
language
required
Language
string
Allowed values: en es

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
AgentVoicePreview
object
agent_id
required
Agent Id
string
draft_updated_at
required
Draft Updated At
string format: date-time
voice_id
required
Voice Id
string
language
required
Language
string
Allowed values: en es
text
required
Text
string
media_type
Media Type
string
default: audio/wav
Allowed value: audio/wav
audio_base64
required
Audio Base64
string
Example
{
  "language": "en",
  "media_type": "audio/wav"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}