Create Batch
Example Request using urls for track data
POST /v1/batches
{
"ref": "my-reference",
"artist": {
"name": "Artist Name",
"artworkUrl": "https://placehold.co/1000x1000"
},
"mediaBundle": {
"name": "My Song",
"artworkUrl": "https://placehold.co/1000x1000",
},
"media": {
"name": "My Song",
"artworkUrl": "https://placehold.co/1000x1000",
"audioUrl": "https://public.audio/song.mp3"
},
"serviceParams": {},
"webhookUrl": "https://example.com/webhook",
"renders": [
{
"contentId": "BASE_BASIC_UNIFIED",
"requiredData": {
"customText": "Sample Custom Text"
},
"videoSettings": {
"numVideos": 3,
"aspectRatio": "16x9",
"audioStartEndSecs": {
"start": 0,
"end": 15
},
"outputQuality": "FULL"
}
}
]
}
Response
{
"success": true,
"message": "Batch created successfully",
"data": {
"batchId": "batch-123",
"renders": [
{
"renderId": "render-123",
"status": "PENDING"
}
]
}
}
Example Request using ids for track data
POST /v1/batches
{
"success": true,
"message": "Batch created successfully",
"data": {
"type": "RENDER",
"ref": "my-reference",
"batchId": "batch-123",
"artistId": "artist-123",
"mediaBundleId": "media-bundle-123",
"mediaId": "media-123",
"status": "PENDING",
"createdAt": "2025-01-15T03:37:11.983Z",
"webhookUrl": "https://example.com/webhook",
"renders": [
{
"renderId": "render-123",
"status": "COLLECTING_ASSETS",
"progress": 0,
"createdAt": "2025-01-15T03:37:11.983Z",
"aspectRatio": "16x9",
"fileName": "my-song.mp4",
}
]
}
}
Get Batch
Retrieve details about a specific batch by ID.Example Request
GET /v1/batches/{batchId}
Response
{
"success": true,
"message": "Batch retrieved successfully",
"data": {
"type": "RENDER",
"ref": "my-reference",
"batchId": "batch-123",
"artistId": "artist-123",
"mediaBundleId": "media-bundle-123",
"mediaId": "media-123",
"status": "COMPLETED",
"createdAt": "2025-01-15T03:37:11.983Z",
"webhookUrl": "https://example.com/webhook",
"renders": [
{
"renderId": "render-123",
"contentId": "BASE_BASIC_UNIFIED",
"status": "COMPLETED",
"progress": 100,
"createdAt": "2025-01-15T03:37:11.983Z",
"aspectRatio": "16x9",
"fileName": "my-song.mp4",
"renderUrl": "https://api.render.com/v1/renders/render-123",
},
]
}
}