API Reference
Authorization
ApiKeyAuth Authorization<token>
Use Bearer br_live_....
In: header
Header Parameters
Idempotency-Key?string
Retry key (8-200 characters). Reusing it with identical input returns the original response; different input returns 409.
Match
^[A-Za-z0-9._:-]+$Length
8 <= length <= 200Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/clips" \ -H "Content-Type: application/json" \ -d '{ "project_name": "MKBHD hero loop", "source": { "source_type": "youtube", "youtube_url": "https://www.youtube.com/watch?v=VIDEO_ID", "quality": "2160p" }, "selection": { "selection_mode": "auto_best" }, "target": { "aspect_ratio": "9:16", "min_duration_seconds": 8, "max_duration_seconds": 12 }, "layout": { "layout_mode": "auto", "content_type_hint": "podcast" }, "captions": { "enabled": true }, "qa": { "qa_mode": "permissive" }, "export": { "auto_export": false } }'{ "batch": { "batch_id": "string", "status": "string", "asset_id": "string", "project_folder_id": "string", "estimated_clip_count": 0, "total_clip_count": 0, "rendered_count": 0, "failed_count": 0, "review_count": 0, "activity": null, "clips": [ { "clip_id": "string", "suggestion_id": "string", "project_id": "string", "export_id": "string", "title": "string", "status": "string", "download_url": "string", "error_message": "string", "qa_summary": "string", "qa_preview_urls": [ "string" ] } ], "zip_download_url": "string", "last_error_message": "string" }}