API文档

提供完整的 RESTful API 接口。您可以通过这些接口实现 AI 能力调用。

Base URL: https://www.kaopuapi.com 需要鉴权

鉴权方式

所有请求需在 HTTP Header 中携带 Authorization 字段，格式为 Bearer Token。

HTTP Header

Authorization: Bearer sk-xxxxxxxxxxxxxxxx

生成图像

本文档介绍 /v1/platform 系列接口，支持腾讯云混元、即梦、可灵等 AIGC 模型的图像和视频生成。所有接口均以统一格式封装，屏蔽底层差异。

POST /v1/platform/image

提交一个 AI 图像生成任务。任务异步执行，接口返回 task_id，需通过查询任务接口轮询结果。

该接口生成的文件 URL 仅保留 7 天，请及时下载保存。

请求参数

Content-Type

application/json

参数名类型必选说明

model string 必选模型标识，必须以 image- 开头。格式：image-{model_name}-{version}，例如 image-kling-2.1。

prompt string 必选图像生成的正向文本描述。支持中英文，建议尽量详细描述画面内容、风格、构图等。

negative_prompt string 可选负向提示词，描述不希望在图像中出现的内容，如 模糊，低质量，水印。

enhance_prompt

string

可选

是否开启提示词自动优化增强。

enabled disabled

generation_mode string 可选生成模式，具体可选值请参考所用模型文档。例如图生图、局部重绘等。

inputs

array

可选

输入文件列表，用于参考图、风格图等场景（图生图）。

▸ inputs[i] 子字段

字段名	类型	必选	说明
url	string	必选	输入图像的公网可访问 URL。推荐使用小于 7M 的图片，支持格式：`jpeg`、`jpg`、`png`、`webp`。
text	string	可选	输入图片的描述信息，用于帮助模型理解图片内容。目前仅 GEM 2.5、GEM 3.0 有效。

output

object

可选

输出配置，控制图像分辨率、存储方式等。

▸ output 子字段

/v1/platform/images

字段名	类型	必选	说明
resolution	string	可选	生成图片的分辨率。各模型可选值： GEM 2.5 / 3.0：`1K`、`2K`、`4K`，默认 `1K` Vidu q2：`1080p`、`2K`、`4K`，默认 `1080p` Kling 2.1：`1k`、`2k`，默认 `1k` Hunyuan 3.0：`720P`、`1080P`、`2K`、`4K`
aspect_ratio	string	可选	指定所生成图片的宽高比。与 `width`/`height` 二选一，优先级高于后者。各模型可选值： GEM：`1:1`、`3:2`、`2:3`、`3:4`、`4:3`、`4:5`、`5:4`、`9:16`、`16:9`、`21:9` Qwen：暂不支持 Hunyuan：`16:9`、`9:16`、`1:1`、`4:3`、`3:4`、`3:2`、`2:3`、`21:9` Vidu：`16:9`、`9:16`、`1:1`、`3:4`、`4:3`、`21:9`、`2:3`、`3:2` Kling：`16:9`、`9:16`、`1:1`、`4:3`、`3:4`、`3:2`、`2:3`、`21:9`
width	integer	可选	输出图像宽度（像素）。与 `height` 同时指定时自动推算宽高比；若已设置 `aspect_ratio` 则忽略。
height	integer	可选	输出图像高度（像素）。与 `width` 配合使用。
media_name	string	可选	输出媒体文件名，最长 64 个字符。缺省由系统指定生成文件名。
class_id	integer	可选	分类 ID，用于对媒体进行分类管理。默认值：`0`（其他分类）。
input_compliance_check	string	可选	是否开启输入内容的合规性检查。 enableddisabled
output_compliance_check	string	可选	是否开启输出内容的合规性检查。 enableddisabled
person_generation	string	可选	是否允许人物或人脸生成。 allow_adult disallowed `allow_adult` 允许生成成人；`disallowed` 禁止在图片中包含人物或人脸。

input_region

string

可选

输入素材来源地区。

mainland oversea

session_id string 可选用于去重的识别码。如果三天内曾有过相同 session_id 的请求，则本次请求会返回错误。最长 50 个字符，不填或填空字符串表示不做去重。

session_context string 可选来源上下文，用于透传用户请求信息，任务回调时将返回该字段值，最长 1000 个字符。

ext_info object 可选保留字段，特殊用途时使用，具体格式由所用模型决定。

请求示例

JSON（文生图）

{
  "model":  "image-kling-2.1",
  "prompt": "一只可爱的橘猫坐在樱花树下，水彩画风格，高细节",
  "negative_prompt": "模糊，低质量，水印，变形",
  "enhance_prompt": "enabled",
  "output": {
    "aspect_ratio": "1:1",

  }
}

JSON（图生图）

{
  "model":  "image-jimeng-3.0",
  "prompt": "将图片改为赛博朋克霓虹灯风格",
  "generation_mode": "image_to_image",
  "inputs": [
    {
      "url": "https://example.com/source.jpg"
    }
  ],
  "output": {
    "aspect_ratio": "16:9"
  }
}

响应参数

字段名	类型	说明
task_id	string	任务唯一 ID，用于后续查询任务状态。
status	string	任务初始状态，通常为 `queued`。

响应示例

JSON · 200 OK

{
  "task_id": "img_abc123xyz456",
  "status":  "queued"
}

生成视频

POST /v1/platform/video

提交一个 AI 视频生成任务。支持文生视频、图生视频、视频续写等多种模式。任务异步执行，返回 task_id 后需通过查询任务接口轮询结果。

该接口生成的文件 URL 仅保留 7 天，请及时下载保存。

视频接口参数与图像接口高度相似，主要区别在于：model 必须以 video- 开头；inputs 中的每个输入项增加了 category、reference_type 等视频专属字段；output 增加了 duration、audio_generation 等字段。

请求参数

参数名类型必选说明

model string 必选模型标识，必须以 video- 开头。格式：video-{model_name}-{version}，例如 video-kling-2.1。

prompt string 必选视频生成的文本描述，描述画面内容、动作、风格等。

negative_prompt string 可选负向提示词，描述不希望在视频中出现的内容。

enhance_prompt

string

可选

是否开启提示词自动增强。

enableddisabled

generation_mode string 可选生成模式，例如文生视频、图生视频等，具体可选值由模型决定。

inputs

array

可选

输入文件列表，可包含参考图、参考视频或尾帧图。

▸ inputs[i] 子字段

字段名	类型	必选	说明
url	string	必选	输入素材的公网可访问 URL。推荐使用小于 10M 的图片，支持格式：`jpeg`、`jpg`、`png`。
category	string	可选	文件分类。`last_frame` 表示该 URL 作为视频尾帧（单独提取，不进入 FileInfos）。 image video last_frame
reference_type	string	可选	参考类型。GV 模型：`asset`（素材参考）、`style`（风格参考）。Kling 模型且 category 为 video 时：`feature`（特征参考视频）、`base`（待编辑视频）。
object_id	string	可选	主体 ID，适用于 Vidu-q2 模型。当需要对图片标识主体时填写，后续可通过 `@主体ID` 方式引用。当 category 为 image 时有效。
voice_id	string	可选	音色 ID，适用于 Vidu-q2 模型。当全部图片携带主体 ID 时，可针对主体设置对应音色。当 category 为 image 时有效。
keep_original_sound	string	可选	是否保留输入视频的原始音轨。当 category 为 `video` 时有效。 enableddisabled

subject_inputs

array

可选

主体参考图列表，用于固定主体的角色一致性生成（Kling / Vidu 支持）。

▸ subject_inputs[i] 子字段

字段名	类型	必选	说明
url	string	必选	主体参考图的公网可访问 URL。
id	string	可选	固定主体 ID。Kling 主体必填；Vidu 主体可选。
name	string	可选	固定主体名称。Vidu 主体必填；Kling 主体可选。

output

object

可选

输出配置，控制视频时长、音频、分辨率等。

▸ output 子字段（包含图像接口全部字段，下方为视频专属新增）

字段名	类型	必选	说明
duration	integer	可选	生成视频的时长，单位：秒。各模型可选值： Kling：`5`、`10`，默认 `5` Hailuo：`6`、`10`，默认 `6` Vidu：`1`~`10` GV：`8`，默认 `8` OS：`4`、`8`、`12`，默认 `8`
resolution	string	可选	生成视频的分辨率。各模型可选值： Kling：`720P`、`1080P`，默认 `720P` Hailuo：`768P`、`1080P`，默认 `768P` Vidu：`720P`、`1080P`，默认 `720P` GV：`720P`、`1080P`，默认 `720P` OS：`720P`
aspect_ratio	string	可选	指定所生成视频的宽高比。各模型可选值： Kling（文生视频）：`16:9`、`9:16`、`1:1`，默认 `16:9` Vidu（文生/参考图）：`16:9`、`9:16`、`4:3`、`3:4`、`1:1`（仅 q2 支持 4:3、3:4） GV：`16:9`、`9:16`，默认 `16:9` OS（文生视频）：`16:9`、`9:16`，默认 `16:9` Hailuo：暂不支持
audio_generation	string	可选	是否生成音频。支持模型：GV、OS、Vidu。默认值：`disabled`。与布尔值 `audio` 字段等效，优先使用此字段。 enableddisabled
audio	boolean	可选	`audio_generation` 的简写形式，填 `true` 等价于 `"enabled"`。若已设置 `audio_generation` 则忽略此字段。
enhance_switch	string	可选	是否启用视频增强。说明：当选择的分辨率超过模型可生成分辨率时，默认会启用增强；也可主动选择直出低分辨率后使用增强获得更高分辨率。 enableddisabled
frame_interpolate	string	可选	是否开启 Vidu 智能插帧，使视频更流畅。目前仅支持 Vidu 模型。 enableddisabled
media_name	string	可选	输出媒体文件名，最长 64 个字符。缺省由系统指定生成文件名。
class_id	integer	可选	分类 ID，用于对媒体进行分类管理。默认值：`0`（其他分类）。

scene_type

string

可选

场景类型，用于特定场景下的生成优化：

Kling：motion_control（动作控制）、avatar_i2v（数字人）、lip_sync（对口型）
Vidu：template_effect（特效模板）

input_region

string

可选

输入素材来源地区。

mainlandoversea

session_context string 可选来源上下文，用于透传用户请求信息，任务回调时将返回该字段值，最长 1000 个字符。

ext_info object 可选保留字段，特殊用途时使用，具体格式由所用模型决定。

请求示例

JSON（文生视频）

{
  "model":  "video-jimeng-3.0pro",
  "prompt": "一只猫咪在沙滩上奔跑，金色夕阳，慢动作镜头",
  "enhance_prompt": "enabled",
  "output": {
    "duration":          5,
    "aspect_ratio":     "16:9",
    "audio_generation": "enabled",
    "frame_interpolate":"enabled",

  }
}

JSON（图生视频，含首尾帧）

{
  "model":  "video-kling-2.1",
  "prompt": "镜头缓慢推进，花朵在风中轻轻摇曳",
  "inputs": [
    {
      "url":      "https://example.com/first-frame.jpg",
      "category":"image"
    },
    {
      "url":      "https://example.com/last-frame.jpg",
      "category":"last_frame"
    }
  ],
  "output": {
    "duration":     5,
    "aspect_ratio": "16:9"
  }
}

响应参数

字段名	类型	说明
task_id	string	任务唯一 ID，用于后续查询任务状态。
status	string	任务初始状态，通常为 `queued`。

查询任务状态

GET /v1/platform/tasks/{task_id}

查询图像或视频生成任务的当前状态和结果。建议以 2~5 秒为间隔进行轮询，任务通常在数秒到数分钟内完成。

只能查询当前 API Key 所提交的任务。跨 Key 查询将返回 404 TASK_NOT_FOUND。

/v1/platform/video 和 /v1/platform/image 生成的文件 URL 仅保留 7 天，请及时下载保存。

路径参数

参数名	类型	必选	说明
task_id	string	必选	提交任务时返回的 `task_id`。

响应参数

字段名类型说明

task_id string 任务 ID。

object string 对象类型，图像任务为 image_task，视频任务为 video_task。

model string 提交任务时使用的 model 字段值。

status

string

任务当前状态：

queued in_progress success failed pending

progress string 任务进度，格式为百分比字符串，例如 "50%"、"100%"。

created_at integer 任务创建时间，Unix 时间戳（秒）。

completed_at integer 任务完成时间，Unix 时间戳（秒）。仅当 status 为 success 或 failed 时存在。

result

object

生成结果，仅当 status 为 success 时存在。

▸ result 子字段

字段名	类型	说明
url	string	生成结果的主 URL（图像或视频的直链）。
urls	array<string>	所有生成结果 URL 的列表，通常与 `url` 相同。
type	string	结果类型，`image` 或 `video`。

error

object

错误信息，仅当 status 为 failed 时存在。

▸ error 子字段

字段名	类型	说明
code	string	错误代码，例如 `TASK_FAILED`。
message	string	错误详细描述。

响应示例

JSON · 任务进行中

{
  "task_id":   "vid_abc123xyz456",
  "object":    "video_task",
  "model":     "video-jimeng-3.0pro",
  "status":    "in_progress",
  "progress":  "60%",
  "created_at":1741680000
}

JSON · 任务成功

{
  "task_id":     "vid_abc123xyz456",
  "object":      "video_task",
  "model":       "video-jimeng-3.0pro",
  "status":      "success",
  "progress":    "100%",
  "created_at":  1741680000,
  "completed_at":1741680043,
  "result": {
    "url":  "https://vod-cdn.example.com/output/vid_abc123xyz456.mp4",
    "urls": ["https://vod-cdn.example.com/output/vid_abc123xyz456.mp4"],
    "type": "video"
  }
}

JSON · 任务失败

{
  "task_id":     "vid_abc123xyz456",
  "object":      "video_task",
  "model":       "video-jimeng-3.0pro",
  "status":      "failed",
  "progress":    "0%",
  "created_at":  1741680000,
  "completed_at":1741680005,
  "error": {
    "code":    "TASK_FAILED",
    "message":"内容安全检测不通过，请修改 prompt 后重试"
  }
}

获取视频内容

GET /v1/videos/{id}/content

获取已完成的视频文件内容或下载链接。

路径参数

参数名	类型	必选	说明
id	string	必选	视频任务 ID。

响应说明

返回视频文件的二进制内容或重定向到视频 URL。

AI 模型接口详细版

以下内容为 AI 模型接口说明，按“每个接口一个独立卡片”整理，包含请求参数、请求示例与 200 响应字段。

同步日期：2026-03-18。字段来自原文档 schema 自动整理；复杂对象字段按层级用 . / [] 展示。

POST /v1beta/models/{model}:generateContent

原生Gemini格式

请求参数

参数名	类型	必选	说明
model (path)	string	必选	模型名称
contents	array<object>	必选	-
contents[].parts	array<object>	可选	-
contents[].parts[].text	string	可选	-
generationConfig	object	必选	-
generationConfig.responseModalities	array<string>	必选	-
generationConfig.speechConfig	object	必选	-
generationConfig.speechConfig.voiceConfig	object	必选	-

请求示例

JSON

{
  "path": {
    "model": "string"
  },
  "body": {
    "contents": [
      {}
    ],
    "generationConfig": {
      "responseModalities": [
        "string"
      ],
      "speechConfig": {
        "voiceConfig": {
          "prebuiltVoiceConfig": {
            "voiceName": "string"
          }
        }
      }
    }
  }
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

POST /v1/audio/speech

文本转语音

请求参数

参数名	类型	必选	说明
无

请求示例

JSON

{
  "body": {
    "model": "tts-1",
    "input": "string",
    "voice": "alloy"
  }
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

POST /v1/audio/transcriptions

音频转录

请求参数

参数名	类型	必选	说明
无

请求示例

JSON

{
  "body": {
    "file": "string",
    "model": "whisper-1"
  }
}

响应字段（200）

字段名	类型	说明
file	file	p p-0 音频文件
model	string	-
language	string	p p-0 ISO-639-1 语言代码
prompt	string	-
response_format	string	-
temperature	number	-
timestamp_granularities	array<string>	-

POST /v1/audio/translations

音频翻译

请求参数

参数名	类型	必选	说明
file	string	必选	-
model	string	必选	-
prompt	string	可选	-
response_format	string	可选	-
temperature	number	可选	-

请求示例

JSON

{
  "body": {
    "file": "string",
    "model": "string"
  }
}

响应字段（200）

字段名	类型	说明
file	file	-
model	string	-
prompt	string	-
response_format	string	-
temperature	number	-

POST /v1/messages

原生Claude格式

请求参数

参数名	类型	必选	说明
anthropic-version (header)	string	必选	Anthropic API 版本
x-api-key (header)	string	可选	Anthropic API Key (可选，也可使用 Bearer Token)
model	string	必选	-
messages	array<object>	必选	-
messages[].role	string	必选	-
messages[].content	string \| array<object>	必选	-
system	string \| array<object>	可选	-
max_tokens	integer	必选	-
temperature	number	可选	-
top_p	number	可选	-
top_k	integer	可选	-
stream	boolean	可选	-
stop_sequences	array<string>	可选	-
tools	array<object>	可选	-
tools[].name	string	可选	-
tools[].description	string	可选	-
tools[].input_schema	object	可选	-
tool_choice	object	可选	-
thinking	object	可选	-
thinking.type	string	可选	-
thinking.budget_tokens	integer	可选	-
metadata	object	可选	-
metadata.user_id	string	可选	-

请求示例

JSON

{
  "header": {
    "anthropic-version": "2023-06-01"
  },
  "body": {
    "model": "claude-3-opus-20240229",
    "messages": [
      {
        "role": "user",
        "content": "string"
      }
    ],
    "max_tokens": 1
  }
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

POST /v1beta/models/{model}:generateContent

Gemini文本聊天

请求参数

参数名	类型	必选	说明
model (path)	string	必选	模型名称
contents	array<object>	可选	-
contents[].role	string	可选	-
contents[].parts	array<object>	可选	-
contents[].parts[].text	string	可选	-
contents[].parts[].inlineData	object	可选	-
generationConfig	object	可选	-
generationConfig.temperature	number	可选	-
generationConfig.topP	number	可选	-
generationConfig.topK	integer	可选	-
generationConfig.maxOutputTokens	integer	可选	-
generationConfig.stopSequences	array<string>	可选	-
safetySettings	array<object>	可选	-
safetySettings[].category	string	可选	-
safetySettings[].threshold	string	可选	-
tools	array<object>	可选	-
systemInstruction	object	可选	-
systemInstruction.parts	array<object>	可选	-

请求示例

JSON

{
  "path": {
    "model": "string"
  },
  "body": {}
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

POST /v1beta/models/{model}:generateContent

Gemini媒体识别

请求参数

参数名	类型	必选	说明
model (path)	string	必选	模型名称
contents	array<object>	可选	-
contents[].role	string	可选	-
contents[].parts	array<object>	可选	-
contents[].parts[].text	string	可选	-
contents[].parts[].inlineData	object	可选	-
generationConfig	object	可选	-
generationConfig.temperature	number	可选	-
generationConfig.topP	number	可选	-
generationConfig.topK	integer	可选	-
generationConfig.maxOutputTokens	integer	可选	-
generationConfig.stopSequences	array<string>	可选	-
safetySettings	array<object>	可选	-
safetySettings[].category	string	可选	-
safetySettings[].threshold	string	可选	-
tools	array<object>	可选	-
systemInstruction	object	可选	-
systemInstruction.parts	array<object>	可选	-

请求示例

JSON

{
  "path": {
    "model": "string"
  },
  "body": {}
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

POST /v1/chat/completions

ChatCompletions格式

请求参数

参数名	类型	必选	说明
model	string	必选	模型 ID
messages	array<object>	必选	对话消息列表
messages[].role	string	必选	消息角色
messages[].content	string \| array<object>	必选	消息内容
messages[].name	string	可选	发送者名称
messages[].tool_calls	array<object>	可选	-
messages[].tool_calls[].id	string	可选	-
messages[].tool_calls[].type	string	可选	-
messages[].tool_calls[].function	object	可选	-
messages[].tool_call_id	string	可选	工具调用 ID（用于 tool 角色消息）
messages[].reasoning_content	string	可选	推理内容
temperature	number	可选	采样温度
top_p	number	可选	核采样参数
n	integer	可选	生成数量
stream	boolean	可选	是否流式响应
stream_options	object	可选	-
stream_options.include_usage	boolean	可选	-
stop	string \| array<string>	可选	停止序列
max_tokens	integer	可选	最大生成 Token 数
max_completion_tokens	integer	可选	最大补全 Token 数
presence_penalty	number	可选	-
frequency_penalty	number	可选	-
logit_bias	object	可选	-
user	string	可选	-
tools	array<object>	可选	-
tools[].type	string	可选	-
tools[].function	object	可选	-
tools[].function.name	string	可选	-
tools[].function.description	string	可选	-
tools[].function.parameters	object	可选	JSON Schema 格式的参数定义
tool_choice	string \| object	可选	-
response_format	object	可选	-
response_format.type	string	可选	-
response_format.json_schema	object	可选	JSON Schema 定义
seed	integer	可选	-
reasoning_effort	string	可选	推理强度 (用于支持推理的模型)
modalities	array<string>	可选	-
audio	object	可选	-
audio.voice	string	可选	-
audio.format	string	可选	-

请求示例

JSON

{
  "body": {
    "model": "gpt-4",
    "messages": [
      {
        "role": "system",
        "content": "string"
      }
    ]
  }
}

响应字段（200）

字段名	类型	说明
model	string	p p-0 模型 ID
messages	array<object>	p p-0 对话消息列表
messages[].role	string	p p-0 消息角色
messages[].content	string \| array<object>	p p-0 消息内容
messages[].name	string	p p-0 发送者名称
messages[].tool_calls	array<object>	-
messages[].tool_calls[].id	string	-
messages[].tool_calls[].type	string	-
messages[].tool_calls[].function	object	-
messages[].tool_call_id	string	p p-0 工具调用 ID（用于 tool 角色消息）
messages[].reasoning_content	string	p p-0 推理内容
temperature	number	p p-0 采样温度
top_p	number	p p-0 核采样参数
n	integer	p p-0 生成数量
stream	boolean	p p-0 是否流式响应
stream_options	object	-
stream_options.include_usage	boolean	-
stop	string \| array<string>	p p-0 停止序列
max_tokens	integer	p p-0 最大生成 Token 数
max_completion_tokens	integer	p p-0 最大补全 Token 数
presence_penalty	number	-
frequency_penalty	number	-
logit_bias	object	-
logit_bias.[key: string]	number	-
user	string	-
tools	array<object>	-
tools[].type	string	-
tools[].function	object	-
tools[].function.name	string	-
tools[].function.description	string	-
tools[].function.parameters	object	p p-0 JSON Schema 格式的参数定义
tool_choice	string \| object	-
response_format	object	-
response_format.type	string	-
response_format.json_schema	object	p p-0 JSON Schema 定义
seed	integer	-
reasoning_effort	string	p p-0 推理强度 (用于支持推理的模型)
modalities	array<string>	-
audio	object	-
audio.voice	string	-
audio.format	string	-

POST /v1/responses

Responses格式

请求参数

参数名	类型	必选	说明
model	string	必选	-
input	string \| array<object>	可选	输入内容，可以是字符串或消息数组
instructions	string	可选	-
max_output_tokens	integer	可选	-
temperature	number	可选	-
top_p	number	可选	-
stream	boolean	可选	-
tools	array<object>	可选	-
tool_choice	string \| object	可选	-
reasoning	object	可选	-
reasoning.effort	string	可选	-
reasoning.summary	string	可选	-
previous_response_id	string	可选	-
truncation	string	可选	-

请求示例

JSON

{
  "body": {
    "model": "string"
  }
}

响应字段（200）

字段名	类型	说明
model	string	-
input	string \| array<object>	p p-0 输入内容，可以是字符串或消息数组
instructions	string	-
max_output_tokens	integer	-
temperature	number	-
top_p	number	-
stream	boolean	-
tools	array<object>	-
tool_choice	string \| object	-
reasoning	object	-
reasoning.effort	string	-
reasoning.summary	string	-
previous_response_id	string	-
truncation	string	-

POST /v1/completions

原生OpenAI格式

请求参数

参数名	类型	必选	说明
model	string	必选	-
prompt	string \| array<string>	必选	-
max_tokens	integer	可选	-
temperature	number	可选	-
top_p	number	可选	-
n	integer	可选	-
stream	boolean	可选	-
stop	string \| array<string>	可选	-
suffix	string	可选	-
echo	boolean	可选	-

请求示例

JSON

{
  "body": {
    "model": "string",
    "prompt": "string"
  }
}

响应字段（200）

字段名	类型	说明
model	string	-
prompt	string \| array<string>	-
max_tokens	integer	-
temperature	number	-
top_p	number	-
n	integer	-
stream	boolean	-
stop	string \| array<string>	-
suffix	string	-
echo	boolean	-

POST /v1/embeddings

原生OpenAI格式

请求参数

参数名	类型	必选	说明
无

请求示例

JSON

{
  "body": {
    "model": "text-embedding-ada-002",
    "input": "string"
  }
}

响应字段（200）

字段名	类型	说明
model	string	-
input	string \| array<string>	p p-0 要嵌入的文本
encoding_format	string	-
dimensions	integer	p p-0 输出向量维度

POST /v1/engines/{model}/embeddings

原生Gemini格式

请求参数

参数名	类型	必选	说明
model (path)	string	必选	模型/引擎 ID
model	string	必选	-
input	string \| array<string>	必选	要嵌入的文本
encoding_format	string	可选	-
dimensions	integer	可选	输出向量维度

请求示例

JSON

{
  "path": {
    "model": "string"
  },
  "body": {
    "model": "text-embedding-ada-002",
    "input": "string"
  }
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

POST /v1beta/models/{model}:generateContent/

Gemini原生格式

请求参数

参数名	类型	必选	说明
model (path)	string	必选	模型名称
contents	array<object>	必选	-
contents[].role	string	可选	-
contents[].parts	array<object>	可选	-
contents[].parts[].text	string	可选	-
generationConfig	object	必选	-
generationConfig.thinkingConfig	object	可选	-
generationConfig.thinkingConfig.includeThoughts	boolean	必选	是否返回思考内容
generationConfig.responseModalities	array<string>	必选	-
generationConfig.imageConfig	object	必选	-
generationConfig.imageConfig.aspectRatio	string	必选	-
generationConfig.imageConfig.imageSize	string	必选	-

请求示例

JSON

{
  "path": {
    "model": "string"
  },
  "body": {
    "contents": [
      {}
    ],
    "generationConfig": {
      "responseModalities": [
        "string"
      ],
      "imageConfig": {
        "aspectRatio": "string",
        "imageSize": "string"
      }
    }
  }
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

POST /v1/chat/completions

OpenAI聊天格式

请求参数

参数名	类型	必选	说明
model	string	必选	-
stream	boolean	必选	-
messages	array<object>	必选	-
messages[].role	string	可选	-
messages[].content	string	可选	-
extra_body	object	可选	-
extra_body.google	object	必选	-
extra_body.google.image_config	object	必选	-
contents	array<object>	必选	-
contents[].role	string	可选	-
contents[].parts	array<object>	可选	-
contents[].parts[].text	string	可选	-

请求示例

JSON

{
  "body": {
    "model": "string",
    "stream": true,
    "messages": [
      {}
    ],
    "contents": [
      {}
    ]
  }
}

响应字段（200）

字段名	类型	说明
model	string	-
stream	boolean	-
messages	array<object>	-
messages[].role	string	-
messages[].content	string	-
extra_body	object	-
extra_body.google	object	-
extra_body.google.image_config	object	-
contents	array<object>	-
contents[].role	string	-
contents[].parts	array<object>	-
contents[].parts[].text	string	-

POST /v1/images/edits/

编辑图像

请求参数

参数名	类型	必选	说明
image	file	必选	p p-0 要编辑的图像。必须是有效的 PNG 文件，小于 4MB，并且是方形的。如果未提供遮罩，图像必须具有透明度，将用作遮罩。
mask	file	可选	p p-0 附加图像，其完全透明区域（例如，alpha 为零的区域）指示image应编辑的位置。必须是有效的 PNG 文件，小于 4MB，并且尺寸与原始image相同。
prompt	string	必选	p p-0 所需图像的文本描述。最大长度为 1000 个字符。
n	string	可选	p p-0 要生成的图像数。必须介于 1 和 10 之间。
size	string	可选	p p-0 生成图像的大小。必须是 code code-0 256x256 、 code code-1 512x512 或 code code-2 1024x1024 之一。
response_format	string	可选	p p-0 生成的图像返回的格式。必须是 code code-0 url 或 code code-1 b64_json 。
user	string	可选	p p-0 代表您的最终用户的唯一标识符，可以帮助 OpenAI 监控和检测滥用行为。 a-0 了解更多。
model	string	必选	-

请求示例

JSON

curl -L -X POST 'https://www.kaopuapi.com/v1/images/edits' \
  -H 'Authorization: Bearer sk-47YdoiwPu5flGqZLkhDLX9w4cNnHMpC6bljJ8HbuZEHl1jqN' \
  -F 'image=@/test/cat.jpg' \
  -F 'image=@/test/dog.jpg' \
  -F 'prompt=让图片一把图片二举过头顶，背景在草地上' \
  -F 'n=1' \
  -F 'model=gpt-image-2' \
  -F 'quality=low'

响应字段（200）

字段名	类型	说明

POST /v1/images/generations/

生成图像

请求参数

参数名	类型	必选	说明
model	string	可选	用于图像生成的模型。`dall-e-2`、`dall-e-3` 或 `gpt-image-1` 之一。默认为 `dall-e-2`，除非使用特定于 `gpt-image-1` 的参数。
prompt	string	必选	所需图像的文本描述。`gpt-image-1` 的最大长度为 32000 个字符，`dall-e-2` 的最大长度为 1000 个字符，`dall-e-3` 的最大长度为 4000 个字符。
n	integer	可选	要生成的图像数量。必须介于 1 到 10 之间。对于 `dall-e-3`，仅支持 `n=1`。
size	string	可选	生成的图像的大小。`对于 gpt-image-1`，必须是 `1024x1024`、`1536x1024`（横向）、`1024x1536`（纵向）或`自动`（默认值）之一，`对于 dall-e-2`，必须是 `256x256、``512x512` 或 `1024x1024` 之一，对于 `dall-e-3`，必须是 `1024x1024`、`1792x1024` 或 `1024x1792` 之一。
background	string	可选	允许为生成的图像的背景设置透明度。此参数仅支持 `gpt-image-1`。必须是以下之一 `透明`、`不透明`或`自动`（默认值）。使用`自动`时，模型将自动确定图像的最佳背景。如果`是透明`的，则输出格式需要支持透明度，因此应将其设置为 `png`（默认值）或 `webp`。
moderation	string	可选	控制 `gpt-image-1` 生成的图像的内容审核级别。必须为`低，` 以进行限制较少的筛选或`自动`（默认值）。
quality	string	可选	将生成的图像的质量。
stream	string	可选	-
style	string	可选	-
user	string	可选	-

请求示例

JSON

{
  "body": {
    "prompt": "string"
  }
}

响应字段（200）

字段名	类型	说明
model	string	p p-0 用于图像生成的模型。 code code-0 dall-e-2 、 code code-1 dall-e-3 或 code code-2 gpt-image-1 之一。默认为 code code-3 dall-e-2 ，除非使用特定于 code code-4 gpt-image-1 的参数。
prompt	string	p p-0 所需图像的文本描述。 code code-0 gpt-image-1 的最大长度为 32000 个字符， code code-1 dall-e-2 的最大长度为 1000 个字符， code code-2 dall-e-3 的最大长度为 4000 个字符。
n	integer	p p-0 要生成的图像数量。必须介于 1 到 10 之间。对于 code code-0 dall-e-3 ，仅支持 code code-1 n=1 。
size	string	p p-0 生成的图像的大小。 code code-0 对于 gpt-image-1 ，必须是 code code-1 1024x1024 、 code code-2 1536x1024 （横向）、 code code-3 1024x1536 （纵向）或 code code-4 自动（默认值）之一， code code-5 对于 dall-e-2 ，必须是 code code-6 256x256、``512x512 或 code code-7 1024x1024 之一，对于 code code-8 dall-e-3 ，必须是 code code-9 1024x1024 、 code code-10 1792x1024 或 code code-11 1024x1792 之一。
background	string	p p-0 允许为生成的图像的背景设置透明度。此参数仅支持 code code-0 gpt-image-1 。必须是以下之一 code code-1 透明、 code code-2 不透明或 code code-3 自动（默认值）。使用 code code-4 自动时，模型将自动确定图像的最佳背景。 p p-1 如果 code code-0 是透明的，则输出格式需要支持透明度，因此应将其设置为 code code-1 png （默认值）或 code code-2 webp 。
moderation	string	p p-0 控制 code code-0 gpt-image-1 生成的图像的内容审核级别。必须为 code code-1 低，以进行限制较少的筛选或 code code-2 自动（默认值）。
quality	string	p p-0 将生成的图像的质量。
stream	string	-
style	string	-
user	string	-

POST /v1/images/generations

生成图像

请求参数

参数名	类型	必选	说明
model	string	必选	-
input	object	必选	-
input.messages	array<object>	必选	-
input.messages[].role	string	可选	-
input.messages[].content	array<object>	可选	-
parameters	object	可选	-
parameters.negative_prompt	string	可选	-
parameters.prompt_extend	boolean	可选	-
parameters.watermark	boolean	可选	-
parameters.size	string	可选	-

请求示例

JSON

{
  "body": {
    "model": "string",
    "input": {
      "messages": [
        {}
      ]
    }
  }
}

响应字段（200）

字段名	类型	说明
model	string	-
input	object	-
input.messages	array<object>	-
input.messages[].role	string	-
input.messages[].content	array<object>	-
parameters	object	-
parameters.negative_prompt	string	-
parameters.prompt_extend	boolean	-
parameters.watermark	boolean	-
parameters.size	string	-

POST /v1/images/edits

编辑图像

请求参数

参数名	类型	必选	说明
model	string	必选	-
input	object	必选	-
input.messages	array<object>	必选	-
input.messages[].role	string	可选	-
input.messages[].content	array<object>	可选	-
parameters	object	可选	-
parameters.n	integer	可选	-
parameters.negative_prompt	string	可选	-
parameters.prompt_extend	boolean	可选	-
parameters.watermark	boolean	可选	-
parameters.size	string	可选	-

请求示例

JSON

{
  "body": {
    "model": "string",
    "input": {
      "messages": [
        {}
      ]
    }
  }
}

响应字段（200）

字段名	类型	说明
model	string	-
input	object	-
input.messages	array<object>	-
input.messages[].role	string	-
input.messages[].content	array<object>	-
parameters	object	-
parameters.n	integer	-
parameters.negative_prompt	string	-
parameters.prompt_extend	boolean	-
parameters.watermark	boolean	-
parameters.size	string	-

GET /v1/models

原生OpenAI格式

请求参数

参数名	类型	必选	说明
key (query)	string	可选	Google API Key (用于 Gemini 格式)
x-api-key (header)	string	可选	Anthropic API Key (用于 Claude 格式)
anthropic-version (header)	string	可选	Anthropic API 版本
x-goog-api-key (header)	string	可选	Google API Key (用于 Gemini 格式)

请求示例

JSON

{
  "path": {},
  "cookie": {},
  "header": {},
  "query": {},
  "method": "GET"
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

GET /v1beta/models

原生Gemini格式

请求参数

参数名	类型	必选	说明
无

请求示例

JSON

{
  "path": {},
  "cookie": {},
  "header": {},
  "query": {},
  "method": "GET"
}

响应字段（200）

字段名	类型	说明
models	array<object>	-
models[].name	string	-
models[].version	string	-
models[].displayName	string	-
models[].description	string	-
models[].inputTokenLimit	integer	-
models[].outputTokenLimit	integer	-
models[].supportedGenerationMethods	array<string>	-

POST /v1/moderations

原生OpenAI格式

请求参数

参数名	类型	必选	说明
input	string \| array<string>	必选	-
model	string	可选	-

请求示例

JSON

{
  "body": {
    "input": "string"
  }
}

响应字段（200）

字段名	类型	说明
input	string \| array<string>	-
model	string	-

GET /v1/realtime

原生OpenAI格式

请求参数

参数名	类型	必选	说明
model (query)	string	可选	要使用的模型

请求示例

JSON

{
  "path": {},
  "cookie": {},
  "header": {},
  "query": {},
  "method": "GET"
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

POST /v1/rerank

文档重排序

请求参数

参数名	类型	必选	说明
model	string	必选	-
query	string	必选	查询文本
documents	array<string \| object>	必选	要重排序的文档列表
top_n	integer	可选	返回前 N 个结果
return_documents	boolean	可选	-

请求示例

JSON

{
  "body": {
    "model": "rerank-english-v2.0",
    "query": "string",
    "documents": [
      "string"
    ]
  }
}

响应字段（200）

字段名	类型	说明
model	string	-
query	string	p p-0 查询文本
documents	array<string \| object>	p p-0 要重排序的文档列表
top_n	integer	p p-0 返回前 N 个结果
return_documents	boolean	-

POST /v1/files

上传文件 (未实现)

请求参数

参数名	类型	必选	说明
file	string	可选	-
purpose	string	可选	-

请求示例

JSON

{
  "body": {}
}

响应字段（200）

字段名	类型	说明
file	file	-
purpose	string	-

DELETE /v1/files/{file_id}

删除文件 (未实现)

请求参数

参数名	类型	必选	说明
file_id (path)	string	必选	-

请求示例

JSON

{
  "path": {
    "file_id": "string"
  }
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

GET /v1/files/{file_id}/content

获取文件内容 (未实现)

请求参数

参数名	类型	必选	说明
file_id (path)	string	必选	-

请求示例

JSON

{
  "path": {
    "file_id": "string"
  }
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

GET /v1/files

列出文件 (未实现)

请求参数

参数名	类型	必选	说明
无

请求示例

JSON

{
  "path": {},
  "cookie": {},
  "header": {},
  "query": {},
  "method": "GET"
}

响应字段（200）

字段名	类型	说明
error	object	-
error.message	string	p p-0 错误信息
error.type	string	p p-0 错误类型
error.param	string \| null	p p-0 相关参数
error.code	string \| null	p p-0 错误代码

GET /v1/files/{file_id}

获取文件信息 (未实现)

请求参数

参数名	类型	必选	说明
file_id (path)	string	必选	-

请求示例

JSON

{
  "path": {
    "file_id": "string"
  }
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

POST /v1/fine-tunes/{fine_tune_id}/cancel

取消微调任务 (未实现)

请求参数

参数名	类型	必选	说明
fine_tune_id (path)	string	必选	-

请求示例

JSON

{
  "path": {
    "fine_tune_id": "string"
  }
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

POST /v1/fine-tunes

创建微调任务 (未实现)

请求参数

参数名	类型	必选	说明
无

请求示例

JSON

{
  "body": {}
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

GET /v1/fine-tunes/{fine_tune_id}/events

获取微调任务事件 (未实现)

请求参数

参数名	类型	必选	说明
fine_tune_id (path)	string	必选	-

请求示例

JSON

{
  "path": {
    "fine_tune_id": "string"
  }
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

GET /v1/fine-tunes

列出微调任务 (未实现)

请求参数

参数名	类型	必选	说明
无

请求示例

JSON

{
  "path": {},
  "cookie": {},
  "header": {},
  "query": {},
  "method": "GET"
}

响应字段（200）

字段名	类型	说明
error	object	-
error.message	string	p p-0 错误信息
error.type	string	p p-0 错误类型
error.param	string \| null	p p-0 相关参数
error.code	string \| null	p p-0 错误代码

GET /v1/fine-tunes/{fine_tune_id}

获取微调任务详情 (未实现)

请求参数

参数名	类型	必选	说明
fine_tune_id (path)	string	必选	-

请求示例

JSON

{
  "path": {
    "fine_tune_id": "string"
  }
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

POST /v1/video/generations

创建视频生成任务

请求参数

参数名	类型	必选	说明
model	string	可选	模型/风格 ID
prompt	string	可选	文本描述提示词
image	string	可选	图片输入 (URL 或 Base64)
duration	number	可选	视频时长（秒）
width	integer	可选	视频宽度
height	integer	可选	视频高度
fps	integer	可选	视频帧率
seed	integer	可选	随机种子
n	integer	可选	生成视频数量
response_format	string	可选	响应格式
user	string	可选	用户标识
metadata	object	可选	扩展参数 (如 negative_prompt, style, quality_level 等)

请求示例

JSON

{
  "body": {}
}

响应字段（200）

字段名	类型	说明
model	string	p p-0 模型/风格 ID
prompt	string	p p-0 文本描述提示词
image	string	p p-0 图片输入 (URL 或 Base64)
duration	number	p p-0 视频时长（秒）
width	integer	p p-0 视频宽度
height	integer	p p-0 视频高度
fps	integer	p p-0 视频帧率
seed	integer	p p-0 随机种子
n	integer	p p-0 生成视频数量
response_format	string	p p-0 响应格式
user	string	p p-0 用户标识
metadata	object	p p-0 扩展参数 (如 negative_prompt, style, quality_level 等)
metadata.[key: string]	any	-

GET /v1/video/generations/{task_id}

获取视频生成任务状态

请求参数

参数名	类型	必选	说明
task_id (path)	string	必选	任务 ID

请求示例

JSON

{
  "path": {
    "task_id": "string"
  }
}

响应字段（200）

字段名	类型	说明
task_id	string	p p-0 任务 ID
status	string	p p-0 任务状态
url	string	p p-0 视频资源 URL（成功时）
format	string	p p-0 视频格式
metadata	object	p p-0 视频任务元数据
metadata.duration	number	p p-0 实际生成的视频时长
metadata.fps	integer	p p-0 实际帧率
metadata.width	integer	p p-0 实际宽度
metadata.height	integer	p p-0 实际高度
metadata.seed	integer	p p-0 使用的随机种子
error	object	p p-0 视频任务错误信息
error.code	integer	p p-0 错误码
error.message	string	p p-0 错误信息

POST /jimeng/

即梦视频生成

请求参数

参数名	类型	必选	说明
Action (query)	string	必选	API 操作类型
Version (query)	string	必选	API 版本
req_key	string	可选	请求类型标识
prompt	string	可选	文本描述
binary_data_base64	array<string>	可选	Base64 编码的图片数据

请求示例

JSON

{
  "query": {
    "Action": "CVSync2AsyncSubmitTask",
    "Version": "string"
  },
  "body": {}
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

POST /kling/v1/videos/image2video

Kling 图生视频

请求参数

参数名	类型	必选	说明
model	string	可选	模型/风格 ID
prompt	string	可选	文本描述提示词
image	string	可选	图片输入 (URL 或 Base64)
duration	number	可选	视频时长（秒）
width	integer	可选	视频宽度
height	integer	可选	视频高度
fps	integer	可选	视频帧率
seed	integer	可选	随机种子
n	integer	可选	生成视频数量
response_format	string	可选	响应格式
user	string	可选	用户标识
metadata	object	可选	扩展参数 (如 negative_prompt, style, quality_level 等)

请求示例

JSON

{
  "body": {}
}

响应字段（200）

字段名	类型	说明
model	string	p p-0 模型/风格 ID
prompt	string	p p-0 文本描述提示词
image	string	p p-0 图片输入 (URL 或 Base64)
duration	number	p p-0 视频时长（秒）
width	integer	p p-0 视频宽度
height	integer	p p-0 视频高度
fps	integer	p p-0 视频帧率
seed	integer	p p-0 随机种子
n	integer	p p-0 生成视频数量
response_format	string	p p-0 响应格式
user	string	p p-0 用户标识
metadata	object	p p-0 扩展参数 (如 negative_prompt, style, quality_level 等)
metadata.[key: string]	any	-

POST /kling/v1/videos/text2video

Kling 文生视频

请求参数

参数名	类型	必选	说明
model	string	可选	模型/风格 ID
prompt	string	可选	文本描述提示词
image	string	可选	图片输入 (URL 或 Base64)
duration	number	可选	视频时长（秒）
width	integer	可选	视频宽度
height	integer	可选	视频高度
fps	integer	可选	视频帧率
seed	integer	可选	随机种子
n	integer	可选	生成视频数量
response_format	string	可选	响应格式
user	string	可选	用户标识
metadata	object	可选	扩展参数 (如 negative_prompt, style, quality_level 等)

请求示例

JSON

{
  "body": {}
}

响应字段（200）

字段名	类型	说明
model	string	p p-0 模型/风格 ID
prompt	string	p p-0 文本描述提示词
image	string	p p-0 图片输入 (URL 或 Base64)
duration	number	p p-0 视频时长（秒）
width	integer	p p-0 视频宽度
height	integer	p p-0 视频高度
fps	integer	p p-0 视频帧率
seed	integer	p p-0 随机种子
n	integer	p p-0 生成视频数量
response_format	string	p p-0 响应格式
user	string	p p-0 用户标识
metadata	object	p p-0 扩展参数 (如 negative_prompt, style, quality_level 等)
metadata.[key: string]	any	-

GET /kling/v1/videos/image2video/{task_id}

获取 Kling 图生视频任务状态

请求参数

参数名	类型	必选	说明
task_id (path)	string	必选	任务 ID

请求示例

JSON

{
  "path": {
    "task_id": "string"
  }
}

响应字段（200）

字段名	类型	说明
task_id	string	p p-0 任务 ID
status	string	p p-0 任务状态
url	string	p p-0 视频资源 URL（成功时）
format	string	p p-0 视频格式
metadata	object	p p-0 视频任务元数据
metadata.duration	number	p p-0 实际生成的视频时长
metadata.fps	integer	p p-0 实际帧率
metadata.width	integer	p p-0 实际宽度
metadata.height	integer	p p-0 实际高度
metadata.seed	integer	p p-0 使用的随机种子
error	object	p p-0 视频任务错误信息
error.code	integer	p p-0 错误码
error.message	string	p p-0 错误信息

GET /kling/v1/videos/text2video/{task_id}

获取 Kling 文生视频任务状态

请求参数

参数名	类型	必选	说明
task_id (path)	string	必选	任务 ID

请求示例

JSON

{
  "path": {
    "task_id": "string"
  }
}

响应字段（200）

字段名	类型	说明
task_id	string	p p-0 任务 ID
status	string	p p-0 任务状态
url	string	p p-0 视频资源 URL（成功时）
format	string	p p-0 视频格式
metadata	object	p p-0 视频任务元数据
metadata.duration	number	p p-0 实际生成的视频时长
metadata.fps	integer	p p-0 实际帧率
metadata.width	integer	p p-0 实际宽度
metadata.height	integer	p p-0 实际高度
metadata.seed	integer	p p-0 使用的随机种子
error	object	p p-0 视频任务错误信息
error.code	integer	p p-0 错误码
error.message	string	p p-0 错误信息

POST /v1/videos

创建视频

请求参数

参数名	类型	必选	说明
model	string	可选	模型/风格 ID
prompt	string	可选	文本描述提示词
image	string	可选	图片输入 (URL 或 Base64)
duration	number	可选	视频时长（秒）
width	integer	可选	视频宽度
height	integer	可选	视频高度
fps	integer	可选	视频帧率
seed	integer	可选	随机种子
n	integer	可选	生成视频数量
response_format	string	可选	响应格式
user	string	可选	用户标识
metadata	object	可选	扩展参数 (如 negative_prompt, style, quality_level 等)

请求示例

JSON

{
  "body": {}
}

响应字段（200）

字段名	类型	说明
model	string	p p-0 模型/风格 ID
prompt	string	p p-0 文本描述提示词
image	string	p p-0 图片输入 (URL 或 Base64)
duration	number	p p-0 视频时长（秒）
width	integer	p p-0 视频宽度
height	integer	p p-0 视频高度
fps	integer	p p-0 视频帧率
seed	integer	p p-0 随机种子
n	integer	p p-0 生成视频数量
response_format	string	p p-0 响应格式
user	string	p p-0 用户标识
metadata	object	p p-0 扩展参数 (如 negative_prompt, style, quality_level 等)
metadata.[key: string]	any	-

GET /v1/videos/{task_id}

获取视频任务状态

请求参数

参数名	类型	必选	说明
task_id (path)	string	必选	视频任务 ID

请求示例

JSON

{
  "path": {
    "task_id": "string"
  }
}

响应字段（200）

字段名	类型	说明
id	string	-
object	string	-
model	string	-
status	string	-
progress	integer	-
created_at	integer	-
seconds	string	-

GET /v1/videos/{task_id}/content

获取视频内容

请求参数

参数名	类型	必选	说明
task_id (path)	string	必选	视频任务 ID

请求示例

JSON

{
  "path": {
    "task_id": "string"
  }
}

响应字段（200）

字段名	类型	说明
无结构化响应字段（可能为二进制或无响应体）

系统

GET /api/models

获取模型列表。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

OAuth

GET /api/user/oauth/bindings

获取当前用户OAuth绑定。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

DELETE /api/user/oauth/bindings/{provider_id}

解绑OAuth。

Path 参数

参数名	类型	必选	说明
provider_id	string	必选

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

用户管理

GET /api/user/self/groups

获取当前用户分组。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

GET /api/user/self

获取当前用户信息。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

PUT /api/user/self

更新当前用户信息。

请求参数

参数名	类型	必选
username	string	可选
display_name	string	可选
password	string	可选
original_password	string	可选

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

GET /api/user/models

获取用户可用模型。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

GET /api/user/token

生成访问令牌。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

GET /api/user/passkey

获取Passkey状态。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

DELETE /api/user/passkey

删除Passkey。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

POST /api/user/passkey/register/begin

开始注册Passkey。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

POST /api/user/passkey/register/finish

完成注册Passkey。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

POST /api/user/passkey/verify/begin

开始验证Passkey。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

POST /api/user/passkey/verify/finish

完成验证Passkey。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

GET /api/user/aff

获取邀请码。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

POST /api/user/aff_transfer

转换邀请额度。

请求参数

参数名	类型	必选	说明
quota	integer	可选

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

PUT /api/user/setting

更新用户设置。

请求参数

参数名	类型	必选
notify_type	string	可选
quota_warning_threshold	number	可选
webhook_url	string	可选
notification_email	string	可选

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

两步验证

GET /api/user/2fa/status

获取2FA状态。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

POST /api/user/2fa/setup

设置2FA。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

POST /api/user/2fa/enable

启用2FA。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

POST /api/user/2fa/disable

禁用2FA。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

POST /api/user/2fa/backup_codes

生成备用码。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

安全验证

GET /api/verify/status

获取验证状态。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

令牌管理

GET /api/token/

获取所有令牌。

Query 参数

参数名	类型	必选	说明
p	integer	可选
page_size	integer	可选

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

POST /api/token/

创建令牌。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

PUT /api/token/

更新令牌。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

GET /api/token/search

搜索令牌。

Query 参数

参数名	类型	必选	说明
keyword	string	可选

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

GET /api/token/{id}

获取指定令牌。

Path 参数

参数名	类型	必选	说明
id	integer	必选

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

DELETE /api/token/{id}

删除令牌。

Path 参数

参数名	类型	必选	说明
id	integer	必选

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

POST /api/token/batch

批量操作令牌。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

GET /api/usage/token/

用量查询。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

日志

GET /api/log/self/stat

获取个人日志统计。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

GET /api/log/self

获取个人日志。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

GET /api/log/self/search

搜索个人日志。

Query 参数

参数名	类型	必选	说明
keyword	string	可选

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

数据统计

GET /api/data/self

获取个人额度数据。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

任务

GET /api/mj/self

获取个人Midjourney任务。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

GET /api/task/self

获取个人任务。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

GET /api/subscription/self

获取当前订阅。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

PUT /api/subscription/self/preference

更新订阅偏好。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

POST /api/subscription/alipay/pay

订阅支付宝支付。

响应字段（200）

字段名	类型	说明
success	boolean	是否成功
message	string	提示信息
data	any	返回数据

任务状态说明

状态值	含义	建议操作
`queued`	任务已提交，等待调度执行。	继续轮询。
`in_progress`	任务正在执行中，可参考 `progress` 字段了解进度。	继续轮询，建议间隔 2~5 秒。
`success`	任务已完成，结果在 `result` 字段中。	读取 `result.url` 下载或展示结果。
`failed`	任务执行失败，具体原因见 `error.message`。	根据错误信息排查，修正参数后重新提交。
`pending`	任务状态待确认（过渡状态）。	继续轮询。

HTTP 错误码说明

HTTP 状态码	error.code	说明
400	`INVALID_REQUEST`	请求参数有误，例如 `model` 或 `prompt` 缺失，model 格式不正确。
401	`—`	Authorization 头缺失或 Token 无效。
404	`TASK_NOT_FOUND`	task_id 不存在，或该任务不属于当前 API Key。
500	`INTERNAL_ERROR`	服务器内部错误，可稍后重试。

错误响应格式统一为：{ "error": { "code": "...", "message": "..." } }