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

# API 目录

> 按能力浏览 MaxAPI 接口，并了解接口页的阅读方式。

接口参考由 OpenAPI 规范生成。每个接口页依次展示完整 URL、认证方式、请求参数、代码示例和成功或失败响应。

<CardGroup cols={2}>
  <Card title="文本与向量" icon="messages" href="/api-reference/text">聊天补全、文本补全和嵌入。</Card>
  <Card title="图像生成与处理" icon="image" href="/api-reference/images">生成、编辑和处理图片。</Card>
  <Card title="视频生成" icon="video" href="/api-reference/video">创建视频并查询异步任务。</Card>
  <Card title="音频与音乐" icon="waveform" href="/api-reference/audio-music">语音、转录、音效和音乐。</Card>
  <Card title="工具与 PPT" icon="wrench" href="/api-reference/tools">PPT、文件和图片处理工具。</Card>
  <Card title="选择接口格式" icon="shuffle" href="/guides/choose-api">比较兼容格式与厂商原生格式。</Card>
</CardGroup>

## 基础信息

| 项目     | 值                                        |
| ------ | ---------------------------------------- |
| API 地址 | `https://api.maxapi.ai`                  |
| 默认认证   | `Authorization: Bearer YOUR_API_KEY`     |
| 常用内容类型 | `application/json`、`multipart/form-data` |
| 代码示例   | cURL、Python、JavaScript、Go、Java           |

## 如何阅读接口页

<Steps>
  <Step title="确认方法和完整 URL">
    页面标题下方会显示 `GET`、`POST` 等方法和完整请求地址。
  </Step>

  <Step title="填写请求参数">
    参数区按 Header、Path、Query 和 Body 分类，并标记必填字段、类型和示例值。
  </Step>

  <Step title="选择代码语言">
    调试区会根据当前参数生成请求代码。复制前请替换 API Key、模型 ID 和资源地址。
  </Step>

  <Step title="核对响应结构">
    响应区会按状态码和内容类型展示字段。二进制图片、音频、视频和事件流会显示对应媒体类型。
  </Step>
</Steps>

<Warning>
  在线调试仅用于开发验证。生产环境应从服务端调用 API，不要把 API Key 写入浏览器代码、移动应用或公开仓库。
</Warning>

## 同步与异步接口

* 同步接口会在当前响应中直接返回文本、JSON 或二进制内容。
* 异步接口会先返回 `id`、`task_id` 或 `taskId`，再通过同一接口族的查询接口获取结果。
* 不同厂商的任务字段和状态值不完全相同。请以对应接口页为准。

需要实现轮询、超时和结果下载时，请阅读[异步任务](/guides/async-tasks)。