> ## Documentation Index
> Fetch the complete documentation index at: https://docs.playapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API 概览

> 核心推理接口、协议范围与可迁移规范。

本参考覆盖文本与多模态的常用接入接口，参数表来自同一份[标准 OpenAPI 3.0 文件](/openapi/relay.json)。字段描述共用中英双语，避免两份接口结构漂移。

| 接口 | 用途 |
| - | - |
| [GET /v1/models](/zh/api-reference/models) | 查询当前密钥可见的模型 |
| [POST /v1/chat/completions](/zh/api-reference/chat-completions) | 基于消息数组进行对话 |
| [POST /v1/responses](/zh/api-reference/responses) | 使用 Responses 输入、输出及事件结构 |
| [POST /v1/messages](/zh/api-reference/claude-messages) | Claude 原生消息 |
| [`POST /v1beta/models/{model}:generateContent`](/zh/api-reference/gemini-generate) | Gemini 原生生成 |
| [`POST /v1beta/models/{model}:streamGenerateContent`](/zh/api-reference/gemini-stream) | Gemini 原生 SSE |
| [POST /v1/images/generations](/zh/api-reference/images-generations) | 生成图片 |
| [POST /v1/images/edits](/zh/api-reference/images-edits) | 编辑图片 |
| [POST /v1/audio/speech](/zh/api-reference/audio-speech) | 合成语音 |
| [POST /v1/audio/transcriptions](/zh/api-reference/audio-transcriptions) | 转写音频 |
| [POST /v1/audio/translations](/zh/api-reference/audio-translations) | 翻译音频 |
| [POST /v1/videos](/zh/api-reference/videos-create) | 创建视频任务 |
| [`GET /v1/videos/{task_id}`](/zh/api-reference/videos-retrieve) | 查询视频任务 |
| [`GET /v1/videos/{task_id}/content`](/zh/api-reference/videos-content) | 下载视频 |
| [`HEAD /v1/videos/{task_id}/content`](/zh/api-reference/videos-content-head) | 检查视频内容 |
| [`POST /v1/videos/{video_id}/remix`](/zh/api-reference/videos-remix) | 重混视频 |
| [POST /v1/embeddings](/zh/api-reference/embeddings) | 生成文本向量 |
| [POST /v1/rerank](/zh/api-reference/rerank) | 重排候选文档 |
| [`GET /v1/models/{model}`](/zh/api-reference/model-retrieve) | 查询单个模型 |
| [POST /v1/responses/compact](/zh/api-reference/responses-compact) | 压缩上下文 |
| [`GET /v1/responses/{response_id}`](/zh/api-reference/responses-retrieve) | 查询插件任务响应 |
| [POST /v1/moderations](/zh/api-reference/moderations) | 内容审核 |
| [POST /v1/completions](/zh/api-reference/completions) | 创建文本补全 |
| [`POST /v1beta/models/{model}:embedContent`](/zh/api-reference/gemini-embed) | Gemini 单条向量 |
| [`POST /v1beta/models/{model}:batchEmbedContents`](/zh/api-reference/gemini-batch-embed) | Gemini 同步批量向量 |
| [`POST /v1/tasks/{key}`](/zh/api-reference/tasks-submit) | 提交通用插件任务 |
| [`GET /v1/tasks/{key}`](/zh/api-reference/tasks-retrieve) | 查询通用任务 |
| [`GET /v1/tasks/{key}/artifacts`](/zh/api-reference/task-artifacts) | 列出任务产物 |
| [`GET /v1/tasks/{key}/artifacts/{artifact_key}/content`](/zh/api-reference/task-artifact-content) | 下载任务产物 |
| [`HEAD /v1/tasks/{key}/artifacts/{artifact_key}/content`](/zh/api-reference/task-artifact-head) | 检查任务产物 |
| [POST /v1/alpha/search](/zh/api-reference/alpha-search) | Alpha Search 专用请求 |
| [`GET /mj/task/{id}/fetch`](/zh/api-reference/midjourney-task) | 查询 Midjourney 任务 |

## WebSocket API

HTTP 升级与事件说明独立维护，不计入上面的 32 个 REST 操作：[Responses WebSocket](/zh/api-reference/responses-websocket)、[Realtime](/zh/api-reference/realtime)。可运行脚本与共用模块见[WebSocket 接入](/zh/guides/websocket)。

## 请求约定

使用 `Authorization: Bearer YOUR_API_KEY`；JSON 请求发送 `Content-Type: application/json`；上传文件按对应端点使用 multipart，由客户端自动设置 boundary。SDK 的 Base URL 包含 `/v1`；OpenAPI 的 `servers` 只写网关根地址及可选前缀，因为规范路径已经包含 `/v1`。

规范中的 `gateway.example.com` 是占位地址。本地参考页关闭在线请求面板；请按[接入指南](/zh/guides/api-basics)配置自己的服务端客户端。

原生 Claude 也支持 `x-api-key`，Gemini 支持 `x-goog-api-key`，都传入网关令牌；原生示例使用不含协议前缀的 `API_ROOT_URL`。Gemini 路径包含 `/v1beta`。

## 支持范围

这是从项目实现核对的核心接入规范，不是所有管理、媒体或供应商接口的完整镜像。列出字段表示接口结构可接收该字段，不保证每个渠道原样透传或每个模型支持。范围、默认值、工具和多模态能力需结合部署确认。

Chat Completions 和 Responses 的字段不能混用。响应也可能包含未在此展开的供应商扩展，客户端应允许额外字段。所有示例输出仅说明结构，实际文本和用量会变化。

## 规范来源

核对版本：`1b7b8df6a2eb3d59485e71ea79a48f248c11b668`。依据项目路由、模型列表控制器及 `relaykit` 请求/响应 DTO；源文件清单保存在规范的 `x-source-files`，版本在 `x-source-revision`。

迁移文档平台时，直接复用 OpenAPI 文件，并将页面 `openapi` frontmatter 替换为新平台的接口渲染配置。[错误和重试](/zh/guides/errors)适用于以上接口。

新增 Claude / Gemini 操作另按 `d851a5faa49a00abaafd27bf91b311506fbfbc52` 核对；各操作自己的 `x-source-revision` 和 `x-source-files` 记录来源，原有 15 个操作保留上述基线。

原生协议的可运行 SSE 与工具闭环见 [Claude](/zh/guides/native-claude-streaming)和 [Gemini](/zh/guides/native-gemini-streaming)，包含完成校验与签名保留。

新增单模型查询、审核、压缩及插件任务响应查询核对版本 `30a6d88a4`，操作内单独记录来源。查询插件任务不等于代理任意上游响应；完整边界见[接口支持范围](/zh/guides/api-coverage)。

新增文本补全、原生向量、通用任务、专用搜索及 Midjourney 查询按 `30a6d88a4` 核对；路由差异见[兼容入口](/zh/guides/protocol-compatibility)。

[Read in English](/en/api-reference/overview)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.