Skip to content
当前页导航

GET_DRAFT API Documentation

🌐 Language Switch

中文版 | English

Interface Information

GET /openapi/capcut-mate/v1/get_draft

Function Description

Get draft file list. This interface is used to get all file lists corresponding to the specified draft ID, allowing you to view material files, configuration files, etc. in the draft. Usually used for draft content preview, file management or status checking.

More Documentation

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

Request Parameters

Query Parameters

ParameterTypeRequiredDefaultDescription
draft_idstring-Draft ID, length 20-32 characters

Parameter Details

draft_id

  • Type: String
  • Required: Yes
  • Length: 20-32 characters
  • Format: Usually UUID format or similar unique identifier
  • Example: 2f52a63b-8c6a-4417-8b01-1b2a569ccb6c
  • Acquisition Method: Usually extracted from draft_url or returned by create_draft interface

Response Format

Success Response (200)

json
{
  "files": [
    "2f52a63b-8c6a-4417-8b01-1b2a569ccb6c.json",
    "video_123456789.mp4",
    "audio_987654321.mp3",
    "image_555666777.jpg",
    "thumbnail_888999000.png"
  ]
}

Response Field Description

FieldTypeDescription
filesarrayList of files related to the draft

Error Response (4xx/5xx)

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

Usage Examples

cURL Examples

1. Basic Get Draft File List

bash
curl -X GET "https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=2f52a63b-8c6a-4417-8b01-1b2a569ccb6c" \
  -H "Content-Type: application/json"

2. Using Complete draft_id

bash
curl -X GET "https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/get_draft?draft_id=7e8f9a0b-1c2d-3e4f-5g6h-7i8j9k0l1m2n" \
  -H "Content-Type: application/json"

Error Code Description

Error CodeError MessageDescriptionSolution
400draft_id is requiredMissing draft_id parameterProvide a valid draft_id
400Invalid draft_id lengthdraft_id length not within 20-32 characters rangeCheck if draft_id format is correct
400Invalid draft_id formatdraft_id format is incorrectEnsure using correct draft ID format
404Draft does not existSpecified draft ID cannot be foundConfirm that draft ID is correct and exists
500Failed to get file listInternal service errorContact technical support or retry later
503Service unavailableSystem maintenanceRetry later

Notes

  1. Parameter Format: Ensure draft_id format is correct and length is between 20-32 characters
  2. ID Extraction: Correctly extract draft_id from draft_url
  3. File Types: Returned file list contains multiple types of files
  4. Permission Verification: Ensure permission to access specified draft
  5. Timeliness: File list may not be updated in real-time, with some delay
  6. File Status: Files in the list may be in different processing states

Workflow

  1. Validate draft_id parameter
  2. Check draft_id format and length
  3. Find specified draft
  4. Get all files associated with the draft
  5. Return file list

Language Switch

中文版 | English