SciFig

API 参考文档

文字识别

先识别图像中的文字标签,再通过 `replace_text` 编辑修改文字。

请求与响应#

POST /images/text-detections 接受 {"image": "<file_id>"} 和 Idempotency-Key。所需权限范围:figures:generate。免费,同步返回 200:

{
  "id": "c222cd46-d923-4abf-aa28-cdc72ad06623",
  "object": "text_detection",
  "width": 2048,
  "height": 1536,
  "texts": [
    { "index": 0, "text": "Nucleus", "corners": [{ "x": 75, "y": 260 }, { "x": 241, "y": 260 }, { "x": 241, "y": 295 }, { "x": 75, "y": 295 }] }
  ]
}
  • texts 按阅读顺序排列;corners 是图像中各标签的像素坐标。
  • 重放相同密钥会返回同一识别结果,不会再次运行;相同密钥搭配其他图像返回 409 IDEMPOTENCY_CONFLICT。
  • 文字识别与网站共享每个账号每 15 分钟 20 次的限制;超出后返回 429 RATE_LIMITED。
  • 将 id 和同一张图传给 replace_text 编辑。该识别结果仅适用于对应图像和你的账号。
  • 输入图像为 PNG、JPEG 或 WebP 的 file_id。文字识别服务暂时失败时,返回 503 SERVICE_UNAVAILABLE 和 Retry-After:请用相同密钥重试。识别已运行但未产生结果时,返回 502 TASK_FAILED(TEXT_DETECTION_FAILED):请用新密钥重新发送。

cURL#

curl -X POST https://scifig.ai/api/v1/images/text-detections \
  -H "Authorization: Bearer $SCIFIG_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Prefer: wait=25" \
  -H "Content-Type: application/json" \
  -d '{
    "image": "<file_id>"
  }'

JavaScript#

const response = await fetch('https://scifig.ai/api/v1/images/text-detections', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SCIFIG_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    Prefer: 'wait=25',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "image": "<file_id>"
  }),
});
const result = await response.json();
console.log(response.status, result);

Python#

import os
import uuid

import requests

headers = {
    "Authorization": f"Bearer {os.environ['SCIFIG_API_KEY']}",
    "Idempotency-Key": str(uuid.uuid4()),
    "Prefer": "wait=25",
}
response = requests.post(
    "https://scifig.ai/api/v1/images/text-detections",
    headers=headers,
    json={
        "image": "<file_id>"
    },
    timeout=60,
)
print(response.status_code, response.json())