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

workstation_id uidrequired

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.

oneOf

MOD1

copy Copy (string)required

The exact text that will be used.

MOD2

instructions string[]required

An array of prompts that will be provided to an LLM to generate text.

Responses

200

Speak action successful

400

Invalid Request Format - check API documentation for proper syntax.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

401

Unauthorized - missing or invalid API key.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

402

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

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

422

Unprocessable Entity - cannot find requested asset associated with your API key.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

429

Too Many Requests - you have exceeded the rate limit for your account. Please wait before making additional requests.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

500

Internal Server Error - please retry your request.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

503

Service Unavailable - our servers have dropped the request due to high load - please retry.

application/json

Schema

Schema

error string
message string

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Loading...