Skip to content

请求和响应

On this page

请求是JSON或 multipart/form-data;响应是JSON。每个响应都带有一个 X-Curriculo-Request-Id 头部。当您联系支持时,请引用它,以便我们可以找到确切的调用。

路径

  • 同步操作以斜杠结尾: /parse/, /evaluate/, /jobs/, /translate/, /detect-language/, /summary/, /transcribe/, /prompt/.
  • 后台任务路径在没有斜杠的情况下进行文档记录: /{op}/async 和 /{op}/tasks/{task_id}.
  • 筛选路径已记录,没有一个: /screening-interview 和 /screening-interview/{screening_id}.

内容类型

操作接受
/parse/, /evaluate/, /prompt/, /transcribe/multipart/form-data
/detect-language/, /jobs/, /screening-interviewapplication/json
/translate/application/json 用于文本,或 multipart/form-data 发送 PDF 或 DOCX 文档
/summary/application/json 用于转录,或 multipart/form-data 发送录音或转录文档
/{op}/asyncapplication/json 带有链接列表,或 multipart/form-data 上传(链接字段可以重复或每行发送一个)

请求大小限制

限制值适用于
请求体12 MB每次调用,除 /summary/外。 较大的请求在认证之前以 413 的方式在边缘被拒绝。
一份文档10 MBfiles, file, resume_pdfs, resume_pdf, job_file,以及发送到 /translate/
每次请求的文档数量10/parse/, /evaluate/, /translate/ (文件), /summary/ (面试或 media 文件)
每次请求的文本数量200/translate/, /detect-language/
字符50,000/translate/ (跨 texts的总数,以及每个文档), /detect-language/ (每个文本)
转录文本200,000 个字符/summary/ transcript_text
成绩单50 MB/summary/ PDF 或 DOCX 成绩单
录音,同步100 MB/summary/ media
录音,同步12 MB/transcribe/ media
上传到后台任务每个文件 12 MB/{op}/async 多部分
每个后台任务的链接数25file_urls, resume_urls
通过链接录制1 GB 和 2 小时/summary/async, /transcribe/async media_url

超过任何上限时,API 返回 413。拆分工作负载,或将长录音通过链接发送至 异步通道.

[!NOTE] 同步调用同样受 300 秒请求超时的限制。处理时间较长的大型录音会返回 504,因此对长时访谈建议使用 /summary/async

响应结构

所有接受列表的操作遵循一条规则: 发送单个项目,返回该项目的对象;发送多个时,按输入顺序为每个项目返回一个结果

多个项目返回每个输入对应的条目:

{
  "results": [
    { "index": 0, "status": "ok",    "data": { … } },
    { "index": 1, "status": "error", "error": { "status": 400, "detail": "…" } },
    { "index": 2, "status": "ok",    "data": { … } }
  ]
}

当批次本身被接受时,HTTP 状态保持 200 ,因此每个项目读取 status 。一个不可读的 CV 永不影响其余九个。详见 批处理.

使用和支出

响应不包含成本数据。调用、错误、延迟和估计费用在 控制台 → 使用中,按键可筛选。请参阅 定价和计费.

输入卫生

  • 在 JSON 体中重复的键(/translate/、/summary/、/detect-language/)将被拒绝, 400 命名键。
  • 带密码的 PDF 将被拒绝, 400。请删除密码并重新发送。
  • 字段名称区分大小写。

版本控制

没有 API 版本头。该接口通过路径进行版本控制,新增的可选字段和操作不会破坏现有的调用。编写客户端以忽略未知的响应字段。

Updated