Compose Video

POST

/v1/music-video/tasks/{task_id}/compose

Compose selected BeatAPI storyboard shots into the final Music Video.
This operation charges a fixed 1 BeatAPI customer credit.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢202

application/json

Compose accepted

Bodyapplication/json

🟠404

🟠400BadRequest

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.beatapi.io/v1/music-video/tasks/task_8K2qA/compose' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "shot_ids": [
        "shot_xxx",
        "shot_yyy"
    ]
}'

Response Example

202 - Example 1

{
    "data": {
        "id": "task_8K2qA",
        "object": "task",
        "workflow": "music-video",
        "status": "queued",
        "stage": "queued",
        "storyboard": {
            "shots": [
                {
                    "id": "shot_xxx",
                    "index": 0,
                    "status": "queued",
                    "duration_seconds": 5,
                    "prompt": "Opening lyric shot.",
                    "lyric_text": "Intro",
                    "media": {
                        "type": "video",
                        "url": "https://media.beatapi.io/outputs/task_8K2qA/shots/0.mp4",
                        "mime_type": "video/mp4"
                    },
                    "created_at": 1782210000,
                    "updated_at": 1782210300
                }
            ]
        },
        "created_at": 0,
        "updated_at": 0,
        "completed_at": 0,
        "output": null,
        "usage": {
            "credits_reserved": 0,
            "credits_charged": 0,
            "billable_duration_seconds": 0,
            "credits_settled": 0,
            "credits_refunded": 0
        },
        "request_id": "req_abc123",
        "error_code": "processing_timeout",
        "error_message": "string"
    }
}

Modified at 2026-07-31 15:10:04

Get Shot Media

Create Ecommerce Video