A valid request URL is required to generate request examples{
"id": "<string>",
"status": "pending",
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"status_code": 123,
"result": "<unknown>",
"error": {
"event_id": "<string>",
"type": "<string>",
"is_vikat_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "openai",
"model_requested": "<string>",
"request_type": "<string>"
}
}
}{
"event_id": "<string>",
"type": "<string>",
"is_vikat_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "openai",
"model_requested": "<string>",
"request_type": "<string>"
}
}{
"event_id": "<string>",
"type": "<string>",
"is_vikat_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "openai",
"model_requested": "<string>",
"request_type": "<string>"
}
}Create async speech
Submits a speech synthesis request for asynchronous execution. Returns a job ID immediately with HTTP 202. Poll the corresponding GET endpoint with the job ID to retrieve the result. SSE streaming is not supported for async requests.
A valid request URL is required to generate request examples{
"id": "<string>",
"status": "pending",
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"status_code": 123,
"result": "<unknown>",
"error": {
"event_id": "<string>",
"type": "<string>",
"is_vikat_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "openai",
"model_requested": "<string>",
"request_type": "<string>"
}
}
}{
"event_id": "<string>",
"type": "<string>",
"is_vikat_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "openai",
"model_requested": "<string>",
"request_type": "<string>"
}
}{
"event_id": "<string>",
"type": "<string>",
"is_vikat_error": true,
"status_code": 123,
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"event_id": "<string>"
},
"extra_fields": {
"provider": "openai",
"model_requested": "<string>",
"request_type": "<string>"
}
}Authorizations
Bearer token authentication. Use your provider API key or Vikat authentication token.
Virtual keys (prefixed with sk-vk-, or the legacy sk-bf-) can also be passed here.
Headers
Time-to-live in seconds for the job result after completion. Defaults to 3600 (1 hour). After expiry, the job result is automatically cleaned up.
Body
Model in provider/model format
Text to convert to speech
Set to "sse" to enable streaming
sse mp3, opus, aac, flac, wav, pcm 0.25 <= x <= 4Show child attributes
Show child attributes
Response
Job accepted for processing
Response returned when creating or polling an async job
Unique identifier for the async job
The status of an async job
pending, processing, completed, failed When the job was created
When the job result expires and will be cleaned up
When the job completed (successfully or with failure)
HTTP status code of the completed operation
The result of the completed operation (shape depends on the request type)
Error response from Vikat
Show child attributes
Show child attributes