Voice Question
POST/workstations/:workstation_id/voice/question
Speak a question into the virtual microphone, listening for a user response, and then optionally responding back.
Request
Path Parameters
The UID associated to a Workstation. Learn more
- application/json
Body
required
Pre-written copy that will be spoken verbatim into the virtual microphone.
Determines if the agent can optionally respond to the user. An LLM analyzes the interaction to decide if a response is needed. The default value is false.
falseResponses
- 200
- 400
- 401
- 402
- 422
- 429
- 500
- 503
Question task 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"
}