Skip to content
CurriculoCurriculo ATS DocumentationDocs
API referenceConsole

API 概述

On this page

Curriculo API 是一个RESTful API，位于 https://api.curriculo.me/public ，提供程序化访问同一简历、评估、语言和面试引擎，这些引擎运行在Curriculo产品内部。请求可以是JSON或 multipart/form-data；响应是JSON.

新到Curriculo？从 快速入门开始：创建账户、发行密钥并进行一次调用。

先决条件

可用API

API操作其功能价格
解析POST /parse/将简历（PDF或DOCX）读入结构化的JSON。每次请求0.01元
评估POST /evaluate/评估简历与工作的匹配度：适合度分析，缺口分析.每次请求0.01元
职位POST /jobs/可选。注册一个职位描述，然后重复使用其 job_id.免费
翻译POST /translate/翻译字符串或PDF和DOCX文档.每次请求0.01元（见 价格)
检测语言POST /detect-language/对于一段文本或最多200个字符的ISO 639-1代码每次请求0.001元
面试总结POST /summary/从录音或录制的内容中提取的亮点、警示、技能和招聘建议。基础费用0.01，加上每分钟0.002的录音费用
转录POST /transcribe/录音的文字记录，无摘要。每分钟$0.002
提示POST /prompt/生成、编辑、翻译或询问绑定到您的证书的简历。具有状态。每次请求0.01元
初步面试POST /screening-interview托管的录制面试，具有签名的回调。每发送邀请邮件收费0.02

后台任务

解析、评估、摘要、转录和翻译也可以在后台运行： POST /{op}/async 回答 202 ，一次以 task_id 的形式，并且您可以使用 GET /{op}/tasks/{task_id} 收集结果或通过签名回调接收。请参阅 后台处理和回调.

路径

同步操作以斜杠（/parse/）结尾。后台任务路径（/parse/async、/parse/tasks/{task_id}）和筛选路径（/screening-interview）在没有斜杠的情况下进行文档记录。

有关完整规范，请参阅 OpenAPI文档，或在 SwaggerUI 或 ReDoc中浏览.

身份验证

头部值必需
AuthorizationBearer key_<id>_<secret>，您的控制台API密钥是
Content-Typeapplication/json 或 multipart/form-data，取决于操作是的，在带有正文的请求中

一个控制台密钥授权所有操作，立即生效。没有每个端点的凭据，没有作用域，也没有需要启用的内容。请参阅 身份验证.

没有 API 版本头。该接口通过路径进行版本控制，新增的可选字段和操作将在不破坏现有调用的情况下发布。

基础 URL

https://api.curriculo.me/public

将客户端指向该基准并追加操作路径，例如 https://api.curriculo.me/public/parse/.

  • 一个凭据适用于所有地方。 单个控制台密钥对所有操作进行身份验证。
  • 限制对每个密钥强制执行， ，因此一个嘈杂的集成不能消耗另一个的预算。
  • 失败的请求永远不会被收费。 一个 4xx 或 5xx 不会花费您任何费用。

生产环境是唯一发布的环境。

请求和响应格式

请参阅 请求和响应。简短版本:

  • /parse/, /evaluate/, /prompt/ 和 /transcribe/ 接收 multipart/form-data.
  • /detect-language/ 和 /jobs/ 接收 application/json.
  • /translate/ 和 /summary/ 接收 application/json，或者 multipart/form-data 发送文档或录音。
  • 一个文档可以最多包含 10 MB。请求体可以最多包含 12 MB，除 /summary/外，后者可以接受最多 100 MB 的录音。
  • 发送一个项目，获取该项目的对象。发送多个，获取输入顺序的结果。

批处理

没有单独的批处理端点：列表就是批处理。解析和评估最多 10 个文档，每个请求最多 200 个文本用于翻译和语言检测。请参阅 批处理.

速率限制

限制值
每个 API 键每分钟600个请求
每个 IP 地址每分钟2,000个请求
重负荷工作（解析、评估、总结）同时进行3个操作，共享整个服务；额外请求排队
请求超时300秒

请参阅 限速.

错误

错误是 JSON 并携带重要的 HTTP 状态。每个响应都包含一个 X-Curriculo-Request-Id 标头，以便引用支持。请参阅 错误.

管理您的账户

密钥、使用情况和计费在 开发者控制台中管理。您的 API 密钥负责招聘工作。它故意不能创建密钥或更改计费，因此泄露的密钥永远不会升级为账户控制。

下一步

Updated