Workflow List
Workflow list
Request Parameters
Starting offset, default 0
Page size, 0-500 items
Sort field, options: created_at, updated_at
Sort order, options: asc, desc
Workflow name, 1-100 characters
Response Parameters
Workflow list
Workflow ID
Workflow Name
User ID
Region ID
Workflow node list
Workflow Node Type
1: Basic Transcoding
2: Video Concatenation
3: Screenshot
4: Output
Basic Transcoding Config
Transcoding Preset ID
Watermark Preset ID list
Container Format
0: MP4
1: MKV
2: HLS
Video Parameters
Video Codec
0: H264
1: H265
2: AV1
Bitrate Config
Bitrate Config Type
0: Default
1: Constant Bitrate (CBR)
2: CRF
Bitrate config value
Resolution Config
Resolution Config Type
0: Original Resolution
1: 4K
2: 2K
3: 1080P
4: 720P
5: 480P
6: Custom Resolution
Resolution Width
Resolution Height
Display Aspect Ratio Config
Display Aspect Ratio Config Type
0: Original Aspect Ratio
1: 16:10
2: 16:9
3: 4:3
4: 1:1
5: Custom Aspect Ratio
Custom display width
Custom display height
Whether to remove black bars
Scaling config, null means not set
Scaling Config Type
0: Stretch
1: Letterbox
Video framerate config, null means not set
Custom framerate value
Keyframe config, null means not set
Custom keyframe value
Clip segment config, null means not set
Start time (seconds)
Duration (seconds)
Segment duration, required for HLS type
Audio Parameters
Whether to disable audio
Audio Codec
0: Default
2: MP3
1: AAC
3: ACC_HE
Audio channel config, 0 means keep original. Note: channels must match audio codec, otherwise transcoding or output may fail
Audio Bitrate Config
Audio Bitrate Config Type
0: Default
1: 96k
2: 128K
3: 192K
4: 256K
5: 320K
6: Custom
Audio bitrate config value
Audio Sample Rate Config
Audio Sample Rate Config Type
0: Default
1: 8000
2: 11025
3: 12000
4: 16000
5: 22050
6: 24000
7: 32000
8: 44100
9: 48000
10: 64000
11: 88200
12: 96000
20: Custom
Audio sample rate config value
Subtitle Parameters
Whether to disable subtitle
input file list
Bucket name
Object Name
Cloud Storage Data ID
Subtitle placeholder, 1-based, 0 means no subtitle
Whether to convert soft subtitle to hard subtitle
Subtitle index, 0-based
Watermark Parameters
watermark list
Watermark Type
0: Text
1: Image
Text Watermark Configuration
Text watermark content
Watermark Text Font
0: FangZheng Song
1: FangZheng Hei
2: FangZheng Kai
3: MapleMono
Text watermark font size (PX)
Text watermark color
Whether to add text border
Border width (1-5PX)
Border color (hex color value)
Border opacity (0-1.0)
Whether italic
Whether bold
Image Watermark Configuration
input file list
Bucket name
Object Name
Cloud Storage Data ID
Image Scaling Config
Scaling ratio, (0-1], ratio of watermark to video size
Watermark Position
0: Top Left
4: Top Center
2: Top Right
1: Middle Left
5: Center
3: Middle Right
6: Bottom Left
7: Bottom Center
8: Bottom Right
Watermark Horizontal Margin (px)
Watermark vertical margin (px)
Watermark Timeline Configuration
Watermark Timeline Start Type
0: From Beginning
1: From End
Start time (seconds)
Duration (seconds)
Watermark animation
Watermark Position
0: Top Left
4: Top Center
2: Top Right
1: Middle Left
5: Center
3: Middle Right
6: Bottom Left
7: Bottom Center
8: Bottom Right
Watermark End Horizontal Margin (px)
Watermark End Vertical Margin (px)
Watermark Animation Time Mode
0: Once
1: Repeat
Watermark Animation Start Time
Watermark Animation Interval
Watermark Animation Duration
Video Concatenation Config
Concatenation Preset ID
Video Concatenation Container Format
0: MP4
1: MKV
Resolution Config
Resolution Config Type
0: Original Resolution
1: 4K
2: 2K
3: 1080P
4: 720P
5: 480P
6: Custom Resolution
Resolution Width
Resolution Height
Peak bitrate config, null means not set
Peak bitrate config value
Concatenation input file list
Bucket name
Object Name
Cloud Storage Data ID
Whether to pad audio for videos without audio track
Whether to add black borders
Source video position, 0 means the first video in the index
Screenshot Config
Screenshot Preset ID
Screenshot Type
0: Single
1: Multiple
Screenshot Container Format
0: JPEG
1: PNG
Resolution Config
Resolution Config Type
0: Original Resolution
1: 4K
2: 2K
3: 1080P
4: 720P
5: 480P
6: Custom Resolution
Resolution Width
Resolution Height
Screenshot start time (seconds)
Screenshot duration (seconds), required for multiple screenshots
Screenshot interval (seconds), required for multiple screenshots
Screenshot Interval Type
0: Second
1: Percent
Screenshot interval percent (1-100)
Screenshot Time Mode
0: Precise Time
1: Percent Range
Screenshot start percent (only valid for percent mode)
Screenshot end percent (only valid for percent mode)
Screenshot count, only valid for percent mode
Output Config
Output Bucket
Output path, e.g. aa/bb
Output file name prefix
TS file name prefix
File extension, e.g. mp4/mkv/png/jpg/zip
Bucket ID
TS File Name Style
Child node list
Workflow Node Index
Transcoding Workflow Status
0: Pending
1: Processing
2: Success
3: Failed
Workflow node failure reason
Created at (unix timestamp)
Updated at (unix timestamp)
Total count
Response Examples
{
"list": [
{
"id": "10000000000000000001",
"workflow_name": "WorkflowA",
"user_id": "10000000000000000001",
"region_id": "10000000000000000001",
"workflow_details": {
"list": [
{
"workflow_type": 1,
"basic_transcoding_params": {
"transcoding_preset_id": "10000000000000000001",
"watermark_preset_ids": [
"10000000000000000001"
],
"container_format": 0,
"video_params": {
"codec": 0,
"bitrate_params": {
"bitrate_type": 0,
"value": 1000
},
"resolution_params": {
"resolution_type": 0,
"width": 1920,
"height": 1080
}
},
"audio_params": {
"disable_audio": false,
"codec": 0,
"channels": 2,
"bitrate_params": {
"bitrate_type": 2,
"value": 128
}
},
"subtitle_params": {
"disable_subtitle": false
}
},
"index": 0,
"workflow_status": 0,
"fail_reason": ""
}
]
},
"created_at": 1700000000,
"updated_at": 1700000000
}
],
"total": 20
}- Products
- VPS Hosting
- VPS HostingUnmetered
- Bare Metal
- GPU Rental
- CDNPublic Beta
- Custom CDN
- Object StoragePublic Beta
- TranscoderPublic Beta