Skip to main content
POST
/
batches
Create a new batch
curl --request POST \
  --url https://api.blurb.fm/v1/batches \
  --header 'Content-Type: application/json' \
  --data '
{
  "mediaBundle": "your-media-bundle-id-here",
  "media": "your-media-id-here",
  "artist": "your-artist-id-here",
  "ref": "your-ref-here",
  "renders": [
    {
      "contentId": "BASE_BASIC_UNIFIED",
      "requiredData": {},
      "videoSettings": {
        "numVideos": 1,
        "aspectRatio": "16x9",
        "outputQuality": "PREVIEW",
        "audioStartEndSecs": {
          "start": 0,
          "end": 15
        }
      }
    }
  ],
  "effectOverrides": {},
  "serviceParams": {},
  "assetOverrides": null,
  "webhookUrl": "https://webhook.site/your-webhook-url-here",
  "dryRun": false,
  "useV3": false
}
'
{
  "success": true,
  "message": "Batch created",
  "data": {
    "orgId": "example",
    "mediaId": "example",
    "mediaBundleId": "example",
    "batchId": "example",
    "dryRun": null,
    "useV3": null,
    "status": null,
    "artistId": "example",
    "renders": [
      {
        "orgId": "example",
        "webhookUrl": null,
        "batchId": "example",
        "videoSettings": {
          "aspectRatio": null
        },
        "dryRun": null,
        "useV3": null,
        "ref": "example",
        "renderId": "example",
        "aspectRatio": "example",
        "message": "example",
        "progress": 3,
        "createdAt": "example",
        "renderUrl": "example",
        "thumbnailUrl": "example",
        "status": null,
        "contentId": "example"
      }
    ],
    "effectOverrides": null,
    "serviceParams": null,
    "type": "RENDER",
    "createdAt": "example"
  }
}

Body

application/json

The request to create a batch.

​
mediaBundle
required

The ID of the media bundle to generate content for.

Minimum length: 1
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
media
required

The ID of the media to generate content for.

Minimum length: 1
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
artist
required

The ID of the artist to generate content for.

Minimum length: 1
Example:

"550e8400-e29b-41d4-a716-446655440000"

​
renders
object[]
required

The renders to generate for the batch.

Minimum length: 1
​
serviceParams
object | null
required

The service params to use for the batch. Refer to content types to view optional service parameters

​
assetOverrides
object | null
required

Not Public: The asset overrides to use for the batch.

​
ref
string

User set Reference ID for the request. This will be applied to all renders in the batch.

Example:

"my-batch-ref-123"

​
bulkBatchId
string | null

The bulk batch ID to use for the batch.

​
effectOverrides
object

The effect overrides to use for the entire batch.

​
webhookUrl
string
default:""

The webhook URL to send the render status updates to.

Example:

"https://my-webhook.com/batch"

​
deliveryEmail
string | null

The email to send the finished render to.

Example:

"[email protected]"

​
dryRun
boolean
default:false

Whether to run the batch in dry run mode. If true, the batch will not be rendered, but the request will be validated and the response will be returned.

​
useV3
boolean
default:false

EXPERIMENTAL: Whether to use the v3 schema instead of the default schema.

Response

Batch created successfully

​
success
boolean
required

Whether the request was successful

Example:

true

​
message
string | null
required

Message from the API

Example:

"Batch created"

​
data
object
required

The response from the Batch POST request.

Example:
{
  "orgId": "example",
  "mediaId": "example",
  "mediaBundleId": "example",
  "batchId": "example",
  "dryRun": null,
  "useV3": null,
  "status": null,
  "artistId": "example",
  "renders": [
    {
      "orgId": "example",
      "webhookUrl": null,
      "batchId": "example",
      "videoSettings": { "aspectRatio": null },
      "dryRun": null,
      "useV3": null,
      "ref": "example",
      "renderId": "example",
      "aspectRatio": "example",
      "message": "example",
      "progress": 3,
      "createdAt": "example",
      "renderUrl": "example",
      "thumbnailUrl": "example",
      "status": null,
      "contentId": "example"
    }
  ],
  "effectOverrides": null,
  "serviceParams": null,
  "type": "RENDER",
  "createdAt": "example"
}