学术参考文献真实性核查 API

身份验证

在 Citely 账户后台创建 API Key，并把它作为 Bearer Token 发送。请妥善保存完整的 sk- 值；如有泄露，应立即撤销。

Authorization: Bearer sk-your-citely-api-key

Codex 官方插件使用 OAuth。直接调用 REST API 或本地安装插件时，继续使用 Citely API Key。

计费与限制

• 每 1 个 Citely Credit 最多核查 4 条文献。
• 每个任务可提交 1–80 条文献；每条文献最多 5,000 个字符。
• 每位用户每分钟最多发起 3 个新任务。
• 技术失败不属于文献结论，并按照 Citely 现有计费规则退回适用的 Credits。

发起文献真实性核查

只提交参考文献字符串。响应会返回任务 ID 和建议的轮询间隔。

请求参数

代码示例

curl https://citely.ai/api/v1/citation-checks \
  -X POST \
  -H "Authorization: Bearer sk-your-citely-api-key" \
  -H "Idempotency-Key: your-unique-request-id" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "id": "ref-1",
        "content": "Vaswani et al. Attention Is All You Need. 2017."
      }
    ],
    "locale": "en-US"
  }'

响应

查询任务进度和结果

至少等待 pollAfterSeconds 后再轮询；任务状态变为 completed 或 failed 后停止。

请求参数

代码示例

curl https://citely.ai/api/v1/citation-checks/{jobId} \
  -H "Authorization: Bearer sk-your-citely-api-key"

响应

核查结果说明

文献核查结论和任务状态相互独立。已完成的任务可以包含下面三种文献结果。

verified

有可靠证据支持这条文献的元数据。

mismatch

找到了可能对应的出版物，但重要元数据不一致。

not_found

必需数据源成功完成查询后，仍未找到可靠匹配；这不等于确认文献是虚假的。

error

条目级技术失败不是文献结论。retryable 为 true 时可重试，并按 Citely 现有规则退回适用的 Credits。

常见错误

authentication_required · 401

身份验证缺失、无效或已撤销。

insufficient_credits · 402

账户 Credits 余额不足。

idempotency_conflict · 409

同一个幂等键被用于不同内容。

rate_limited · 429

等待 retryAfterSeconds 后再重试。

service_unavailable · 503

使用相同幂等键进行安全重试。