1. Advanced Editing
BeatAPI
  • Quick Start
  • BeatAPI Realtime Video API
  • Music Video API
    • Create Video
      • Create Music Video
    • Advanced Editing
      • Edit Shot
        POST
      • Get Shot Media
        POST
      • Compose Video
        POST
  • Ecommerce Video API
    • Create Ecommerce Video
  • Reference
    • API Overview
      • List launch workflows
    • Task Status
      • Poll task status
    • Usage & Limits
      • Get account usage and concurrency
    • Upload Files
      • Upload a file for workflow inputs
    • Webhooks
      • List webhook endpoints
      • Create a webhook endpoint
      • Get a webhook endpoint
      • Update a webhook endpoint
      • Delete a webhook endpoint
  • Realtime Video API
    • Create a realtime browser session
    • Get a realtime session
    • Close a realtime session
  1. Advanced Editing

Edit Shot

POST
/v1/music-video/tasks/{task_id}/shots/{shot_id}/edit
Edit one storyboard shot using its BeatAPI shot_id. This operation
charges BeatAPI customer credits using the selected quality/resolution
rate and the shot duration. Default shot duration is 5 seconds.
When the edit finishes, BeatAPI stores the edited shot media and exposes
it on that shot. The existing final Music Video is not replaced until
you call compose with the selected shot ids.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Body Params application/jsonRequired

Examples

Responses

๐ŸŸข202
application/json
Shot edit accepted
Bodyapplication/json

๐ŸŸ 404
๐ŸŸ 400BadRequest
๐ŸŸ 401Unauthorized
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.beatapi.io/v1/music-video/tasks/task_8K2qA/shots/shot_xxx/edit' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "prompt": "Night city chorus with brighter face lighting.",
    "duration": 5,
    "quality": "standard",
    "resolution": "720p"
}'
Response 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
Previous
Create Music Video
Next
Get Shot Media
Built with