Skip to content
当前页导航

AUDIO_INFOS API Documentation

🌐 Language Switch

中文版 | English

Interface Information

POST /openapi/capcut-mate/v1/audio_infos

Function Description

Generate audio information based on audio URLs and timelines. This interface converts audio file URLs and timeline configurations into the audio information format required by Jianying drafts, supporting volume control and audio effect settings.

More Documentation

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

Request Parameters

json
{
  "mp3_urls": ["https://assets.jcaigc.cn/audio1.mp3", "https://assets.jcaigc.cn/audio2.mp3"],
  "timelines": [
    {"start": 0, "end": 3000000},
    {"start": 3000000, "end": 8000000}
  ],
  "audio_effect": "reverb",
  "volume": 0.8
}

Parameter Description

ParameterTypeRequiredDefaultDescription
mp3_urlsarray[string]-Audio file URL array
timelinesarray[object]-Timeline configuration array
audio_effectstringNoneAudio effect name
volumenumber1.0Volume level (0.0-2.0)

Parameter Details

mp3_urls

timelines

  • Type: array[object]
  • Description: Timeline configuration array, each element contains start and end fields
  • Example: [{"start": 0, "end": 5000000}, {"start": 5000000, "end": 10000000}]

audio_effect

  • Type: string
  • Description: Audio effect name
  • Default: None
  • Example: "reverb", "echo", "bass_boost"

volume

  • Type: number
  • Description: Audio volume level
  • Default: 1.0
  • Range: 0.0 - 2.0
  • Example: 0.8 (80% volume)

Response Format

Success Response (200)

json
{
  "infos": "[{\"audio_url\":\"https://assets.jcaigc.cn/audio1.mp3\",\"start\":0,\"end\":3000000,\"duration\":5000000,\"volume\":0.8,\"audio_effect\":\"reverb\"},{\"audio_url\":\"https://assets.jcaigc.cn/audio2.mp3\",\"start\":3000000,\"end\":8000000,\"duration\":8000000,\"volume\":1.0,\"audio_effect\":null}]"
}

Response Field Description

FieldTypeDescription
infosstringAudio information JSON string

Error Response (4xx/5xx)

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

Usage Examples

cURL Examples

1. Basic Audio Information Generation

bash
curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/audio_infos \
  -H "Content-Type: application/json" \
  -d '{
    "mp3_urls": ["https://assets.jcaigc.cn/bgm.mp3"],
    "timelines": [{"start": 0, "end": 10000000}],
    "volume": 0.7
  }'

2. Audio Information with Effects

bash
curl -X POST https://capcut-mate.jcaigc.cn/openapi/capcut-mate/v1/audio_infos \
  -H "Content-Type: application/json" \
  -d '{
    "mp3_urls": ["https://assets.jcaigc.cn/intro.mp3", "https://assets.jcaigc.cn/content.mp3"],
    "timelines": [{"start": 0, "end": 2000000}, {"start": 2000000, "end": 12000000}],
    "audio_effect": "reverb",
    "volume": 0.9
  }'

Error Code Description

Error CodeError MessageDescriptionSolution
400mp3_urls is requiredMissing audio URL parameterProvide valid audio URL array
400timelines is requiredMissing timeline parameterProvide valid timeline array
400Array length mismatchmp3_urls and timelines array lengths don't matchEnsure both arrays have the same length
400Invalid volume valueVolume not in range 0.0-2.0Use volume value between 0.0-2.0
404Audio resource not foundAudio URL inaccessibleCheck if audio URL is accessible
500Audio information generation failedInternal processing errorContact technical support

Notes

  1. Array Matching: mp3_urls and timelines array lengths must be the same
  2. Time Unit: All time parameters use microseconds (1 second = 1,000,000 microseconds)
  3. Volume Range: volume value must be between 0.0-2.0
  4. Effect Support: audio_effect needs to be a supported audio effect name
  5. JSON Format: Returned infos is a JSON string that needs to be parsed before use
  6. Network Access: Audio URLs must be accessible

Workflow

  1. Validate required parameters (mp3_urls, timelines)
  2. Check array length matching
  3. Validate timeline parameter validity
  4. Validate volume parameter range
  5. Generate corresponding audio information for each audio URL
  6. Apply volume and audio effect settings
  7. Convert information to JSON string format
  8. Return processing result

Language Switch

中文版 | English