API Reference
按开发任务查找 AGTCloud API，并查看端点、参数、响应和在线调试。
AGTCloud API Reference 提供各接口的请求地址、鉴权方式、参数 Schema、响应结构、代码示例和在线调试。你可以先按任务找到接口，再进入具体端点页查看完整字段。
第一次调用 API
如果你还没有 API Key，或者尚未确定 Base URL 和模型 ID，请先阅读快速开始。已经完成基础配置时，可以直接从下方选择需要的接口。
主要能力
文本、图像和视频是当前 API Reference 的主要入口。一个能力下可能同时提供 OpenAI 兼容格式、厂商格式或 AGTCloud 异步任务格式，请根据现有 SDK 和目标模型选择。
文本与对话
使用 Chat Completions、Responses、Anthropic Messages、Gemini Generate Content 等协议生成文本和处理多轮对话。
图像生成
创建、编辑或生成图片变体，也可以使用 Grok Image 与 Midjourney 异步任务接口。
视频生成
通过平台 Video Generations、OpenAI Videos，以及 Grok、Kling、Vidu 等入口创建和查询视频。
更多接口
音频处理
进行语音合成、音频转写与翻译、异步语音识别和音色处理。
Embeddings
把文本或 Token 输入转换为向量，用于语义检索、聚类和相似度计算。
Rerank
使用 Jina、Cohere 或 Xinference 格式对候选文档进行相关性重排序。
Realtime
通过 WebSocket 事件处理实时文本、音频和函数调用。
按接口形态选择
不同能力使用的传输形式和结果获取方式并不相同。客户端应按照端点页标注的 Content-Type 和响应类型处理数据。
| 接口形态 | 常见场景 | 客户端处理方式 |
|---|---|---|
| 同步 JSON | 普通文本、Embedding、Rerank | 请求完成后解析 JSON 响应 |
| SSE 流式响应 | Chat、Responses、Gemini 流式生成 | 持续读取事件，直到流结束 |
| 异步任务 | 视频、Midjourney | 保存任务 ID，并查询状态和结果 |
| Multipart 上传 | 图片编辑、音频转写 | 按端点要求上传文件和表单字段 |
| 二进制响应 | 视频或音频内容下载 | 按响应媒体类型保存文件 |
| WebSocket | Realtime | 建立长连接并持续收发事件 |
如何阅读端点页面
确认 Endpoint 和鉴权
检查 Method、Path、API 地址以及端点要求的认证 Header。通用规则见通用约定。
选择请求场景
在请求示例中选择最接近当前任务的场景，再根据 Request Body、Path Parameters 或 Query Parameters 调整字段。
使用 Try It 验证
在线调试使用本页显示的 API 地址。填写当前账户的 API Key，并从模型列表中选择可用模型。不要在共享设备上使用长期生产 Key。
接入前的共同规则
- 不确定使用哪一种文本协议时，先阅读协议选择。
- Reference 中的
MODEL_ID需要替换为当前 API Key 实际可用的模型 ID。 - 同名能力在不同模型和协议下可能支持不同字段；以当前端点、账户权限和实际响应为准。
- 生产应用不得把 API Key 硬编码到浏览器前端或客户端包；Try It 仅用于临时调试，也不要把 Key 写入公开仓库、截图或日志。
继续阅读：通用约定 · API Key、Base URL 与认证