Voice Speak
POST/workstations/:workstation_id/voice/speak
Play voice audio into the virtual microphone via a text-to-speech model. You can provide exact copy for the agent to speak, or instructions for an LLM to generate a response.
Request
Path Parameters
The UID associated to a Workstation. Learn more
- application/json
Body
required
Provide either 'copy' (a string) or 'instructions' (an array of strings), but not both.
- MOD1
- MOD2
oneOf
The exact text that will be used.
An array of prompts that will be provided to an LLM to generate text.
Responses
- 200
- 400
- 401
- 402
- 422
- 429
- 500
- 503
Speak action successful
Invalid Request Format - check API documentation for proper syntax.
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"message": "string"
}
Unauthorized - missing or invalid API key.
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"message": "string"
}
Payment Required - you have run out of trial credits or your payment method has expired. Please add payment details to your account.
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"message": "string"
}
Unprocessable Entity - cannot find requested asset associated with your API key.
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"message": "string"
}
Too Many Requests - you have exceeded the rate limit for your account. Please wait before making additional requests.
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"message": "string"
}
Internal Server Error - please retry your request.
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"message": "string"
}
Service Unavailable - our servers have dropped the request due to high load - please retry.
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"message": "string"
}