请求与响应示例
通过完整示例快速完成集成与调试
HTTP 请求示例
POST https://{your-api-domain}/sjccup
请求头:
Authorization: Bearer {YOUR_API_TOKEN}
Content-Type: application/json; charset=UTF-8
Body:
{
"media_id": "<BASE64_IMAGE_WITHOUT_PREFIX>",
"keep_distortion": false,
"keep_ori": true
}典型响应示例
成功响应
当请求合法且图片处理成功时,接口返回 code = 0,并在 data.data.mediaId 中返回去手写后的图片 Base64 字符串。
HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
"code": 0,
"data": {
"data": {
"mediaId": "<BASE64_PROCESSED_IMAGE>"
}
},
"message": "Success"
}业务错误响应
当上游服务返回业务错误时,接口会返回 error = "API_ERROR" 且 code 为非 0 的错误码。可以结合下方错误码表进行映射与提示。
HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=UTF-8
{
"error": "API_ERROR",
"code": 1004,
"message": "Image size error. Please ensure the image is less than 5MB and the longest side is less than 4000px."
}API 介绍
专门用于手写内容移除的人工智能技术,通过 RemoveHandwriting.com API 变得前所未有的简单。只需几行代码,您就可以将这项技术集成到您的应用程序中。
1
购买套餐
购买专用于 API 的套餐
2
查收专属邮件
购买完成后 2 小时内,您会收到一封包含专属 API 域名和 AppCode 的邮件。
3
使用代码示例
使用以下代码示例快速开始
4
调整参数
参考参数说明调整请求
身份验证
我们通过「专属 API 域名 + Bearer Token」对请求进行身份验证。购买 API 套餐后,我们会通过邮件将您的专属 API 域名和 Token 发给您。出于安全考虑,请不要公开或泄露您的 Token。
API 端点
POST https://{your-api-domain}/sjccup
请将 {your-api-domain} 替换为我们通过邮件发送给您的专属 API 域名。每位开发者都有独立的域名和 Token。
请求头
Authorization:
Bearer {YOUR_API_TOKEN}
请将 {YOUR_API_TOKEN} 替换为我们通过邮件发送给您的 Bearer Token。请妥善保管,不要提交到公共仓库。
Content-Type:
application/json; charset=UTF-8
代码示例
使用我们的代码示例快速开始
#!/usr/bin/env bash
set -euo pipefail
# Domain and token for the image processing proxy
API_DOMAIN="https://{your-api-domain}"
API_PATH="/sjccup"
API_TOKEN="{YOUR_API_TOKEN}"
# Image file passed as first argument (default: testpaper.jpg)
IMAGE_FILE="${1:-testpaper.jpg}"
if [ ! -f "$IMAGE_FILE" ]; then
echo "Image file not found: $IMAGE_FILE" >&2
echo "Usage: $0 path/to/image.jpg" >&2
exit 1
fi
echo "Encoding image to Base64: $IMAGE_FILE"
# Encode image to Base64 and remove newlines (use -i for BSD base64 on macOS)
BASE64_IMAGE=$(base64 -i "$IMAGE_FILE" | tr -d '
')
echo "Building JSON body..."
read -r -d '' JSON_BODY <<EOF || true
{
"media_id": "$BASE64_IMAGE",
"keep_distortion": false,
"keep_ori": true
}
EOF
echo "Calling proxy API..."
curl -X POST "${API_DOMAIN}${API_PATH}" \
-H "Authorization: Bearer ${API_TOKEN}" \
-H "Content-Type: application/json; charset=UTF-8" \
-d "$JSON_BODY" \
-o response.json \
-s -w "\nHTTP status: %{http_code}\n"
echo "Response saved to response.json"请求参数
使用这些参数配置您的 API 请求
| 参数 | 类型 | 描述 |
|---|---|---|
| media_id | string | 图片的 Base64 编码值,最长边不超过 4000px;移除前缀 data:image/png;base64 |
| keep_distortion | boolean | false – 自动纠正失真,true – 禁用纠正 |
| keep_ori | boolean | false – 图片将旋转到正确方向,true – 保持上传时的方向 |
错误代码
API 响应代码参考
| 错误代码 | 错误信息 | 描述 |
|---|---|---|
| 0 | success | Success |
| 1000 | body error | Request body error |
| 1001 | param error | Request parameter error |
| 1002 | content type error | Content-Type error |
| 1003 | image not exists | Image file not found |
| 1004 | image size error | Image size error |
| 1005 | image format error | Image format error |
| 1006 | invalid signature | Invalid signature |
| 1007 | body size error | Body size error |
| 1008 | no authorization | Authorization failed |
| 2000 | server unknown error | Server unknown error |
| 2001 | server timeout | Server timeout |
| 2003 | no content recognition | No content recognized |
| 2004 | validate data error | Validation data error |
| 3000 | remote server error | Remote server error |
| 4000 | base server error | Base server error |
API 定价方案
以下方案专用于 API
基础版
$499$0.10 / 积分
5,000 积分
6个月有效期
高可用、高稳定性,专为生产环境设计
最受欢迎
热门版
$799$0.08 / 积分
10,000 积分
6个月有效期
高可用、高稳定性,专为生产环境设计
专属
专属版
$3999$0.04 / 积分
100,000 积分
1年有效期
高可用、高稳定性,专为生产环境设计