> ## 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.

# MaxAPI 开发者文档

> 通过统一入口调用文本、图像、视频、音频和音乐模型。

用一套账户和 API Key 接入 OpenAI 兼容接口及主流厂商原生接口。接口页提供完整路径、请求参数、多语言代码示例、响应结构和在线调试。

<CardGroup cols={3}>
  <Card title="5 分钟快速接入" icon="rocket" href="/quickstart">
    使用 OpenAI SDK 或 cURL 完成第一个聊天请求。
  </Card>

  <Card title="浏览 API 目录" icon="square-terminal" href="/api-reference/overview">
    按文本、图像、视频、音频和工具查找接口。
  </Card>

  <Card title="选择接口格式" icon="shuffle" href="/guides/choose-api">
    在 OpenAI 兼容格式、统一任务格式和厂商原生格式之间选择。
  </Card>
</CardGroup>

## API 地址

```text theme={null}
https://api.maxapi.ai
```

OpenAI SDK 通常使用带 `/v1` 的 Base URL：

```text theme={null}
https://api.maxapi.ai/v1
```

<Info>
  厂商原生路径直接拼接到 `https://api.maxapi.ai`。不要为 `/wan/*`、`/kling/*`、`/vidu/*` 等路径额外添加 `/v1`。
</Info>

## 按能力查找接口

<CardGroup cols={2}>
  <Card title="文本与向量" icon="messages" href="/api-reference/text">
    聊天补全、文本补全和向量嵌入。
  </Card>

  <Card title="图像生成与处理" icon="image" href="/api-reference/images">
    文生图、图片编辑、放大、抠图、修复和 OCR。
  </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="plug" href="/usercases/index">
    为 Cursor、Claude Code、Chatbox 等客户端配置 MaxAPI。
  </Card>
</CardGroup>

## 第一次调用

<Steps>
  <Step title="获取 API Key">
    在 MaxAPI 控制台创建密钥，并仅保存在服务端环境变量中。
  </Step>

  <Step title="选择模型和接口">
    从模型列表复制模型 ID，再从左侧目录打开对应能力和厂商的接口页。
  </Step>

  <Step title="核对请求和响应">
    检查 HTTP 方法、完整 URL、认证头、必填字段以及成功响应结构。
  </Step>

  <Step title="在线调试或复制代码">
    在接口页填写参数，直接调试，或复制 cURL、Python、JavaScript、Go 和 Java 示例。
  </Step>
</Steps>

<CardGroup cols={3}>
  <Card title="身份认证" icon="key" href="/guides/authentication">安全传递和保存 API Key。</Card>
  <Card title="异步任务" icon="clock" href="/guides/async-tasks">处理视频、图像和音乐任务。</Card>
  <Card title="错误处理" icon="triangle-alert" href="/guides/errors">识别 HTTP 与业务错误并实施重试。</Card>
</CardGroup>