Base URLs:

Authentication

HTTP Authentication, scheme: bearer
使用 Bearer Token 认证。
格式: Authorization: Bearer sk-xxxxxx

HTTP Authentication, scheme: bearer

模型（Models）/列出模型

GET 原生OpenAI格式

GET /v1/models

获取当前可用的模型列表。

根据请求头自动识别返回格式：

包含 x-api-key 和 anthropic-version 头时返回 Anthropic 格式

包含 x-goog-api-key 头或 key 查询参数时返回 Gemini 格式

其他情况返回 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 格式)

返回示例

200 Response

{
  "object": "list",
  "data": [
    {
      "id": "gpt-4",
      "object": "model",
      "created": 0,
      "owned_by": "openai"
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功获取模型列表	ModelsResponse
401	Unauthorized	认证失败	ErrorResponse

GET 原生Gemini格式

GET /v1beta/models

以 Gemini API 格式返回可用模型列表

返回示例

200 Response

{
  "models": [
    {
      "name": "models/gemini-pro",
      "version": "string",
      "displayName": "string",
      "description": "string",
      "inputTokenLimit": 0,
      "outputTokenLimit": 0,
      "supportedGenerationMethods": [
        "string"
      ]
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功获取模型列表	GeminiModelsResponse

聊天（Chat）

POST 原生Claude格式

POST /v1/messages

Anthropic Claude Messages API 格式的请求。
需要在请求头中包含 anthropic-version。

Body 请求参数

{
  "model": "claude-3-opus-20240229",
  "messages": [
    {
      "role": "user",
      "content": "string"
    }
  ],
  "system": "string",
  "max_tokens": 1,
  "temperature": 1,
  "top_p": 0,
  "top_k": 0,
  "stream": true,
  "stop_sequences": [
    "string"
  ],
  "tools": [
    {
      "name": "string",
      "description": "string",
      "input_schema": {}
    }
  ],
  "tool_choice": {
    "type": "auto",
    "name": "string"
  },
  "thinking": {
    "type": "enabled",
    "budget_tokens": 0
  },
  "metadata": {
    "user_id": "string"
  }
}

请求参数

名称	位置	类型	必选	说明
anthropic-version	header	string	是	Anthropic API 版本
x-api-key	header	string	否	Anthropic API Key (可选，也可使用 Bearer Token)
body	body	ClaudeRequest	否	none

返回示例

200 Response

{
  "id": "string",
  "type": "message",
  "role": "assistant",
  "content": [
    {
      "type": "string",
      "text": "string"
    }
  ],
  "model": "string",
  "stop_reason": "end_turn",
  "usage": {
    "input_tokens": 0,
    "output_tokens": 0,
    "cache_creation_input_tokens": 0,
    "cache_read_input_tokens": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功创建响应	ClaudeResponse

聊天（Chat）/原生OpenAI格式

POST Responses格式

POST /v1/responses

OpenAI Responses API，用于创建模型响应。
支持多轮对话、工具调用、推理等功能。

Body 请求参数

{
  "model": "string",
  "input": "string",
  "instructions": "string",
  "max_output_tokens": 0,
  "temperature": 0,
  "top_p": 0,
  "stream": true,
  "tools": [
    {}
  ],
  "tool_choice": "string",
  "reasoning": {
    "effort": "low",
    "summary": "string"
  },
  "previous_response_id": "string",
  "truncation": "auto"
}

请求参数

名称	位置	类型	必选	说明
body	body	ResponsesRequest	是	none

返回示例

200 Response

{
  "id": "string",
  "object": "response",
  "created_at": 0,
  "status": "completed",
  "model": "string",
  "output": [
    {
      "type": "string",
      "id": "string",
      "status": "string",
      "role": "string",
      "content": [
        {
          "type": "string",
          "text": "string"
        }
      ]
    }
  ],
  "usage": {
    "prompt_tokens": 0,
    "completion_tokens": 0,
    "total_tokens": 0,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "text_tokens": 0,
      "audio_tokens": 0,
      "image_tokens": 0
    },
    "completion_tokens_details": {
      "text_tokens": 0,
      "audio_tokens": 0,
      "reasoning_tokens": 0
    }
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功创建响应	ResponsesResponse

图像（Images）/原生OpenAI格式

POST 生成图像

POST /v1/images/generations/

在给定提示的情况下创建图像。了解更多。

Body 请求参数

{
  "model": "gpt-image-1",
  "prompt": "A cute baby sea otter",
  "n": 1,
  "size": "1024x1024"
}

请求参数

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

详细说明

» background: 允许为生成的图像的背景设置透明度。此参数仅支持 gpt-image-1。必须是以下之一 透明、不透明或自动（默认值）。使用自动时，模型将自动确定图像的最佳背景。

如果是透明的，则输出格式需要支持透明度，因此应将其设置为 png（默认值）或 webp。

返回示例

200 Response

{
  "created": 1713833628,
  "data": [
    {
      "b64_json": "..."
    }
  ],
  "usage": {
    "total_tokens": 100,
    "input_tokens": 50,
    "output_tokens": 50,
    "input_tokens_details": {
      "text_tokens": 10,
      "image_tokens": 40
    }
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» created	integer	true	none	none
» data	[object]	true	none	none
»» b64_json	string	false	none	none
»» url	string	true	none	none
» usage	object	true	none	none
»» total_tokens	integer	true	none	none
»» input_tokens	integer	true	none	none
»» output_tokens	integer	true	none	none
»» input_tokens_details	object	true	none	none
»»» text_tokens	integer	true	none	none
»»» image_tokens	integer	true	none	none

POST 编辑图像

POST /v1/images/edits/

在给定原始图像和提示的情况下创建编辑或扩展图像。

Body 请求参数

请求参数

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

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

返回数据结构

图像（Images）/通义千问格式

POST 生成图像

POST /v1/images/generations

百炼qwen-image系列图片生成

Body 请求参数

{
  "model": "qwen-image-plus",
  "input": {
    "messages": [
      {
        "role": "user",
        "content": [
          {
            "text": "一副典雅庄重的对联悬挂于厅堂之中，房间是个安静古典的中式布置，桌子上放着一些青花瓷，对联上左书“义本生知人机同道善思新”，右书“通云赋智乾坤启数高志远”， 横批“智启通义”，字体飘逸，在中间挂着一幅中国风的画作，内容是岳阳楼。"
          }
        ]
      }
    ]
  },
  "parameters": {
    "negative_prompt": "",
    "prompt_extend": true,
    "watermark": false,
    "size": "1328*1328"
  }
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» model	body	string	是	none
» input	body	object	是	none
»» messages	body	[object]	是	none
»»» role	body	string	否	none
»»» content	body	[object]	否	none
»»»» text	body	string	否	none
» parameters	body	object	否	none
»» negative_prompt	body	string	否	none
»» prompt_extend	body	boolean	否	none
»» watermark	body	boolean	否	none
»» size	body	string	否	none

返回示例

200 Response

{
  "created": 0,
  "data": [
    {
      "url": "string",
      "b64_json": "string",
      "revised_prompt": "string"
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功生成图像	ImageResponse

POST 编辑图像

POST /v1/images/edits

百炼qwen-image系列图片编辑

Body 请求参数

"{\n    \"model\": \"qwen-image-edit-plus\",\n    \"input\": {\n        \"messages\": [\n            {\n                \"role\": \"user\",\n                \"content\": [\n                    {\n                        \"image\": \"https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20250925/fpakfo/image36.webp\"\n                    },\n                    {\n                        \"text\": \"生成一张符合深度图的图像，遵循以下描述：一辆红色的破旧的自行车停在一条泥泞的小路上，背景是茂密的原始森林\"\n                    }\n                ]\n            }\n        ]\n    },\n    \"parameters\": {\n        \"n\": 2,\n        \"negative_prompt\": \" \",\n        \"prompt_extend\": true,\n        \"watermark\": false\n    }"

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» model	body	string	是	none
» input	body	object	是	none
»» messages	body	[object]	是	none
»»» role	body	string	否	none
»»» content	body	[object]	否	none
»»»» image	body	string	否	none
»»»» text	body	string	否	none
» parameters	body	object	否	none
»» n	body	integer	否	none
»» negative_prompt	body	string	否	none
»» prompt_extend	body	boolean	否	none
»» watermark	body	boolean	否	none
»» size	body	string	否	none

返回示例

200 Response

{
  "created": 0,
  "data": [
    {
      "url": "string",
      "b64_json": "string",
      "revised_prompt": "string"
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功生成图像	ImageResponse

图像（Images）/Nano Banana

POST Gemini原生格式

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

Gemini 图片生成

Body 请求参数

{
  "contents": [
    {
      "role": "user",
      "parts": [
        {
          "text": "draw a cat"
        }
      ]
    }
  ],
  "generationConfig": {
    "responseModalities": [
      "TEXT",
      "IMAGE"
    ],
    "imageConfig": {
      "aspectRatio": "16:9",
      "imageSize": "4K"
    }
  }
}

请求参数

名称	位置	类型	必选	说明
model	path	string	是	模型名称
body	body	object	否	none
» contents	body	[object]	是	none
»» role	body	string	否	none
»» parts	body	[object]	否	none
»»» text	body	string	否	none
» generationConfig	body	object	是	none
»» thinkingConfig	body	object	否	none
»»» includeThoughts	body	boolean	是	是否返回思考内容
»» responseModalities	body	[string]	是	none
»» imageConfig	body	object	是	none
»»» aspectRatio	body	string	是	none
»»» imageSize	body	string	是	none

返回示例

200 Response

{
  "candidates": [
    {
      "content": {
        "role": "string",
        "parts": [
          {}
        ]
      },
      "finishReason": "string",
      "safetyRatings": [
        {}
      ]
    }
  ],
  "usageMetadata": {
    "promptTokenCount": 0,
    "candidatesTokenCount": 0,
    "totalTokenCount": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	GeminiResponse

视频（Videos）

POST 创建视频生成任务

POST /v1/video/generations

提交视频生成任务，支持文生视频和图生视频。

返回任务 ID，可通过 GET 接口查询任务状态。

Body 请求参数

{
  "model": "kling-v1",
  "prompt": "宇航员在月球上漫步",
  "duration": 5,
  "width": 1280,
  "height": 720
}

请求参数

名称	位置	类型	必选	说明
body	body	VideoRequest	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功创建视频生成任务	VideoResponse
400	Bad Request	请求参数错误	ErrorResponse

GET 获取视频生成任务状态

GET /v1/video/generations/{task_id}

查询视频生成任务的状态和结果。

任务状态：

queued: 排队中

in_progress: 生成中

completed: 已完成

failed: 失败

请求参数

名称	位置	类型	必选	说明
task_id	path	string	是	任务 ID

返回示例

200 Response

{
  "task_id": "abcd1234efgh",
  "status": "completed",
  "url": "https://example.com/video.mp4",
  "format": "mp4",
  "metadata": {
    "duration": 5,
    "fps": 30,
    "width": 1280,
    "height": 720,
    "seed": 20231234
  },
  "error": {
    "code": 0,
    "message": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功获取任务状态	VideoTaskResponse
404	Not Found	任务不存在	ErrorResponse

视频（Videos）/Sora格式

POST 创建视频

POST /v1/videos

OpenAI 兼容的视频生成接口。

参考文档: https://platform.openai.com/docs/api-reference/videos/create

Body 请求参数

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» model	body	string	否	模型名称
» prompt	body	string	否	提示词
» seconds	body	string	否	生成秒数
» input_reference	body	string(binary)	否	参考图片文件

返回示例

200 Response

{
  "id": "sora-2-123456",
  "object": "video",
  "model": "sora-2",
  "status": "queued",
  "progress": 0,
  "created_at": 1764347090922,
  "seconds": "8"
}

400 Response

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功创建视频任务	Inline
400	Bad Request	请求参数错误	ErrorResponse

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» id	string	true	none	视频 ID
» object	string	true	none	对象类型
» model	string	true	none	使用的模型
» status	string	true	none	任务状态
» progress	integer	true	none	进度百分比
» created_at	integer	true	none	创建时间戳
» seconds	string	true	none	视频时长
» completed_at	integer	false	none	完成时间戳
» expires_at	integer	false	none	过期时间戳
» size	string	false	none	视频尺寸
» error	OpenAIVideoError	false	none	OpenAI 视频错误信息
»» message	string	false	none	错误信息
»» code	string	false	none	错误码
» metadata	object	false	none	额外元数据

状态码 400

名称	类型	必选	约束	说明
» error	object	false	none	none
»» message	string	false	none	错误信息
»» type	string	false	none	错误类型
»» param	string¦null	false	none	相关参数
»» code	string¦null	false	none	错误代码

GET 获取视频任务状态

GET /v1/videos/{task_id}

OpenAI 兼容的视频任务状态查询接口。

返回视频任务的详细状态信息。

请求参数

名称	位置	类型	必选	说明
task_id	path	string	是	视频任务 ID

返回示例

200 Response

{
  "id": "sora-2-123456",
  "object": "video",
  "model": "sora-2",
  "status": "queued",
  "progress": 0,
  "created_at": 1764347090922,
  "seconds": "8"
}

404 Response

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功获取视频任务状态	Inline
404	Not Found	任务不存在	ErrorResponse

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» id	string	true	none	none
» object	string	true	none	none
» model	string	true	none	none
» status	string	true	none	none
» progress	integer	true	none	none
» created_at	integer	true	none	none
» seconds	string	true	none	none

状态码 404

名称	类型	必选	约束	说明
» error	object	false	none	none
»» message	string	false	none	错误信息
»» type	string	false	none	错误类型
»» param	string¦null	false	none	相关参数
»» code	string¦null	false	none	错误代码

GET 获取视频内容

GET /v1/videos/{task_id}/content

获取已完成视频任务的视频文件内容。

此接口会代理返回视频文件流。

请求参数

名称	位置	类型	必选	说明
task_id	path	string	是	视频任务 ID

返回示例

200 Response

404 Response

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功获取视频内容	string
404	Not Found	视频不存在或未完成	ErrorResponse

视频（Videos）/可灵格式

POST Kling 文生视频

POST /kling/v1/videos/text2video

使用 Kling 模型从文本描述生成视频。

支持的模型：kling-v1, kling-v1-5 等

Body 请求参数

{
  "model": "kling-v1",
  "prompt": "宇航员站起身走了",
  "duration": 5,
  "width": 1280,
  "height": 720,
  "fps": 30
}

请求参数

名称	位置	类型	必选	说明
body	body	VideoRequest	否	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功创建视频生成任务	VideoResponse
400	Bad Request	请求参数错误	ErrorResponse

GET 获取 Kling 文生视频任务状态

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

查询 Kling 文生视频任务的状态和结果。

请求参数

名称	位置	类型	必选	说明
task_id	path	string	是	任务 ID

返回示例

200 Response

{
  "task_id": "abcd1234efgh",
  "status": "completed",
  "url": "https://example.com/video.mp4",
  "format": "mp4",
  "metadata": {
    "duration": 5,
    "fps": 30,
    "width": 1280,
    "height": 720,
    "seed": 20231234
  },
  "error": {
    "code": 0,
    "message": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功获取任务状态	VideoTaskResponse
404	Not Found	任务不存在	ErrorResponse

POST Kling 图生视频

POST /kling/v1/videos/image2video

使用 Kling 模型从图片生成视频。

支持通过 image 参数传入图片 URL 或 Base64 编码的图片数据。

Body 请求参数

{
  "model": "kling-v1",
  "prompt": "人物转身走开",
  "image": "https://example.com/image.jpg",
  "duration": 5,
  "width": 1280,
  "height": 720
}

请求参数

名称	位置	类型	必选	说明
body	body	VideoRequest	否	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功创建视频生成任务	VideoResponse
400	Bad Request	请求参数错误	ErrorResponse

GET 获取 Kling 图生视频任务状态

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

查询 Kling 图生视频任务的状态和结果。

请求参数

名称	位置	类型	必选	说明
task_id	path	string	是	任务 ID

返回示例

200 Response

{
  "task_id": "abcd1234efgh",
  "status": "completed",
  "url": "https://example.com/video.mp4",
  "format": "mp4",
  "metadata": {
    "duration": 5,
    "fps": 30,
    "width": 1280,
    "height": 720,
    "seed": 20231234
  },
  "error": {
    "code": 0,
    "message": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功获取任务状态	VideoTaskResponse
404	Not Found	任务不存在	ErrorResponse

视频（Videos）/即梦格式

POST 即梦视频生成

POST /jimeng/

即梦官方 API 格式的视频生成接口。

支持通过 Action 参数指定操作类型：

CVSync2AsyncSubmitTask: 提交视频生成任务

CVSync2AsyncGetResult: 获取任务结果

需要在查询参数中指定 Action 和 Version。

Body 请求参数

{
  "req_key": "jimeng_video_generation",
  "prompt": "一只猫在弹钢琴"
}

请求参数

名称	位置	类型	必选	说明
Action	query	string	是	API 操作类型
Version	query	string	是	API 版本
body	body	object	否	none
» req_key	body	string	否	请求类型标识
» prompt	body	string	否	文本描述
» binary_data_base64	body	[string]	否	Base64 编码的图片数据

枚举值

属性	值
Action	CVSync2AsyncSubmitTask
Action	CVSync2AsyncGetResult

返回示例

200 Response

{
  "code": 0,
  "message": "string",
  "data": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功处理请求	Inline
400	Bad Request	请求参数错误	ErrorResponse

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	响应码
» message	string	false	none	响应消息
» data	object	false	none	响应数据

状态码 400

名称	类型	必选	约束	说明
» error	object	false	none	none
»» message	string	false	none	错误信息
»» type	string	false	none	错误类型
»» param	string¦null	false	none	相关参数
»» code	string¦null	false	none	错误代码

嵌入（Embeddings）

POST 原生OpenAI格式

POST /v1/embeddings

将文本转换为向量嵌入

Body 请求参数

{
  "model": "text-embedding-ada-002",
  "input": "string",
  "encoding_format": "float",
  "dimensions": 0
}

请求参数

名称	位置	类型	必选	说明
body	body	EmbeddingRequest	是	none

返回示例

200 Response

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [
        0
      ]
    }
  ],
  "model": "string",
  "usage": {
    "prompt_tokens": 0,
    "total_tokens": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功创建嵌入	EmbeddingResponse

POST 原生Gemini格式

POST /v1/engines/{model}/embeddings

使用指定引擎/模型创建嵌入

Body 请求参数

{
  "model": "text-embedding-ada-002",
  "input": "string",
  "encoding_format": "float",
  "dimensions": 0
}

请求参数

名称	位置	类型	必选	说明
model	path	string	是	模型/引擎 ID
body	body	EmbeddingRequest	否	none

返回示例

200 Response

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [
        0
      ]
    }
  ],
  "model": "string",
  "usage": {
    "prompt_tokens": 0,
    "total_tokens": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功创建嵌入	EmbeddingResponse

补全（Completions）

POST 原生OpenAI格式

POST /v1/completions

基于给定提示创建文本补全

Body 请求参数

{
  "model": "string",
  "prompt": "string",
  "max_tokens": 0,
  "temperature": 0,
  "top_p": 0,
  "n": 0,
  "stream": true,
  "stop": "string",
  "suffix": "string",
  "echo": true
}

请求参数

名称	位置	类型	必选	说明
body	body	CompletionRequest	是	none

返回示例

200 Response

{
  "id": "string",
  "object": "text_completion",
  "created": 0,
  "model": "string",
  "choices": [
    {
      "text": "string",
      "index": 0,
      "finish_reason": "string"
    }
  ],
  "usage": {
    "prompt_tokens": 0,
    "completion_tokens": 0,
    "total_tokens": 0,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "text_tokens": 0,
      "audio_tokens": 0,
      "image_tokens": 0
    },
    "completion_tokens_details": {
      "text_tokens": 0,
      "audio_tokens": 0,
      "reasoning_tokens": 0
    }
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功创建响应	CompletionResponse

音频（Audio）

POST 原生Gemini格式

POST /v1beta/models/{model}:generateContent

Gemini 音频生成接口。
可使用gemini-2.5-flash-preview-tts等模型

Body 请求参数

{
  "contents": [
    {
      "parts": [
        {
          "text": "Say cheerfully: Have a wonderful day!"
        }
      ]
    }
  ],
  "generationConfig": {
    "responseModalities": [
      "AUDIO"
    ],
    "speechConfig": {
      "voiceConfig": {
        "prebuiltVoiceConfig": {
          "voiceName": "Kore"
        }
      }
    }
  }
}

请求参数

名称	位置	类型	必选	说明
model	path	string	是	模型名称
body	body	object	否	none
» contents	body	[object]	是	none
»» parts	body	[object]	否	none
»»» text	body	string	否	none
» generationConfig	body	object	是	none
»» responseModalities	body	[string]	是	none
»» speechConfig	body	object	是	none
»»» voiceConfig	body	object	是	none
»»»» prebuiltVoiceConfig	body	object	是	none
»»»»» voiceName	body	string	是	none

返回示例

200 Response

{
  "candidates": [
    {
      "content": {
        "role": "string",
        "parts": [
          {}
        ]
      },
      "finishReason": "string",
      "safetyRatings": [
        {}
      ]
    }
  ],
  "usageMetadata": {
    "promptTokenCount": 0,
    "candidatesTokenCount": 0,
    "totalTokenCount": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	GeminiResponse

音频（Audio）/原生OpenAI格式

POST 音频转录

POST /v1/audio/transcriptions

将音频转换为文本

Body 请求参数

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» file	body	string(binary)	是	音频文件
» model	body	string	是	none
» language	body	string	否	ISO-639-1 语言代码
» prompt	body	string	否	none
» response_format	body	string	否	none
» temperature	body	number	否	none
» timestamp_granularities	body	[string]	否	none

枚举值

属性	值
» response_format	json
» response_format	text
» response_format	srt
» response_format	verbose_json
» response_format	vtt
» timestamp_granularities	word
» timestamp_granularities	segment

返回示例

200 Response

{
  "text": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功转录	AudioTranscriptionResponse

POST 音频翻译

POST /v1/audio/translations

将音频翻译为英文文本

Body 请求参数

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» file	body	string(binary)	是	none
» model	body	string	是	none
» prompt	body	string	否	none
» response_format	body	string	否	none
» temperature	body	number	否	none

返回示例

200 Response

{
  "text": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功翻译	AudioTranscriptionResponse

POST 文本转语音

POST /v1/audio/speech

将文本转换为音频

Body 请求参数

{
  "model": "tts-1",
  "input": "string",
  "voice": "alloy",
  "response_format": "mp3",
  "speed": 1
}

请求参数

名称	位置	类型	必选	说明
body	body	SpeechRequest	是	none

返回示例

200 Response

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功生成音频	string

实时语音（Realtime）

GET 原生OpenAI格式

GET /v1/realtime

建立 WebSocket 连接用于实时对话。

注意: 这是一个 WebSocket 端点，需要使用 WebSocket 协议连接。

连接 URL 示例: wss://api.example.com/v1/realtime?model=gpt-4o-realtime

请求参数

名称	位置	类型	必选	说明
model	query	string	否	要使用的模型

返回示例

400 Response

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
101	Switching Protocols	WebSocket 协议切换	None
400	Bad Request	请求错误	ErrorResponse

重排序（Rerank）

POST 文档重排序

POST /v1/rerank

根据查询对文档列表进行相关性重排序

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	RerankRequest	是	none

返回示例

200 Response

{
  "id": "string",
  "results": [
    {
      "index": 0,
      "relevance_score": 0,
      "document": {}
    }
  ],
  "meta": {}
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功重排序	RerankResponse

审查（Moderations）

POST 原生OpenAI格式

POST /v1/moderations

检查文本内容是否违反使用政策

Body 请求参数

{
  "input": "string",
  "model": "text-moderation-latest"
}

请求参数

名称	位置	类型	必选	说明
body	body	ModerationRequest	是	none

返回示例

200 Response

{
  "id": "string",
  "model": "string",
  "results": [
    {
      "flagged": true,
      "categories": {},
      "category_scores": {}
    }
  ]
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功审核	ModerationResponse

未实现（Unimplemented）/微调（Fine-tuning）

GET 列出微调任务 (未实现)

GET /v1/fine-tunes

此接口尚未实现

返回示例

501 Response

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
501	Not Implemented	未实现	ErrorResponse

POST 创建微调任务 (未实现)

POST /v1/fine-tunes

此接口尚未实现

Body 请求参数

{}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none

返回示例

501 Response

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
501	Not Implemented	未实现	ErrorResponse

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

GET /v1/fine-tunes/{fine_tune_id}

此接口尚未实现

请求参数

名称	位置	类型	必选	说明
fine_tune_id	path	string	是	none

返回示例

501 Response

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
501	Not Implemented	未实现	ErrorResponse

POST 取消微调任务 (未实现)

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

此接口尚未实现

请求参数

名称	位置	类型	必选	说明
fine_tune_id	path	string	是	none

返回示例

501 Response

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
501	Not Implemented	未实现	ErrorResponse

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

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

此接口尚未实现

请求参数

名称	位置	类型	必选	说明
fine_tune_id	path	string	是	none

返回示例

501 Response

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
501	Not Implemented	未实现	ErrorResponse

未实现（Unimplemented）/文件（Files）

GET 列出文件 (未实现)

GET /v1/files

此接口尚未实现

返回示例

501 Response

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
501	Not Implemented	未实现	ErrorResponse

POST 上传文件 (未实现)

POST /v1/files

此接口尚未实现

Body 请求参数

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» file	body	string(binary)	否	none
» purpose	body	string	否	none

返回示例

501 Response

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
501	Not Implemented	未实现	ErrorResponse

GET 获取文件信息 (未实现)

GET /v1/files/{file_id}

此接口尚未实现

请求参数

名称	位置	类型	必选	说明
file_id	path	string	是	none

返回示例

501 Response

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
501	Not Implemented	未实现	ErrorResponse

DELETE 删除文件 (未实现)

DELETE /v1/files/{file_id}

此接口尚未实现

请求参数

名称	位置	类型	必选	说明
file_id	path	string	是	none

返回示例

501 Response

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
501	Not Implemented	未实现	ErrorResponse

GET 获取文件内容 (未实现)

GET /v1/files/{file_id}/content

此接口尚未实现

请求参数

名称	位置	类型	必选	说明
file_id	path	string	是	none

返回示例

501 Response

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

返回结果

状态码	状态码含义	说明	数据模型
501	Not Implemented	未实现	ErrorResponse

数据模型

Model

{
  "id": "gpt-4",
  "object": "model",
  "created": 0,
  "owned_by": "openai"
}

属性

名称	类型	必选	约束	说明
id	string	false	none	模型 ID
object	string	false	none	对象类型
created	integer	false	none	创建时间戳
owned_by	string	false	none	模型所有者

Usage

{
  "prompt_tokens": 0,
  "completion_tokens": 0,
  "total_tokens": 0,
  "prompt_tokens_details": {
    "cached_tokens": 0,
    "text_tokens": 0,
    "audio_tokens": 0,
    "image_tokens": 0
  },
  "completion_tokens_details": {
    "text_tokens": 0,
    "audio_tokens": 0,
    "reasoning_tokens": 0
  }
}

属性

名称	类型	必选	约束	说明
prompt_tokens	integer	false	none	提示词 Token 数
completion_tokens	integer	false	none	补全 Token 数
total_tokens	integer	false	none	总 Token 数
prompt_tokens_details	object	false	none	none
» cached_tokens	integer	false	none	none
» text_tokens	integer	false	none	none
» audio_tokens	integer	false	none	none
» image_tokens	integer	false	none	none
completion_tokens_details	object	false	none	none
» text_tokens	integer	false	none	none
» audio_tokens	integer	false	none	none
» reasoning_tokens	integer	false	none	none

ModelsResponse

{
  "object": "list",
  "data": [
    {
      "id": "gpt-4",
      "object": "model",
      "created": 0,
      "owned_by": "openai"
    }
  ]
}

属性

名称	类型	必选	约束	中文名	说明
object	string	false	none		none
data	[Model]	false	none		none

ErrorResponse

{
  "error": {
    "message": "string",
    "type": "string",
    "param": "string",
    "code": "string"
  }
}

属性

名称	类型	必选	约束	说明
error	object	false	none	none
» message	string	false	none	错误信息
» type	string	false	none	错误类型
» param	string¦null	false	none	相关参数
» code	string¦null	false	none	错误代码

Message

{
  "role": "system",
  "content": "string",
  "name": "string",
  "tool_calls": [
    {
      "id": "string",
      "type": "function",
      "function": {
        "name": "string",
        "arguments": "string"
      }
    }
  ],
  "tool_call_id": "string",
  "reasoning_content": "string"
}

属性

名称	类型	必选	约束	中文名	说明
role	string	true	none		消息角色
content	any	true	none		消息内容

oneOf

名称	类型	必选	约束	中文名	说明
» anonymous	string	false	none		none

xor

名称	类型	必选	约束	中文名	说明
» anonymous	[MessageContent]	false	none		none

continued

名称	类型	必选	约束	说明
name	string	false	none	发送者名称
tool_calls	[ToolCall]	false	none	none
tool_call_id	string	false	none	工具调用 ID（用于 tool 角色消息）
reasoning_content	string	false	none	推理内容

枚举值

属性	值
role	system
role	user
role	assistant
role	tool
role	developer

MessageContent

{
  "type": "text",
  "text": "string",
  "image_url": {
    "url": "string",
    "detail": "low"
  },
  "input_audio": {
    "data": "string",
    "format": "wav"
  },
  "file": {
    "filename": "string",
    "file_data": "string",
    "file_id": "string"
  },
  "video_url": {
    "url": "string"
  }
}

属性

名称	类型	必选	约束	说明
type	string	false	none	none
text	string	false	none	none
image_url	object	false	none	none
» url	string	false	none	图片 URL 或 base64
» detail	string	false	none	none
input_audio	object	false	none	none
» data	string	false	none	Base64 编码的音频数据
» format	string	false	none	none
file	object	false	none	none
» filename	string	false	none	none
» file_data	string	false	none	none
» file_id	string	false	none	none
video_url	object	false	none	none
» url	string	false	none	none

枚举值

属性	值
type	text
type	image_url
type	input_audio
type	file
type	video_url
detail	low
detail	high
detail	auto
format	wav
format	mp3

Tool

{
  "type": "function",
  "function": {
    "name": "string",
    "description": "string",
    "parameters": {}
  }
}

属性

名称	类型	必选	约束	说明
type	string	false	none	none
function	object	false	none	none
» name	string	false	none	none
» description	string	false	none	none
» parameters	object	false	none	JSON Schema 格式的参数定义

ToolCall

{
  "id": "string",
  "type": "function",
  "function": {
    "name": "string",
    "arguments": "string"
  }
}

属性

名称	类型	必选	约束	说明
id	string	false	none	none
type	string	false	none	none
function	object	false	none	none
» name	string	false	none	none
» arguments	string	false	none	none

GeminiModelsResponse

{
  "models": [
    {
      "name": "models/gemini-pro",
      "version": "string",
      "displayName": "string",
      "description": "string",
      "inputTokenLimit": 0,
      "outputTokenLimit": 0,
      "supportedGenerationMethods": [
        "string"
      ]
    }
  ]
}

属性

名称	类型	必选	约束	说明
models	[object]	false	none	none
» name	string	false	none	none
» version	string	false	none	none
» displayName	string	false	none	none
» description	string	false	none	none
» inputTokenLimit	integer	false	none	none
» outputTokenLimit	integer	false	none	none
» supportedGenerationMethods	[string]	false	none	none

ChatCompletionResponse

{
  "id": "string",
  "object": "chat.completion",
  "created": 0,
  "model": "string",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "system",
        "content": "string",
        "name": "string",
        "tool_calls": [
          {
            "id": null,
            "type": null,
            "function": null
          }
        ],
        "tool_call_id": "string",
        "reasoning_content": "string"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 0,
    "completion_tokens": 0,
    "total_tokens": 0,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "text_tokens": 0,
      "audio_tokens": 0,
      "image_tokens": 0
    },
    "completion_tokens_details": {
      "text_tokens": 0,
      "audio_tokens": 0,
      "reasoning_tokens": 0
    }
  },
  "system_fingerprint": "string"
}

属性

名称	类型	必选	约束	说明
id	string	false	none	none
object	string	false	none	none
created	integer	false	none	none
model	string	false	none	none
choices	[object]	false	none	none
» index	integer	false	none	none
» message	Message	false	none	none
» finish_reason	string	false	none	none
usage	Usage	false	none	none
system_fingerprint	string	false	none	none

枚举值

属性	值
finish_reason	stop
finish_reason	length
finish_reason	tool_calls
finish_reason	content_filter

ChatCompletionRequest

{
  "model": "gpt-4",
  "messages": [
    {
      "role": "system",
      "content": "string",
      "name": "string",
      "tool_calls": [
        {
          "id": "string",
          "type": "function",
          "function": {
            "name": null,
            "arguments": null
          }
        }
      ],
      "tool_call_id": "string",
      "reasoning_content": "string"
    }
  ],
  "temperature": 1,
  "top_p": 1,
  "n": 1,
  "stream": false,
  "stream_options": {
    "include_usage": true
  },
  "stop": "string",
  "max_tokens": 0,
  "max_completion_tokens": 0,
  "presence_penalty": 0,
  "frequency_penalty": 0,
  "logit_bias": {
    "property1": 0,
    "property2": 0
  },
  "user": "string",
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "string",
        "description": "string",
        "parameters": {}
      }
    }
  ],
  "tool_choice": "none",
  "response_format": {
    "type": "text",
    "json_schema": {}
  },
  "seed": 0,
  "reasoning_effort": "low",
  "modalities": [
    "text"
  ],
  "audio": {
    "voice": "string",
    "format": "string"
  }
}

属性

名称	类型	必选	约束	说明
model	string	true	none	模型 ID
messages	[Message]	true	none	对话消息列表
temperature	number	false	none	采样温度
top_p	number	false	none	核采样参数
n	integer	false	none	生成数量
stream	boolean	false	none	是否流式响应
stream_options	object	false	none	none
» include_usage	boolean	false	none	none
stop	any	false	none	停止序列

oneOf

名称	类型	必选	约束	中文名	说明
» anonymous	string	false	none		none

xor

名称	类型	必选	约束	中文名	说明
» anonymous	[string]	false	none		none

continued

名称	类型	必选	约束	说明
max_tokens	integer	false	none	最大生成 Token 数
max_completion_tokens	integer	false	none	最大补全 Token 数
presence_penalty	number	false	none	none
frequency_penalty	number	false	none	none
logit_bias	object	false	none	none
» additionalProperties	number	false	none	none
user	string	false	none	none
tools	[Tool]	false	none	none
tool_choice	any	false	none	none

oneOf

名称	类型	必选	约束	中文名	说明
» anonymous	string	false	none		none

xor

名称	类型	必选	约束	说明
» anonymous	object	false	none	none
»» type	string	false	none	none
»» function	object	false	none	none
»»» name	string	false	none	none

continued

名称	类型	必选	约束	说明
response_format	ResponseFormat	false	none	none
seed	integer	false	none	none
reasoning_effort	string	false	none	推理强度 (用于支持推理的模型)
modalities	[string]	false	none	none
audio	object	false	none	none
» voice	string	false	none	none
» format	string	false	none	none

枚举值

属性	值
anonymous	none
anonymous	auto
anonymous	required
reasoning_effort	low
reasoning_effort	medium
reasoning_effort	high

CompletionRequest

{
  "model": "string",
  "prompt": "string",
  "max_tokens": 0,
  "temperature": 0,
  "top_p": 0,
  "n": 0,
  "stream": true,
  "stop": "string",
  "suffix": "string",
  "echo": true
}

属性

名称	类型	必选	约束	中文名	说明
model	string	true	none		none
prompt	any	true	none		none

oneOf

名称	类型	必选	约束	中文名	说明
» anonymous	string	false	none		none

xor

名称	类型	必选	约束	中文名	说明
» anonymous	[string]	false	none		none

continued

名称	类型	必选	约束	说明
max_tokens	integer	false	none	none
temperature	number	false	none	none
top_p	number	false	none	none
n	integer	false	none	none
stream	boolean	false	none	none
stop	any	false	none	none

oneOf

名称	类型	必选	约束	中文名	说明
» anonymous	string	false	none		none

xor

名称	类型	必选	约束	中文名	说明
» anonymous	[string]	false	none		none

continued

名称	类型	必选	约束	中文名	说明
suffix	string	false	none		none
echo	boolean	false	none		none

CompletionResponse

{
  "id": "string",
  "object": "text_completion",
  "created": 0,
  "model": "string",
  "choices": [
    {
      "text": "string",
      "index": 0,
      "finish_reason": "string"
    }
  ],
  "usage": {
    "prompt_tokens": 0,
    "completion_tokens": 0,
    "total_tokens": 0,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "text_tokens": 0,
      "audio_tokens": 0,
      "image_tokens": 0
    },
    "completion_tokens_details": {
      "text_tokens": 0,
      "audio_tokens": 0,
      "reasoning_tokens": 0
    }
  }
}

属性

名称	类型	必选	约束	说明
id	string	false	none	none
object	string	false	none	none
created	integer	false	none	none
model	string	false	none	none
choices	[object]	false	none	none
» text	string	false	none	none
» index	integer	false	none	none
» finish_reason	string	false	none	none
usage	Usage	false	none	none

ResponseFormat

{
  "type": "text",
  "json_schema": {}
}

属性

名称	类型	必选	约束	中文名	说明
type	string	false	none		none
json_schema	object	false	none		JSON Schema 定义

枚举值

属性	值
type	text
type	json_object
type	json_schema

ResponsesRequest

{
  "model": "string",
  "input": "string",
  "instructions": "string",
  "max_output_tokens": 0,
  "temperature": 0,
  "top_p": 0,
  "stream": true,
  "tools": [
    {}
  ],
  "tool_choice": "string",
  "reasoning": {
    "effort": "low",
    "summary": "string"
  },
  "previous_response_id": "string",
  "truncation": "auto"
}

属性

名称	类型	必选	约束	中文名	说明
model	string	true	none		none
input	any	false	none		输入内容，可以是字符串或消息数组

oneOf

名称	类型	必选	约束	中文名	说明
» anonymous	string	false	none		none

xor

名称	类型	必选	约束	中文名	说明
» anonymous	[object]	false	none		none

continued

名称	类型	必选	约束	说明
instructions	string	false	none	none
max_output_tokens	integer	false	none	none
temperature	number	false	none	none
top_p	number	false	none	none
stream	boolean	false	none	none
tools	[object]	false	none	none
tool_choice	any	false	none	none

oneOf

名称	类型	必选	约束	中文名	说明
» anonymous	string	false	none		none

xor

名称	类型	必选	约束	中文名	说明
» anonymous	object	false	none		none

continued

名称	类型	必选	约束	说明
reasoning	object	false	none	none
» effort	string	false	none	none
» summary	string	false	none	none
previous_response_id	string	false	none	none
truncation	string	false	none	none

枚举值

属性	值
effort	low
effort	medium
effort	high
truncation	auto
truncation	disabled

ResponsesResponse

{
  "id": "string",
  "object": "response",
  "created_at": 0,
  "status": "completed",
  "model": "string",
  "output": [
    {
      "type": "string",
      "id": "string",
      "status": "string",
      "role": "string",
      "content": [
        {
          "type": "string",
          "text": "string"
        }
      ]
    }
  ],
  "usage": {
    "prompt_tokens": 0,
    "completion_tokens": 0,
    "total_tokens": 0,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "text_tokens": 0,
      "audio_tokens": 0,
      "image_tokens": 0
    },
    "completion_tokens_details": {
      "text_tokens": 0,
      "audio_tokens": 0,
      "reasoning_tokens": 0
    }
  }
}

属性

名称	类型	必选	约束	说明
id	string	false	none	none
object	string	false	none	none
created_at	integer	false	none	none
status	string	false	none	none
model	string	false	none	none
output	[object]	false	none	none
» type	string	false	none	none
» id	string	false	none	none
» status	string	false	none	none
» role	string	false	none	none
» content	[object]	false	none	none
»» type	string	false	none	none
»» text	string	false	none	none
usage	Usage	false	none	none

枚举值

属性	值
status	completed
status	failed
status	in_progress
status	incomplete

ClaudeRequest

{
  "model": "claude-3-opus-20240229",
  "messages": [
    {
      "role": "user",
      "content": "string"
    }
  ],
  "system": "string",
  "max_tokens": 1,
  "temperature": 1,
  "top_p": 0,
  "top_k": 0,
  "stream": true,
  "stop_sequences": [
    "string"
  ],
  "tools": [
    {
      "name": "string",
      "description": "string",
      "input_schema": {}
    }
  ],
  "tool_choice": {
    "type": "auto",
    "name": "string"
  },
  "thinking": {
    "type": "enabled",
    "budget_tokens": 0
  },
  "metadata": {
    "user_id": "string"
  }
}

属性

名称	类型	必选	约束	说明
model	string	true	none	none
messages	[ClaudeMessage]	true	none	none
system	any	false	none	none

oneOf

名称	类型	必选	约束	中文名	说明
» anonymous	string	false	none		none

xor

名称	类型	必选	约束	中文名	说明
» anonymous	[object]	false	none		none

continued

名称	类型	必选	约束	说明
max_tokens	integer	true	none	none
temperature	number	false	none	none
top_p	number	false	none	none
top_k	integer	false	none	none
stream	boolean	false	none	none
stop_sequences	[string]	false	none	none
tools	[object]	false	none	none
» name	string	false	none	none
» description	string	false	none	none
» input_schema	object	false	none	none
tool_choice	object	false	none	none
» type	string	false	none	none
» name	string	false	none	none
thinking	object	false	none	none
» type	string	false	none	none
» budget_tokens	integer	false	none	none
metadata	object	false	none	none
» user_id	string	false	none	none

枚举值

属性	值
type	auto
type	any
type	tool
type	enabled
type	disabled

ClaudeMessage

{
  "role": "user",
  "content": "string"
}

属性

名称	类型	必选	约束	中文名	说明
role	string	true	none		none
content	any	true	none		none

oneOf

名称	类型	必选	约束	中文名	说明
» anonymous	string	false	none		none

xor

名称	类型	必选	约束	说明
» anonymous	[object]	false	none	none
»» type	string	false	none	none
»» text	string	false	none	none
»» source	object	false	none	none
»»» type	string	false	none	none
»»» media_type	string	false	none	none
»»» data	string	false	none	none
»»» url	string	false	none	none
»» id	string	false	none	none
»» name	string	false	none	none
»» input	object	false	none	none
»» tool_use_id	string	false	none	none
»» content	string	false	none	none

枚举值

属性	值
role	user
role	assistant
type	text
type	image
type	tool_use
type	tool_result
type	base64
type	url

ClaudeResponse

{
  "id": "string",
  "type": "message",
  "role": "assistant",
  "content": [
    {
      "type": "string",
      "text": "string"
    }
  ],
  "model": "string",
  "stop_reason": "end_turn",
  "usage": {
    "input_tokens": 0,
    "output_tokens": 0,
    "cache_creation_input_tokens": 0,
    "cache_read_input_tokens": 0
  }
}

属性

名称	类型	必选	约束	说明
id	string	false	none	none
type	string	false	none	none
role	string	false	none	none
content	[object]	false	none	none
» type	string	false	none	none
» text	string	false	none	none
model	string	false	none	none
stop_reason	string	false	none	none
usage	object	false	none	none
» input_tokens	integer	false	none	none
» output_tokens	integer	false	none	none
» cache_creation_input_tokens	integer	false	none	none
» cache_read_input_tokens	integer	false	none	none

枚举值

属性	值
stop_reason	end_turn
stop_reason	max_tokens
stop_reason	stop_sequence
stop_reason	tool_use

EmbeddingRequest

{
  "model": "text-embedding-ada-002",
  "input": "string",
  "encoding_format": "float",
  "dimensions": 0
}

属性

名称	类型	必选	约束	中文名	说明
model	string	true	none		none
input	any	true	none		要嵌入的文本

oneOf

名称	类型	必选	约束	中文名	说明
» anonymous	string	false	none		none

xor

名称	类型	必选	约束	中文名	说明
» anonymous	[string]	false	none		none

continued

名称	类型	必选	约束	中文名	说明
encoding_format	string	false	none		none
dimensions	integer	false	none		输出向量维度

枚举值

属性	值
encoding_format	float
encoding_format	base64

EmbeddingResponse

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [
        0
      ]
    }
  ],
  "model": "string",
  "usage": {
    "prompt_tokens": 0,
    "total_tokens": 0
  }
}

属性

名称	类型	必选	约束	说明
object	string	false	none	none
data	[object]	false	none	none
» object	string	false	none	none
» index	integer	false	none	none
» embedding	[number]	false	none	none
model	string	false	none	none
usage	object	false	none	none
» prompt_tokens	integer	false	none	none
» total_tokens	integer	false	none	none

ImageResponse

{
  "created": 0,
  "data": [
    {
      "url": "string",
      "b64_json": "string",
      "revised_prompt": "string"
    }
  ]
}

属性

名称	类型	必选	约束	说明
created	integer	false	none	none
data	[object]	false	none	none
» url	string	false	none	none
» b64_json	string	false	none	none
» revised_prompt	string	false	none	none

AudioTranscriptionResponse

{
  "text": "string"
}

属性

名称	类型	必选	约束	中文名	说明
text	string	false	none		none

SpeechRequest

{
  "model": "tts-1",
  "input": "string",
  "voice": "alloy",
  "response_format": "mp3",
  "speed": 1
}

属性

名称	类型	必选	约束	说明
model	string	true	none	none
input	string	true	none	要转换的文本
voice	string	true	none	none
response_format	string	false	none	none
speed	number	false	none	none

枚举值

属性	值
voice	alloy
voice	echo
voice	fable
voice	onyx
voice	nova
voice	shimmer
response_format	mp3
response_format	opus
response_format	aac
response_format	flac
response_format	wav
response_format	pcm

RerankRequest

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

属性

名称	类型	必选	约束	说明
model	string	true	none	none
query	string	true	none	查询文本
documents	[oneOf]	true	none	要重排序的文档列表

oneOf

名称	类型	必选	约束	中文名	说明
» anonymous	string	false	none		none

xor

名称	类型	必选	约束	中文名	说明
» anonymous	object	false	none		none

continued

名称	类型	必选	约束	中文名	说明
top_n	integer	false	none		返回前 N 个结果
return_documents	boolean	false	none		none

RerankResponse

{
  "id": "string",
  "results": [
    {
      "index": 0,
      "relevance_score": 0,
      "document": {}
    }
  ],
  "meta": {}
}

属性

名称	类型	必选	约束	说明
id	string	false	none	none
results	[object]	false	none	none
» index	integer	false	none	none
» relevance_score	number	false	none	none
» document	object	false	none	none
meta	object	false	none	none

VideoRequest

{
  "model": "kling-v1",
  "prompt": "宇航员站起身走了",
  "image": "https://example.com/image.jpg",
  "duration": 5,
  "width": 1280,
  "height": 720,
  "fps": 30,
  "seed": 20231234,
  "n": 1,
  "response_format": "url",
  "user": "user-1234",
  "metadata": {}
}

视频生成请求

属性

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

ModerationRequest

{
  "input": "string",
  "model": "text-moderation-latest"
}

属性

名称	类型	必选	约束	中文名	说明
input	any	true	none		none

oneOf

名称	类型	必选	约束	中文名	说明
» anonymous	string	false	none		none

xor

名称	类型	必选	约束	中文名	说明
» anonymous	[string]	false	none		none

continued

名称	类型	必选	约束	中文名	说明
model	string	false	none		none

VideoResponse

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

视频生成任务提交响应

属性

名称	类型	必选	约束	中文名	说明
task_id	string	false	none		任务 ID
status	string	false	none		任务状态

ModerationResponse

{
  "id": "string",
  "model": "string",
  "results": [
    {
      "flagged": true,
      "categories": {},
      "category_scores": {}
    }
  ]
}

属性

名称	类型	必选	约束	说明
id	string	false	none	none
model	string	false	none	none
results	[object]	false	none	none
» flagged	boolean	false	none	none
» categories	object	false	none	none
» category_scores	object	false	none	none

VideoTaskResponse

{
  "task_id": "abcd1234efgh",
  "status": "completed",
  "url": "https://example.com/video.mp4",
  "format": "mp4",
  "metadata": {
    "duration": 5,
    "fps": 30,
    "width": 1280,
    "height": 720,
    "seed": 20231234
  },
  "error": {
    "code": 0,
    "message": "string"
  }
}

视频任务状态查询响应

属性

名称	类型	必选	约束	说明
task_id	string	false	none	任务 ID
status	string	false	none	任务状态
url	string	false	none	视频资源 URL（成功时）
format	string	false	none	视频格式
metadata	VideoTaskMetadata	false	none	视频任务元数据
error	VideoTaskError	false	none	视频任务错误信息

枚举值

属性	值
status	queued
status	in_progress
status	completed
status	failed

GeminiRequest

{
  "contents": [
    {
      "role": "user",
      "parts": [
        {
          "text": "string",
          "inlineData": {
            "mimeType": null,
            "data": null
          }
        }
      ]
    }
  ],
  "generationConfig": {
    "temperature": 0,
    "topP": 0,
    "topK": 0,
    "maxOutputTokens": 0,
    "stopSequences": [
      "string"
    ]
  },
  "safetySettings": [
    {
      "category": "string",
      "threshold": "string"
    }
  ],
  "tools": [
    {}
  ],
  "systemInstruction": {
    "parts": [
      {}
    ]
  }
}

属性

名称	类型	必选	约束	说明
contents	[object]	false	none	none
» role	string	false	none	none
» parts	[object]	false	none	none
»» text	string	false	none	none
»» inlineData	object	false	none	none
»»» mimeType	string	false	none	none
»»» data	string	false	none	none
generationConfig	object	false	none	none
» temperature	number	false	none	none
» topP	number	false	none	none
» topK	integer	false	none	none
» maxOutputTokens	integer	false	none	none
» stopSequences	[string]	false	none	none
safetySettings	[object]	false	none	none
» category	string	false	none	none
» threshold	string	false	none	none
tools	[object]	false	none	none
systemInstruction	object	false	none	none
» parts	[object]	false	none	none

枚举值

属性	值
role	user
role	model

VideoTaskMetadata

{
  "duration": 5,
  "fps": 30,
  "width": 1280,
  "height": 720,
  "seed": 20231234
}

视频任务元数据

属性

名称	类型	必选	约束	说明
duration	number	false	none	实际生成的视频时长
fps	integer	false	none	实际帧率
width	integer	false	none	实际宽度
height	integer	false	none	实际高度
seed	integer	false	none	使用的随机种子

VideoTaskError

{
  "code": 0,
  "message": "string"
}

视频任务错误信息

属性

名称	类型	必选	约束	中文名	说明
code	integer	false	none		错误码
message	string	false	none		错误信息

GeminiResponse

{
  "candidates": [
    {
      "content": {
        "role": "string",
        "parts": [
          {}
        ]
      },
      "finishReason": "string",
      "safetyRatings": [
        {}
      ]
    }
  ],
  "usageMetadata": {
    "promptTokenCount": 0,
    "candidatesTokenCount": 0,
    "totalTokenCount": 0
  }
}

属性

名称	类型	必选	约束	说明
candidates	[object]	false	none	none
» content	object	false	none	none
»» role	string	false	none	none
»» parts	[object]	false	none	none
» finishReason	string	false	none	none
» safetyRatings	[object]	false	none	none
usageMetadata	object	false	none	none
» promptTokenCount	integer	false	none	none
» candidatesTokenCount	integer	false	none	none
» totalTokenCount	integer	false	none	none

OpenAIVideoError

{
  "message": "string",
  "code": "string"
}

OpenAI 视频错误信息

属性

名称	类型	必选	约束	中文名	说明
message	string	false	none		错误信息
code	string	false	none		错误码

AI模型接口

Authentication#

模型（Models）/列出模型#

GET 原生OpenAI格式#

请求参数#

返回结果#

GET 原生Gemini格式#

返回结果#

聊天（Chat）#

POST 原生Claude格式#

请求参数#

返回结果#

聊天（Chat）/原生OpenAI格式#

POST Responses格式#

请求参数#

返回结果#

图像（Images）/原生OpenAI格式#

POST 生成图像#

请求参数#

详细说明#

返回结果#

返回数据结构#

POST 编辑图像#

请求参数#

返回结果#

返回数据结构#

图像（Images）/通义千问格式#

POST 生成图像#

请求参数#

返回结果#

POST 编辑图像#

请求参数#

返回结果#

图像（Images）/Nano Banana#

POST Gemini原生格式#

请求参数#

返回结果#

视频（Videos）#

POST 创建视频生成任务#

请求参数#

返回结果#

GET 获取视频生成任务状态#

请求参数#

返回结果#

视频（Videos）/Sora格式#

POST 创建视频#

请求参数#

返回结果#

返回数据结构#

GET 获取视频任务状态#

请求参数#

返回结果#

返回数据结构#

GET 获取视频内容#

请求参数#

返回结果#

视频（Videos）/可灵格式#

POST Kling 文生视频#

请求参数#

返回结果#

GET 获取 Kling 文生视频任务状态#

请求参数#

返回结果#

POST Kling 图生视频#

请求参数#

返回结果#

GET 获取 Kling 图生视频任务状态#

请求参数#

返回结果#

视频（Videos）/即梦格式#

POST 即梦视频生成#

请求参数#

枚举值#

返回结果#

返回数据结构#

嵌入（Embeddings）#

POST 原生OpenAI格式#

请求参数#

返回结果#

POST 原生Gemini格式#

Authentication

模型（Models）/列出模型

GET 原生OpenAI格式

请求参数

返回结果

GET 原生Gemini格式

返回结果

聊天（Chat）

POST 原生Claude格式

请求参数

返回结果

聊天（Chat）/原生OpenAI格式

POST Responses格式

请求参数

返回结果

图像（Images）/原生OpenAI格式

POST 生成图像

请求参数

详细说明

返回结果

返回数据结构

POST 编辑图像

请求参数

返回结果

返回数据结构

图像（Images）/通义千问格式

POST 生成图像

请求参数

返回结果

POST 编辑图像

请求参数

返回结果

图像（Images）/Nano Banana

POST Gemini原生格式

请求参数

返回结果

视频（Videos）

POST 创建视频生成任务

请求参数

返回结果

GET 获取视频生成任务状态

请求参数

返回结果

视频（Videos）/Sora格式

POST 创建视频

请求参数

返回结果

返回数据结构

GET 获取视频任务状态

请求参数

返回结果

返回数据结构

GET 获取视频内容

请求参数

返回结果

视频（Videos）/可灵格式

POST Kling 文生视频

请求参数

返回结果

GET 获取 Kling 文生视频任务状态

请求参数

返回结果

POST Kling 图生视频

请求参数

返回结果

GET 获取 Kling 图生视频任务状态

请求参数

返回结果

视频（Videos）/即梦格式

POST 即梦视频生成

请求参数

枚举值

返回结果

返回数据结构

嵌入（Embeddings）

POST 原生OpenAI格式

请求参数

返回结果

POST 原生Gemini格式

请求参数