mirror of https://github.com/Hommy-master/capcut-mate.git synced 2026-06-20 09:32:15 +08:00

Files

2. 删除多余文档。
3. 添加中英文切换开关。

2026-03-01 20:27:45 +08:00

4.9 KiB

Raw Blame History

TIMELINES API Documentation

🌐 Language Switch

中文版 | English

Interface Information

POST /openapi/capcut-mate/v1/timelines

Function Description

Create timelines based on specified duration and quantity. This interface is used to generate timeline configurations needed for video editing, supporting multiple timeline types and start time settings, providing time reference for subsequent material addition and editing.

Request Parameters

{
  "duration": 10000000,
  "num": 3,
  "start": 0,
  "type": "equal"
}

Parameter Description

Parameter	Type	Required	Default	Description
duration	number	✅	-	Total duration (microseconds)
num	number	✅	-	Number of time segments
start	number	❌	0	Start time (microseconds)
type	string	❌	"equal"	Timeline type

Parameter Details

duration

Type: number
Description: Total duration in microseconds (1 second = 1,000,000 microseconds)
Example: 10000000 (10 seconds)

num

Type: number
Description: Number of time segments to create
Example: 3 (Create 3 time segments)

start

Type: number
Description: Start time of the timeline in microseconds
Default: 0
Example: 2000000 (Start from 2 seconds)

type

Type: string
Description: Timeline segmentation type
Options:
- "equal" - Equal division timeline
- "custom" - Custom timeline
Default: "equal"

Response Format

Success Response (200)

{
  "timelines": [
    {
      "start": 0,
      "end": 3333333
    },
    {
      "start": 3333333,
      "end": 6666666
    },
    {
      "start": 6666666,
      "end": 10000000
    }
  ],
  "all_timelines": [
    {
      "start": 0,
      "end": 10000000
    }
  ]
}

Response Field Description

Field	Type	Description
timelines	array	Array of segmented timelines
all_timelines	array	Array of complete timelines
start	number	Start time of time segment (microseconds)
end	number	End time of time segment (microseconds)

Error Response (4xx/5xx)

{
  "detail": "Error message description"
}

Usage Examples

cURL Examples

1. Basic Timeline Creation

curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/timelines \
  -H "Content-Type: application/json" \
  -d '{
    "duration": 15000000,
    "num": 5,
    "start": 0,
    "type": "equal"
  }'

2. Timeline with Start Time

curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/timelines \
  -H "Content-Type: application/json" \
  -d '{
    "duration": 20000000,
    "num": 4,
    "start": 5000000,
    "type": "equal"
  }'

Error Code Description

Error Code	Error Message	Description	Solution
400	duration is required	Missing total duration parameter	Provide valid duration parameter
400	num is required	Missing time segment count parameter	Provide valid num parameter
400	duration must be greater than 0	Invalid duration parameter	Use duration value greater than 0
400	num must be greater than 0	Invalid count parameter	Use count value greater than 0
400	Invalid timeline type	Unsupported type parameter	Use supported timeline type
500	Timeline calculation failed	Internal processing error	Contact technical support

Notes

Time Unit: All time parameters use microseconds (1 second = 1,000,000 microseconds)
Parameter Requirements: duration and num are required parameters
Time Range: Ensure start + (duration/num) * num <= total duration
Type Selection: Choose appropriate timeline type based on actual needs
Precision Consideration: Microsecond-level time precision is suitable for precise video editing

Workflow

Validate required parameters (duration, num)
Check parameter validity (positive numbers, reasonable range)
Calculate timeline segmentation method based on type
Generate segmented timeline array
Generate complete timeline array
Return timeline configuration result

📚 Project Resources
GitHub: https://github.com/Hommy-master/capcut-mate
Gitee: https://gitee.com/taohongmin-gitee/capcut-mate

Language Switch