Skip to content
当前页导航

CREATE_DRAFT API Documentation

🌐 Language Switch

中文版 | English

Interface Information

POST /openapi/capcut-mate/v1/create_draft

Function Description

Create a Jianying draft. This interface is used to create a new Jianying draft project, allowing customization of video width and height. After successful creation, it returns the draft URL and help document URL, providing the foundation for subsequent video editing operations.

More Documentation

📖 For more detailed documentation and tutorials, please visit: https://docs.jcaigc.cn

Request Parameters

json
{
  "width": 1920,
  "height": 1080
}

Parameter Description

ParameterTypeRequiredDefaultDescription
widthnumber1920Video width (pixels), must be greater than or equal to 1
heightnumber1080Video height (pixels), must be greater than or equal to 1

Parameter Details

Size Parameters

  • width: Width of the draft video

    • Minimum: 1 pixel
    • Recommended common values: 1920, 1280, 720
    • Supports custom sizes
  • height: Height of the draft video

    • Minimum: 1 pixel
    • Recommended common values: 1080, 720, 480
    • Supports custom sizes

Common Resolutions

Resolution NameWidthHeightApplication Scenario
1080P19201080HD video production
720P1280720SD video production
4K38402160Ultra HD video production
Vertical Short Video10801920Mobile short videos
Square10801080Social media content

Response Format

Success Response (200)

json
{
  "draft_url": "https://cm.jcaigc.cn/openapi/v1/get_draft?draft_id=2025092811473036584258",
  "tip_url": "https://help.assets.jcaigc.cn/draft-usage"
}

Response Field Description

FieldTypeDescription
draft_urlstringNewly created draft URL, used for subsequent editing operations
tip_urlstringDraft usage help documentation URL

Error Response (4xx/5xx)

json
{
  "detail": "Error message description"
}

💻 Usage Examples

cURL Examples

1. Create Draft with Default Resolution

bash
curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/create_draft \
  -H "Content-Type: application/json" \
  -d '{}'

2. Create Draft with Custom Resolution

bash
curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/create_draft \
  -H "Content-Type: application/json" \
  -d '{
    "width": 1280,
    "height": 720
  }'

3. Create Vertical Short Video Draft

bash
curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/create_draft \
  -H "Content-Type: application/json" \
  -d '{
    "width": 1080,
    "height": 1920
  }'

Error Code Description

Error CodeError MessageDescriptionSolution
400width must be greater than or equal to 1Invalid width parameterProvide a width value greater than or equal to 1
400height must be greater than or equal to 1Invalid height parameterProvide a height value greater than or equal to 1
400Parameter type errorParameter type is incorrectEnsure width and height are numeric types
500Draft creation failedInternal service errorContact technical support
503Service unavailableSystem maintenanceRetry later

Notes

  1. Parameter Validation: width and height must be positive integers
  2. Resolution Recommendation: Suggest using common video resolutions to ensure compatibility
  3. Performance Consideration: Ultra-high resolution may affect subsequent processing performance
  4. Storage Usage: High-resolution drafts will occupy more storage space
  5. URL Validity: The returned draft_url has a certain validity period

Workflow

  1. Receive and validate request parameters
  2. Create draft basic structure
  3. Set canvas size
  4. Generate draft URL
  5. Return draft information and help document link