题小小作文开放平台提供作文批改接口，供广大教育厂家、机构调用，植入到自己的产品中

接口调用准备

请联系客服人员开通接口权限
需提供

  • 公司名称
  • 联系人姓名
  • 电话
  • 邮箱

鉴权规则

请联系客服人员获取token
接口调用限制：本接口仅限于服务端调用，前端调用或公开存储代码将导致泄露。token长期有效，若疑似泄露需立即联系项目对接人更换。

headers参数：

字段名称 类型 默认值 是否可选 说明
accessToken String - 否 联系项目对接人获取

接口返回规则

开放平台接口默认返回 JSON。

  • 大部分业务成功 / 业务失败场景返回 HTTP 200
  • 参数校验失败、accessToken 缺失或错误、权限不足等场景，后端可能直接返回 HTTP 4xx

常见返回字段如下：

字段 类型 必选 示例 解释
code Number 是 0 开放平台接口通常 1=成功、0=失败；少数历史接口可能出现 -1
msg String 否 “提交成功” 提示信息
data object/array 否 {“id”:”u3EDmPW”} 业务数据
detail object/array/string 否 {“status_code”:403,”message”:”accessToken错误或已过期”} 更详细的错误信息。参数校验失败时通常为数组，框架层异常时通常为对象

成功示例：

1
2
3
4
5
6
7
{
  "code": 1,
  "msg": "提交成功",
  "data": {
    "id": "u3EDmPW"
  }
}

失败示例（鉴权失败）：

1
2
3
4
5
6
7
8
{
  "code": 0,
  "msg": "accessToken错误或已过期",
  "detail": {
    "status_code": 403,
    "message": "accessToken错误或已过期"
  }
}

失败示例（参数校验失败）：

1
2
3
4
5
6
7
8
9
10
11
{
  "code": 0,
  "msg": "您提交的数据不正确",
  "detail": [
    {
      "type": "missing",
      "loc": ["body", "images"],
      "msg": "Field required"
    }
  ]
}

作文批改相关业务错误码说明（仅合作方）

在作文批改异步回调失败场景中，当顶层 code=0 时，data 中可能会附带更具体的业务错误码，方便合作方区分可重试与不可重试的情况：

字段 位置 类型 示例 说明
error_code data.error_code Number 1000 作文批改相关业务错误码

当前主要包含以下几类业务错误（如需扩展，会在文档中持续补充）：

error_code 场景说明 是否可重试 建议处理方式
1000 错别字占比超过约 85%，不予批改 否 上传更清晰的稿件、剪裁合适范围后再发起批改
1001 图片文字识别失败 / 有效文字过少 视情况 检查图片清晰度、裁剪范围（避免桌面/边框等干扰）后重试

说明：

  • 上述错误码主要用于作文批改相关接口的异步回调失败通知，详见《发送作文批改结果》。
  • 查询接口更适合补拉结果和排查问题，不保证每次都原样保留回调中的 error_code。
  • 其他开放接口通常只使用通用的 code / msg / detail 表示成功或失败。

查询账户

1. 请求说明

2. 请求参数

无

3. 返回响应

字段 类型 必选 示例 解释
code Number 是 1 开放平台接口通常 1=成功、0=失败；少数历史接口可能出现 -1
msg String 否 - 提示信息
data object 否 {“balance”: 0, “pro_balance”: 0, “amount”: 0} 核心数据

data内容

字段 类型 必选 示例 解释
balance Number 是 0 普通账户余额
pro_balance Number 是 0 Pro账户余额
amount Number 是 0 账户剩余金额（单位：分）