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

# 概述

> MindSee OpenAPI 在线文档

## 介绍

MindSee OpenAPI 面向外部程序客户端，用访问令牌鉴权，可以在脚本、后端服务或自动化流程里直接调用 MindSee 的生图能力，支持文生图和图片编辑。

<CardGroup cols={2}>
  <Card title="快速开始" icon="rocket" href="/quickstart">
    创建令牌，用一条 curl 命令生成第一张图片
  </Card>

  <Card title="生成图片" icon="image" href="/api-reference/images-generations">
    查看接口参数，并在线调试
  </Card>
</CardGroup>

## 模型

| 模型 ID | 名称 | 能力 |
| - | - | - |
| [`gpt-image-2`](/models/gpt-image-2) | GPT Image 2 | 文生图、图片编辑 |
| [`gpt-image-2.5-flare`](/models/gpt-image-2.5-flare) | GPT Image 2.5 Flare | 文生图、图片编辑 |
| [`gpt-image-2.5-sunburst`](/models/gpt-image-2.5-sunburst) | GPT Image 2.5 Sunburst | 文生图、图片编辑 |
| [`mindsee-image-2.5-flash`](/models/mindsee-image-2.5-flash) | MindSee Image Flash | 文生图、图片编辑 |

各模型支持的分辨率、比例、质量等参数不同，请在对应模型页面查看。

## Base URL

| 地区 | Base URL |
| - | - |
| 默认 | `https://openapi.mindsee.app` |
| 中国用户 | `https://hk.openapi.mindsee.app` |

接口路径以 `/v1` 开头，例如生图接口是 `https://openapi.mindsee.app/v1/images/generations`。

## 认证

所有接口都需要访问令牌，没有匿名接口。在请求头里携带：

```http theme={null}
Authorization: Bearer YOUR_API_KEY
```

访问令牌在 [MindSee 控制台](https://mindsee.app)左下角用户菜单的「令牌」里创建，明文只在创建时显示一次。用令牌发起的调用视同你本人操作：消耗你账户的积分，生成结果也归属你的账户。

缺少令牌、鉴权方案不是 `Bearer`，或令牌为空、不存在、已删除时，接口返回 `401`，并带响应头 `WWW-Authenticate: Bearer realm="MindSee"`。

## 安全提示

访问令牌等同于账户密码，请勿在以下场景暴露：

* 公开代码仓库
* 前端或移动端客户端代码
* 截图或屏幕录制
* 他人可访问的配置文件

如果令牌不慎泄露，请立即在控制台删除，再重新创建。

## 错误处理

请求失败时，HTTP 状态码表示错误类别，响应体格式统一如下：

```json theme={null}
{
  "message": "当前模型不支持所选尺寸",
  "code": "",
  "detail": null
}
```

| 字段 | 说明 |
| - | - |
| `message` | 可读的错误信息，语言跟随 `Accept-Language` 请求头（支持 `zh`、`en`） |
| `code` | 机器可识别的错误码，多数错误为空字符串，需要程序区分的错误才会返回 |
| `detail` | 附加信息，多数错误为 `null` |

| 状态码 | 含义 | 处理建议 |
| - | - | - |
| `400` | 生成任务执行失败，`message` 说明原因 | 本次扣除的积分会退还，可调整提示词后重试 |
| `401` | 缺少令牌或令牌无效 | 检查 `Authorization` 请求头 |
| `402` | 积分不足，`code` 为 `INSUFFICIENT_CREDITS` | 在控制台充值或开通会员后重试 |
| `404` | 接口路径不存在 | 检查 URL |
| `405` | 请求方法不被支持 | 生图接口只支持 `POST` |
| `422` | 参数不合法，例如 JSON 格式错误、缺少必填字段、模型不存在、参数取值不受该模型支持、图片无法识别或超过 20MB | 按 `message` 修正参数，取值参见对应模型页面 |
| `500` | 服务内部错误 | 稍后重试 |


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