Upload Audio
This API uploads your audio to vimmerse for future use.
SecurityAPIKeyHeader
Request
Responses
200
New Audio URL
400
Bad Request
402
Insufficient Credit
422
Validation Error
post/audio
Request samples
- curl
- JavaScript
- Python
- Go
- Node.js
Response samples
- 200
- 400
- 402
- 422
application/json
{- "data": {
- "id": "ASSET_ID",
- "customer_id": "CUSTOMER_ID",
- "primary_user_id": "CUSTOMER_ID",
- "args": { },
- "results": [
- "result_url1",
- "result_url2"
], - "thumbnails": [ ],
- "status": "success",
- "mime_type": "MIMETYPE",
- "app_name": "FUNCTION_NAME",
- "created_at": "2025-05-06 16:35:59.840508+00:00",
- "updated_at": "2025-05-06 16:35:59.840508+00:00",
- "history": [ ]
}
}Text 2 Speech
This api generates speech from text prompt.
Header
X-Api-Key: Your customer API key.
Request Data
prompt: Text prompt of the speech.voice: Voice of the speech. Available voices are "Aria", "Roger", "Sarah", "Laura", "Charlie", "George", "Callum", "River", "Liam", "Charlotte", "Alice", "Matilda", "Will", "Jessica", "Eric", "Chris", "Brian", "Daniel", "Lily" and "Bill". Default is "Rachel".
SecurityAPIKeyHeader
Request
Request Body schema: application/x-www-form-urlencoded
Responses
200
Audio URL
400
Bad Request
402
Insufficient Credit
422
Validation Error
post/audio/text-2-speech
Request samples
- curl
- JavaScript
- Python
- Go
- Node.js
Response samples
- 200
- 400
- 402
- 422
application/json
{- "data": {
- "id": "ASSET_ID",
- "customer_id": "CUSTOMER_ID",
- "primary_user_id": "CUSTOMER_ID",
- "args": { },
- "results": [
- "result_url1",
- "result_url2"
], - "thumbnails": [ ],
- "status": "success",
- "mime_type": "MIMETYPE",
- "app_name": "FUNCTION_NAME",
- "created_at": "2025-05-06 16:35:59.840508+00:00",
- "updated_at": "2025-05-06 16:35:59.840508+00:00",
- "history": [ ]
}
}Text 2 Sound Effect
This API generates sound effects from text prompt.
Header
X-Api-Key: Your customer API key.
Request Data
prompt: Text prompt of the audio.duration: Duration of the audio. Default value is 5 which means 5 second.
SecurityAPIKeyHeader
Request
Responses
200
Audio URL
400
Bad Request
402
Insufficient Credit
422
Validation Error
post/audio/text-2-sound-effect
Request samples
- curl
- JavaScript
- Python
- Go
- Node.js
Response samples
- 200
- 400
- 402
- 422
application/json
{- "data": {
- "id": "ASSET_ID",
- "customer_id": "CUSTOMER_ID",
- "primary_user_id": "CUSTOMER_ID",
- "args": { },
- "results": [
- "result_url1",
- "result_url2"
], - "thumbnails": [ ],
- "status": "success",
- "mime_type": "MIMETYPE",
- "app_name": "FUNCTION_NAME",
- "created_at": "2025-05-06 16:35:59.840508+00:00",
- "updated_at": "2025-05-06 16:35:59.840508+00:00",
- "history": [ ]
}
}Text 2 Music
This API generates 30-second music from text prompt.
Header
X-Api-Key: Your customer API key.
Request Data
prompt: Text prompt of the audio.
SecurityAPIKeyHeader
Request
Responses
200
Audio URL
400
Bad Request
402
Insufficient Credit
422
Validation Error
post/audio/text-2-music
Request samples
- curl
- JavaScript
- Python
- Go
- Node.js
Response samples
- 200
- 400
- 402
- 422
application/json
{- "data": {
- "id": "ASSET_ID",
- "customer_id": "CUSTOMER_ID",
- "primary_user_id": "CUSTOMER_ID",
- "args": { },
- "results": [
- "result_url1",
- "result_url2"
], - "thumbnails": [ ],
- "status": "success",
- "mime_type": "MIMETYPE",
- "app_name": "FUNCTION_NAME",
- "created_at": "2025-05-06 16:35:59.840508+00:00",
- "updated_at": "2025-05-06 16:35:59.840508+00:00",
- "history": [ ]
}
}