千问 OCR · Qwen-VL-OCR-qwen-vl-ocr-latest大模型-AI网关接口说明-挖数据

全国400服务热线

400-995-9993

注册登录

当前位置：首页 > api商店 > 千问 OCR · Qwen-VL-OCR · API 说明

千问 OCR · Qwen-VL-OCR

通义千问

模型 ID 32 图像

模型说明

千问 OCR：专为文字提取设计，支持扫描文档、表格、票据等图像 OCR 与结构化抽取；每次上传 1 张图片并输入识别指令，按输入/输出 10K 词元计费。

进入对话页

千问 OCR · Qwen-VL-OCR（qwen-vl-ocr-latest）视觉文字识别，请使用 POST /v1/chat / POST /v1/chat/stream 调用。

能力

图像 OCR：上传扫描文档、表格、票据、倾斜/多语言图像，提取纯文本或按 Prompt 输出 JSON 等结构化结果。
图片附件：通过 attachments 上传 1 张图片（单文件 <100MB）；网关转为 image_url 并附带 min_pixels / max_pixels（默认 3072 / 8388608）。
识别指令：在 messages 最后一条 user 文本中描述提取规则；未填写时使用默认识别提示。
可选 extra.min_pixels、extra.max_pixels 覆盖默认像素阈值。

计费（元/10K词元）

类型	单价（元/10K词元）
输入	0.0051
输出	0.0085

实际扣费以 API 响应 usage 为准；图像输入 Token 与分辨率相关。

接口说明
调用示例
Markdown

左侧为章节切换，右侧为对应内容。

接口一览（Base：https://ai.wapi.cn/pyai）

POST …/v1/chat — 非流式，JSON 请求/响应；messages 须含当次完整上下文（多轮由客户端在 body 中组装）。
POST …/v1/chat/stream — 流式，SSE；请求体与上一项相同。
GET …/v1/auth/status — 鉴权状态。
GET …/v1/video-task/{job_id} — 异步视频任务查询。
GET …/health — 健康检查（无需鉴权）。

对外对接须带应用密钥请求头；Cookie 仅站内网页兼容。

请求头（鉴权）

字段名	类型	必填	说明
`Authorization`	string	是	Bearer 令牌，格式为 `Bearer {应用ID}-{应用密钥}`（仅在第一个 `-` 处分割，密钥本身可含连字符）。应用 ID 与密钥在会员中心「我的应用」获取。兼容 OpenAI SDK：将 `{应用ID}-{应用密钥}` 作为 `api_key` 传入即可自动携带本请求头。

对接 HTTP 接口请使用上表 Authorization: Bearer {应用ID}-{应用密钥}；兼容 OpenAI SDK（将 {应用ID}-{应用密钥} 作为 api_key）。站内网页另有 Cookie 兼容方式，不在此列出。

POST /v1/chat、POST /v1/chat/stream — JSON 请求体根字段

非流式与流式使用同一请求体结构；流式请使用 …/v1/chat/stream 路径。

多轮与上下文：接口按当次请求里的 messages 处理对话，不会替你「记住」上一轮正文。续聊须由客户端在 body 中组装完整历史（含此前的 user / assistant 等）。

字段名	类型	必填	说明
`model_id`	int	是	模型主键；本页文档对应 `model_id=32`。
`messages`	array	是	消息对象数组（见 messages[]）。至少一条；多轮时须在数组内按顺序包含完整历史（user/assistant/system 等）。按本次列表处理对话，不自动补全缺省轮次。
`temperature`	number	否	采样温度，默认 0.7；是否生效取决于具体模型。
`max_tokens`	int 或 null	否	生成长度上限（token）；null 表示使用默认。
`stream`	bool	否	请求体字段，默认 false。是否流式由 URL 决定：流式请 POST `/v1/chat/stream`；`/v1/chat` 为非流式。勿仅靠本字段切换 SSE。
`attachments`	array	否	附件数组，默认 []（见 attachments[]）。服务端会把附件整理为模型可识别的上下文（如追加 system 说明 URL 列表）。
`extra`	object	否	任意 JSON 对象，默认 {}。模型专有参数放于此（如数字人 image_url/audio_url/parameters；文生图/视频类 prompt、尺寸等）。服务端可能合并内部保留字段；请勿使用以下划线 `_` 开头的键名作为业务自定义字段。

messages[] — 单条消息

数组顺序即对话顺序；多轮时把历史轮次一并列入本数组即可。

字段名	类型	必填	说明
`role`	string	是	角色：如 user、assistant、system 等，与 OpenAI Chat Completions 约定一致。
`content`	string	是	该轮文本内容。多轮时 assistant 一般为上一轮模型输出，由客户端保存后在后续请求的 messages 中写回。
`images`	array 或 null	否	历史消息中的多模态图片结构，会话回放用；元素为对象，字段因模型而异。
`audios`	array 或 null	否	历史消息中的音频结构，会话回放用。

attachments[] — 单条附件

字段名	类型	必填	说明
`url`	string	是	附件可访问 URL（须能被服务端拉取）。
`filename`	string 或 null	否	原始文件名，便于展示或日志。
`mime`	string 或 null	否	MIME 类型，如 image/png。
`extra`	object	否	附件级扩展信息，默认 {}。

本页示例 JSON 涉及字段（model_id=32 · 千问 OCR）

**须上传 1 张图片**（`attachments`，`upload_kind=image`，仅 1 项）；网关转为多模态 `content`。流式请 **`POST /v1/chat/stream`**。模型 **`model`**（`qwen-vl-ocr-latest`）由服务端配置。

下列说明与下方「调用示例」JSON 对齐，由本站配置维护。

字段名	类型	必填	说明
`model_id`	int	是	须为 `32`。
`messages`	array	是	至少一条 user 消息；`content` 为 OCR 指令文本。
`messages[].role`	string	是	`user` / `assistant` / `system`。
`messages[].content`	string	是	识别/抽取指令；可与图片附件配合。
`attachments[]`	array	是	图片附件，仅 1 张（见 attachments[]）。
`attachments[].url`	string	是	图片可访问 URL（OSS 临时地址）。
`attachments[].upload_kind`	string	否	建议 `image`。
`extra.min_pixels`	int	否	图像最小像素阈值，默认 3072（32×32×3）。
`extra.max_pixels`	int	否	图像最大像素阈值，默认 8388608（8192×32×32）。
`stream`	bool	否	流式请用 `/v1/chat/stream`。

POST /v1/chat — 响应 JSON

字段名	类型	必填	说明
`model_id`	int	是	本次调用的模型 ID。
`content`	string	是	主文本回复；异步类模型常为说明文案，资源见 images/audios/videos 或 raw。
`raw`	object	是	扩展载荷（默认 {}）。常含原始响应字段、用量、异步任务标识（如 job_id）等，结构因模型而异。
`images`	array 或 null	否	结构化图片列表；元素多为含 url 的对象，供预览/下载。
`audios`	array 或 null	否	结构化音频列表；元素一般含可播放 url。
`videos`	array 或 null	否	视频任务占位或结果列表；异步场景常与 `raw.video_task` 等配合，用于取 job_id 轮询 `/v1/video-task/{job_id}`。

GET /v1/auth/status — 响应字段

字段名	类型	必填	说明
`ok`	bool	是	请求是否被服务端正常处理（业务上是否已登录见 logged_in）。
`logged_in`	bool	是	是否已通过鉴权（应用密钥或站内 Cookie 等网关认可的登录态）。
`user_id`	int	条件	已登录时返回会员用户 ID。
`balance`	number	条件	已登录时返回账户余额（元，由分转换）。
`message`	string	条件	未登录或异常时的提示文案。

POST /v1/chat/stream — SSE 事件

Content-Type: text/event-stream。每帧为 event: + data:（JSON）。

事件名	data 说明
`ready`	首帧；data 为 JSON（如含本轮元信息等，具体以网关实现为准）。
`delta`	增量；data 为 JSON，至少含 `model_id`、`delta`（文本分片）；可含 `phase`、`images`、`audios`、`videos` 等与模型相关的字段。
`done`	结束帧；data 为 JSON，含 `done: true`、`audios`、`videos` 等。正文通常由客户端将此前 delta 拼接得到（本帧不一定重复全文）。
`error`	异常；data 为 JSON，含 `error` 及可选的调试摘要（视部署而定）。

GET /v1/video-task/{job_id} — 路径与响应（根级 ok + task）

job_id 为路径中的任务编号（整数）。仅返回当前应用身份下的任务；不存在时多为 HTTP 404。

字段名	类型	必填	说明
`ok`	bool	是	响应根级。HTTP 200 且查到任务时为 true，且同层含 `task` 对象；无权限或任务不存在时一般为 HTTP 404（响应体依框架，不一定含本结构）。
`task.id`	int	条件	任务主键。
`task.model_id`	int	条件	任务关联模型 ID。
`task.dashscope_task_id`	string	条件	异步任务标识（如有）。
`task.task_status`	string	条件	任务状态字符串，轮询直至终态。
`task.video_url`	string 或 null	否	成功时可下载的视频地址（链接有效期以业务说明为准，如约 24 小时）。
`task.last_error`	string 或 null	否	失败时的错误信息。
`task.usage`	object 或 null	否	用量 JSON（若有）。
`task.created_at`	string	条件	创建时间。
`task.updated_at`	string	条件	最近更新时间。

健康检查：GET https://ai.wapi.cn/pyai/health，无需鉴权。

以下示例中的 你的应用ID、你的应用密钥 请替换为「我的应用」中的值。左侧切换语言；右侧为非流式与流式（SSE）两段示例。代码区右上角可一键复制。

已复制

非流式 · `POST …/v1/chat`

curl -sS -X POST 'https://ai.wapi.cn/pyai/v1/chat' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer 你的应用ID-你的应用密钥' \
  -d '{"model_id":32,"messages":[{"role":"user","content":"请识别图片中的全部文字内容，按原文顺序输出，不要添加额外说明。"}],"temperature":0.7,"max_tokens":null,"stream":true,"attachments":[{"url":"https:\/\/img.alicdn.com\/imgextra\/i2\/O1CN01ktT8451iQutqReELT_!!6000000004408-0-tps-689-487.jpg","filename":"ticket.jpg","mime":"image\/jpeg","upload_kind":"image"}],"extra":{"min_pixels":3072,"max_pixels":8388608}}'

流式 · `POST …/v1/chat/stream`（`-N` 禁用缓冲）

curl -sS -N -X POST 'https://ai.wapi.cn/pyai/v1/chat/stream' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer 你的应用ID-你的应用密钥' \
  -d '{"model_id":32,"messages":[{"role":"user","content":"请识别图片中的全部文字内容，按原文顺序输出，不要添加额外说明。"}],"temperature":0.7,"max_tokens":null,"stream":true,"attachments":[{"url":"https:\/\/img.alicdn.com\/imgextra\/i2\/O1CN01ktT8451iQutqReELT_!!6000000004408-0-tps-689-487.jpg","filename":"ticket.jpg","mime":"image\/jpeg","upload_kind":"image"}],"extra":{"min_pixels":3072,"max_pixels":8388608}}'

非流式 · `POST …/v1/chat`

import json
import urllib.request

url = "https://ai.wapi.cn/pyai/v1/chat"
payload = {
    "model_id": 32,
    "messages": [
        {
            "role": "user",
            "content": "请识别图片中的全部文字内容，按原文顺序输出，不要添加额外说明。"
        }
    ],
    "temperature": 0.7,
    "max_tokens": null,
    "stream": true,
    "attachments": [
        {
            "url": "https:\/\/img.alicdn.com\/imgextra\/i2\/O1CN01ktT8451iQutqReELT_!!6000000004408-0-tps-689-487.jpg",
            "filename": "ticket.jpg",
            "mime": "image\/jpeg",
            "upload_kind": "image"
        }
    ],
    "extra": {
        "min_pixels": 3072,
        "max_pixels": 8388608
    }
}

req = urllib.request.Request(
    url,
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Content-Type": "application/json",
        "Authorization": "Bearer 你的应用ID-你的应用密钥",
    },
    method="POST",
)
with urllib.request.urlopen(req, timeout=120) as resp:
    print(resp.read().decode("utf-8"))

流式 · `POST …/v1/chat/stream`

import json
import urllib.request

url = "https://ai.wapi.cn/pyai/v1/chat/stream"
payload = {
    "model_id": 32,
    "messages": [
        {
            "role": "user",
            "content": "请识别图片中的全部文字内容，按原文顺序输出，不要添加额外说明。"
        }
    ],
    "temperature": 0.7,
    "max_tokens": null,
    "stream": true,
    "attachments": [
        {
            "url": "https:\/\/img.alicdn.com\/imgextra\/i2\/O1CN01ktT8451iQutqReELT_!!6000000004408-0-tps-689-487.jpg",
            "filename": "ticket.jpg",
            "mime": "image\/jpeg",
            "upload_kind": "image"
        }
    ],
    "extra": {
        "min_pixels": 3072,
        "max_pixels": 8388608
    }
}

req = urllib.request.Request(
    url,
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Content-Type": "application/json",
        "Authorization": "Bearer 你的应用ID-你的应用密钥",
    },
    method="POST",
)
with urllib.request.urlopen(req, timeout=300) as resp:
    for raw in resp:
        line = raw.decode("utf-8", errors="replace").rstrip(chr(10))
        if line:
            print(line)

非流式 · `POST …/v1/chat`

const url = "https://ai.wapi.cn/pyai/v1/chat";
const body = {
    "model_id": 32,
    "messages": [
        {
            "role": "user",
            "content": "请识别图片中的全部文字内容，按原文顺序输出，不要添加额外说明。"
        }
    ],
    "temperature": 0.7,
    "max_tokens": null,
    "stream": true,
    "attachments": [
        {
            "url": "https:\/\/img.alicdn.com\/imgextra\/i2\/O1CN01ktT8451iQutqReELT_!!6000000004408-0-tps-689-487.jpg",
            "filename": "ticket.jpg",
            "mime": "image\/jpeg",
            "upload_kind": "image"
        }
    ],
    "extra": {
        "min_pixels": 3072,
        "max_pixels": 8388608
    }
};

fetch(url, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer 你的应用ID-你的应用密钥",
  },
  body: JSON.stringify(body),
})
  .then((r) => r.text())
  .then(console.log)
  .catch(console.error);

流式 · `POST …/v1/chat/stream`（`fetch` 读 body 流）

(async () => {
  const url = "https://ai.wapi.cn/pyai/v1/chat/stream";
  const body = {
    "model_id": 32,
    "messages": [
        {
            "role": "user",
            "content": "请识别图片中的全部文字内容，按原文顺序输出，不要添加额外说明。"
        }
    ],
    "temperature": 0.7,
    "max_tokens": null,
    "stream": true,
    "attachments": [
        {
            "url": "https:\/\/img.alicdn.com\/imgextra\/i2\/O1CN01ktT8451iQutqReELT_!!6000000004408-0-tps-689-487.jpg",
            "filename": "ticket.jpg",
            "mime": "image\/jpeg",
            "upload_kind": "image"
        }
    ],
    "extra": {
        "min_pixels": 3072,
        "max_pixels": 8388608
    }
};
  const r = await fetch(url, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer 你的应用ID-你的应用密钥",
    },
    body: JSON.stringify(body),
  });
  const reader = r.body.getReader();
  const dec = new TextDecoder();
  while (true) {
    const { value, done } = await reader.read();
    if (done) break;
    process.stdout.write(dec.decode(value, { stream: true }));
  }
})().catch(console.error);

非流式 · `POST …/v1/chat`

<?php
$url = 'https://ai.wapi.cn/pyai/v1/chat';
$body = '{"model_id":32,"messages":[{"role":"user","content":"请识别图片中的全部文字内容，按原文顺序输出，不要添加额外说明。"}],"temperature":0.7,"max_tokens":null,"stream":true,"attachments":[{"url":"https:\\/\\/img.alicdn.com\\/imgextra\\/i2\\/O1CN01ktT8451iQutqReELT_!!6000000004408-0-tps-689-487.jpg","filename":"ticket.jpg","mime":"image\\/jpeg","upload_kind":"image"}],"extra":{"min_pixels":3072,"max_pixels":8388608}}';
$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'Authorization: Bearer 你的应用ID-你的应用密钥',
    ],
    CURLOPT_POSTFIELDS => $body,
    CURLOPT_TIMEOUT => 120,
]);
$out = curl_exec($ch);
curl_close($ch);
echo $out;

流式 · `POST …/v1/chat/stream`（`WRITEFUNCTION` 输出分块）

<?php
$url = 'https://ai.wapi.cn/pyai/v1/chat/stream';
$body = '{"model_id":32,"messages":[{"role":"user","content":"请识别图片中的全部文字内容，按原文顺序输出，不要添加额外说明。"}],"temperature":0.7,"max_tokens":null,"stream":true,"attachments":[{"url":"https:\\/\\/img.alicdn.com\\/imgextra\\/i2\\/O1CN01ktT8451iQutqReELT_!!6000000004408-0-tps-689-487.jpg","filename":"ticket.jpg","mime":"image\\/jpeg","upload_kind":"image"}],"extra":{"min_pixels":3072,"max_pixels":8388608}}';
$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'Authorization: Bearer 你的应用ID-你的应用密钥',
    ],
    CURLOPT_POSTFIELDS => $body,
    CURLOPT_TIMEOUT => 300,
    CURLOPT_WRITEFUNCTION => function ($c, $d) {
        echo $d;
        return strlen($d);
    },
]);
curl_exec($ch);
curl_close($ch);

非流式 · `POST …/v1/chat`（`java.net.http.HttpClient`）

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.time.Duration;

public class ApidocChatDemo {
    public static void main(String[] args) throws Exception {
        String url = "https://ai.wapi.cn/pyai/v1/chat";
        String body = "{\"model_id\":32,\"messages\":[{\"role\":\"user\",\"content\":\"请识别图片中的全部文字内容，按原文顺序输出，不要添加额外说明。\"}],\"temperature\":0.7,\"max_tokens\":null,\"stream\":true,\"attachments\":[{\"url\":\"https:\\/\\/img.alicdn.com\\/imgextra\\/i2\\/O1CN01ktT8451iQutqReELT_!!6000000004408-0-tps-689-487.jpg\",\"filename\":\"ticket.jpg\",\"mime\":\"image\\/jpeg\",\"upload_kind\":\"image\"}],\"extra\":{\"min_pixels\":3072,\"max_pixels\":8388608}}";
        HttpClient client = HttpClient.newBuilder()
                .connectTimeout(Duration.ofSeconds(30))
                .build();
        HttpRequest req = HttpRequest.newBuilder(URI.create(url))
                .timeout(Duration.ofSeconds(120))
                .header("Content-Type", "application/json")
                .header("Authorization", "Bearer 你的应用ID-你的应用密钥")
                .POST(HttpRequest.BodyPublishers.ofString(body))
                .build();
        HttpResponse<String> resp = client.send(req, HttpResponse.BodyHandlers.ofString());
        System.out.println(resp.statusCode());
        System.out.println(resp.body());
    }
}

流式 · `POST …/v1/chat/stream`（按行读取响应体）

import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.time.Duration;

public class ApidocChatStreamDemo {
    public static void main(String[] args) throws Exception {
        String url = "https://ai.wapi.cn/pyai/v1/chat/stream";
        String body = "{\"model_id\":32,\"messages\":[{\"role\":\"user\",\"content\":\"请识别图片中的全部文字内容，按原文顺序输出，不要添加额外说明。\"}],\"temperature\":0.7,\"max_tokens\":null,\"stream\":true,\"attachments\":[{\"url\":\"https:\\/\\/img.alicdn.com\\/imgextra\\/i2\\/O1CN01ktT8451iQutqReELT_!!6000000004408-0-tps-689-487.jpg\",\"filename\":\"ticket.jpg\",\"mime\":\"image\\/jpeg\",\"upload_kind\":\"image\"}],\"extra\":{\"min_pixels\":3072,\"max_pixels\":8388608}}";
        HttpClient client = HttpClient.newBuilder()
                .connectTimeout(Duration.ofSeconds(30))
                .build();
        HttpRequest req = HttpRequest.newBuilder(URI.create(url))
                .timeout(Duration.ofSeconds(300))
                .header("Content-Type", "application/json")
                .header("Authorization", "Bearer 你的应用ID-你的应用密钥")
                .POST(HttpRequest.BodyPublishers.ofString(body))
                .build();
        HttpResponse<InputStream> resp = client.send(req, HttpResponse.BodyHandlers.ofInputStream());
        try (BufferedReader br = new BufferedReader(
                new InputStreamReader(resp.body(), StandardCharsets.UTF_8))) {
            String line;
            while ((line = br.readLine()) != null) {
                System.out.println(line);
            }
        }
    }
}

已复制

# 千问 OCR · Qwen-VL-OCR · AI 网关 HTTP 接口

- **模型 ID**：`32`（请求体字段 `model_id`）
- **网关 Base URL**：`https://ai.wapi.cn/pyai`（接口路径在其后拼接，如 `/v1/chat`）

## 鉴权（应用密钥）

HTTP 业务接口须在请求头携带 **Authorization**（Bearer 令牌）；格式见下表。Cookie 仅站内网页兼容，**对外 HTTP 对接以 Bearer 应用密钥为准**。

### 请求头

| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `Authorization` | string | 是 | Bearer 令牌，格式为 <code>Bearer {应用ID}-{应用密钥}</code>（仅在第一个 <code>-</code> 处分割，密钥本身可含连字符）。应用 ID 与密钥在会员中心「我的应用」获取。兼容 OpenAI SDK：将 <code>{应用ID}-{应用密钥}</code> 作为 <code>api_key</code> 传入即可自动携带本请求头。 |

## POST /v1/chat

- **Content-Type**：`application/json`
- **说明**：非流式，一次返回完整 JSON 响应体（字段与网关公开响应结构一致）。
- **多轮**：每次须在 `messages` 中带齐上下文；网关不会自动补全历史。

### 请求体根字段

| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `model_id` | int | 是 | 模型主键；本页文档对应 `model_id=32`。 |
| `messages` | array | 是 | 消息对象数组（见 messages[]）。至少一条；多轮时须在数组内按顺序包含完整历史（user/assistant/system 等）。按本次列表处理对话，不自动补全缺省轮次。 |
| `temperature` | number | 否 | 采样温度，默认 0.7；是否生效取决于具体模型。 |
| `max_tokens` | int 或 null | 否 | 生成长度上限（token）；null 表示使用默认。 |
| `stream` | bool | 否 | 请求体字段，默认 false。**是否流式由 URL 决定**：流式请 POST `/v1/chat/stream`；`/v1/chat` 为非流式。勿仅靠本字段切换 SSE。 |
| `attachments` | array | 否 | 附件数组，默认 []（见 attachments[]）。服务端会把附件整理为模型可识别的上下文（如追加 system 说明 URL 列表）。 |
| `extra` | object | 否 | 任意 JSON 对象，默认 {}。模型专有参数放于此（如数字人 image_url/audio_url/parameters；文生图/视频类 prompt、尺寸等）。服务端可能合并内部保留字段；请勿使用以下划线 `_` 开头的键名作为业务自定义字段。 |

### messages[] 单条消息

| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `role` | string | 是 | 角色：如 user、assistant、system 等，与 OpenAI Chat Completions 约定一致。 |
| `content` | string | 是 | 该轮文本内容。多轮时 assistant 一般为上一轮模型输出，由客户端保存后在后续请求的 messages 中写回。 |
| `images` | array 或 null | 否 | 历史消息中的多模态图片结构，会话回放用；元素为对象，字段因模型而异。 |
| `audios` | array 或 null | 否 | 历史消息中的音频结构，会话回放用。 |

### attachments[] 单条附件

| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `url` | string | 是 | 附件可访问 URL（须能被服务端拉取）。 |
| `filename` | string 或 null | 否 | 原始文件名，便于展示或日志。 |
| `mime` | string 或 null | 否 | MIME 类型，如 image/png。 |
| `extra` | object | 否 | 附件级扩展信息，默认 {}。 |

**须上传 1 张图片**（`attachments`，`upload_kind=image`，仅 1 项）；网关转为多模态 `content`。流式请 **`POST /v1/chat/stream`**。模型 **`model`**（`qwen-vl-ocr-latest`）由服务端配置。

### 本页示例 JSON 涉及字段（model_id=32 · 千问 OCR）

| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `model_id` | int | 是 | 须为 `32`。 |
| `messages` | array | 是 | 至少一条 user 消息；`content` 为 OCR 指令文本。 |
| `messages[].role` | string | 是 | `user` / `assistant` / `system`。 |
| `messages[].content` | string | 是 | 识别/抽取指令；可与图片附件配合。 |
| `attachments[]` | array | 是 | 图片附件，**仅 1 张**（见 attachments[]）。 |
| `attachments[].url` | string | 是 | 图片可访问 URL（OSS 临时地址）。 |
| `attachments[].upload_kind` | string | 否 | 建议 `image`。 |
| `extra.min_pixels` | int | 否 | 图像最小像素阈值，默认 3072（32×32×3）。 |
| `extra.max_pixels` | int | 否 | 图像最大像素阈值，默认 8388608（8192×32×32）。 |
| `stream` | bool | 否 | 流式请用 **`/v1/chat/stream`**。 |

### 响应根字段

| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `model_id` | int | 是 | 本次调用的模型 ID。 |
| `content` | string | 是 | 主文本回复；异步类模型常为说明文案，资源见 images/audios/videos 或 raw。 |
| `raw` | object | 是 | 扩展载荷（默认 {}）。常含原始响应字段、用量、异步任务标识（如 job_id）等，结构因模型而异。 |
| `images` | array 或 null | 否 | 结构化图片列表；元素多为含 url 的对象，供预览/下载。 |
| `audios` | array 或 null | 否 | 结构化音频列表；元素一般含可播放 url。 |
| `videos` | array 或 null | 否 | 视频任务占位或结果列表；异步场景常与 `raw.video_task` 等配合，用于取 job_id 轮询 `/v1/video-task/{job_id}`。 |

## POST /v1/chat/stream

请求体与 **`/v1/chat`** 非流式接口相同；流式响应为 **SSE**（`Content-Type: text/event-stream`），事件见下表。

### SSE 事件

| 事件名 | data 说明 |
| --- | --- |
| `ready` | 首帧；data 为 JSON（如含本轮元信息等，具体以网关实现为准）。 |
| `delta` | 增量；data 为 JSON，至少含 `model_id`、`delta`（文本分片）；可含 `phase`、`images`、`audios`、`videos` 等与模型相关的字段。 |
| `done` | 结束帧；data 为 JSON，含 `done: true`、`audios`、`videos` 等。正文通常由客户端将此前 delta 拼接得到（本帧不一定重复全文）。 |
| `error` | 异常；data 为 JSON，含 `error` 及可选的调试摘要（视部署而定）。 |

## GET /v1/auth/status

校验当前鉴权；成功时返回 `user_id` 与 `balance`（元），字段见下表。

### 响应字段

| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `ok` | bool | 是 | 请求是否被服务端正常处理（业务上是否已登录见 logged_in）。 |
| `logged_in` | bool | 是 | 是否已通过鉴权（应用密钥或站内 Cookie 等网关认可的登录态）。 |
| `user_id` | int | 条件 | 已登录时返回会员用户 ID。 |
| `balance` | number | 条件 | 已登录时返回账户余额（元，由分转换）。 |
| `message` | string | 条件 | 未登录或异常时的提示文案。 |

## GET /v1/video-task/{job_id}

查询当前身份下的异步视频任务（路径参数 `job_id` 为整数主键，通常来自上一轮响应中的视频任务占位信息）。**成功**为 HTTP 200 + JSON；**不存在或无权限**一般为 **HTTP 404**。

### 响应 JSON（根级 ok + task）

| 字段名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| `ok` | bool | 是 | 响应根级。HTTP 200 且查到任务时为 true，且同层含 `task` 对象；无权限或任务不存在时一般为 HTTP 404（响应体依框架，不一定含本结构）。 |
| `task.id` | int | 条件 | 任务主键。 |
| `task.model_id` | int | 条件 | 任务关联模型 ID。 |
| `task.dashscope_task_id` | string | 条件 | 异步任务标识（如有）。 |
| `task.task_status` | string | 条件 | 任务状态字符串，轮询直至终态。 |
| `task.video_url` | string 或 null | 否 | 成功时可下载的视频地址（链接有效期以业务说明为准，如约 24 小时）。 |
| `task.last_error` | string 或 null | 否 | 失败时的错误信息。 |
| `task.usage` | object 或 null | 否 | 用量 JSON（若有）。 |
| `task.created_at` | string | 条件 | 创建时间。 |
| `task.updated_at` | string | 条件 | 最近更新时间。 |

## GET /health

健康检查，**无需鉴权**。返回 JSON：`ok`、`models`（支持的 `model_id` 列表）、`revision`、`boot_at` 及各模型版本信息等。

## 千问 OCR · Qwen-VL-OCR（model_id=32）

OpenAI 兼容对话接口；请使用 **`POST /v1/chat`** / **`POST /v1/chat/stream`** 调用。

- **图片 OCR**：`attachments` 上传 **1 张**图片，网关转为 `image_url` + `min_pixels` / `max_pixels`。
- **识别指令**：user 文本描述提取规则；未填时使用默认识别提示。
- **可选**：`extra.min_pixels`、`extra.max_pixels` 覆盖默认像素阈值。
- **计费**：输入 **0.0051**、输出 **0.0085**（元/10K词元）。

## 请求示例（占位符）

- `Authorization`: `Bearer 你的应用ID-你的应用密钥`

### 请求 JSON 示例（与页面「调用示例」一致）

```json
{
    "model_id": 32,
    "messages": [
        {
            "role": "user",
            "content": "请识别图片中的全部文字内容，按原文顺序输出，不要添加额外说明。"
        }
    ],
    "temperature": 0.7,
    "max_tokens": null,
    "stream": true,
    "attachments": [
        {
            "url": "https:\/\/img.alicdn.com\/imgextra\/i2\/O1CN01ktT8451iQutqReELT_!!6000000004408-0-tps-689-487.jpg",
            "filename": "ticket.jpg",
            "mime": "image\/jpeg",
            "upload_kind": "image"
        }
    ],
    "extra": {
        "min_pixels": 3072,
        "max_pixels": 8388608
    }
}
```

千问 OCR · Qwen-VL-OCR

请求头（鉴权）

POST /v1/chat、POST /v1/chat/stream — JSON 请求体根字段

messages[] — 单条消息

attachments[] — 单条附件

本页示例 JSON 涉及字段（model_id=32 · 千问 OCR）

POST /v1/chat — 响应 JSON

GET /v1/auth/status — 响应字段

POST /v1/chat/stream — SSE 事件

GET /v1/video-task/{job_id} — 路径与响应（根级 ok + task）

非流式 · `POST …/v1/chat`

流式 · `POST …/v1/chat/stream`（`-N` 禁用缓冲）

非流式 · `POST …/v1/chat`

流式 · `POST …/v1/chat/stream`

非流式 · `POST …/v1/chat`

流式 · `POST …/v1/chat/stream`（`fetch` 读 body 流）

非流式 · `POST …/v1/chat`

流式 · `POST …/v1/chat/stream`（`WRITEFUNCTION` 输出分块）

非流式 · `POST …/v1/chat`（`java.net.http.HttpClient`）

流式 · `POST …/v1/chat/stream`（按行读取响应体）

全国400服务热线：400-995-9993

数据源

联系我们

关注微信公众号

千问 OCR · Qwen-VL-OCR

请求头（鉴权）

POST /v1/chat、POST /v1/chat/stream — JSON 请求体根字段

messages[] — 单条消息

attachments[] — 单条附件

本页示例 JSON 涉及字段（model_id=32 · 千问 OCR）

POST /v1/chat — 响应 JSON

GET /v1/auth/status — 响应字段

POST /v1/chat/stream — SSE 事件

GET /v1/video-task/{job_id} — 路径与响应（根级 ok + task）

非流式 · POST …/v1/chat

流式 · POST …/v1/chat/stream（-N 禁用缓冲）

非流式 · POST …/v1/chat

流式 · POST …/v1/chat/stream

非流式 · POST …/v1/chat

流式 · POST …/v1/chat/stream（fetch 读 body 流）

非流式 · POST …/v1/chat

流式 · POST …/v1/chat/stream（WRITEFUNCTION 输出分块）

非流式 · POST …/v1/chat（java.net.http.HttpClient）

流式 · POST …/v1/chat/stream（按行读取响应体）

其它相关大模型

全国400服务热线：400-995-9993

数据源

联系我们

关注微信公众号

非流式 · `POST …/v1/chat`

流式 · `POST …/v1/chat/stream`（`-N` 禁用缓冲）

非流式 · `POST …/v1/chat`

流式 · `POST …/v1/chat/stream`

非流式 · `POST …/v1/chat`

流式 · `POST …/v1/chat/stream`（`fetch` 读 body 流）

非流式 · `POST …/v1/chat`

流式 · `POST …/v1/chat/stream`（`WRITEFUNCTION` 输出分块）

非流式 · `POST …/v1/chat`（`java.net.http.HttpClient`）

流式 · `POST …/v1/chat/stream`（按行读取响应体）