Skip to content
CurriculoCurriculo ATS DocumentationDocs
API referenceConsole

API 概要

On this page

Curriculo API は、 https://api.curriculo.me/public にある RESTful API で、プログラムによるアクセスを提供するものです。同様の履歴書、評価、言語、インタビューエンジンが Curriculo 製品内で動作します。リクエストは JSON または multipart/form-data; 応答は JSON です.

Curriculo に新規の方は、 クイックスタートから始めてください: アカウントを作成し、キーを発行し、1 回の呼び出しを行います。

前提条件

利用可能なAPI

API運用機能料金
解析POST /parse/PDFまたはDOCXのCVを構造化されたJSONに読み込みます。1回のリクエストあたり$0.01
評価POST /evaluate/求人に対するCVの適性、フィット分析、ギャップのスコア付けを行います。1件あたり$0.01
求人POST /jobs/任意。求人説明を1回登録して再利用する job_id.無料
翻訳POST /translate/文字列またはPDFとDOCXドキュメントを翻訳する1件あたり$0.01（ 価格参照）)
言語を検出するPOST /detect-language/1つのテキストまたは最大200のISO 639-1コード1件あたり$0.001
面接要約POST /summary/トランスクリプトまたは録音からハイライト、レッドフラグ、スキル、および採用の推奨0.01ドル、さらに0.002ドルを1分あたりの録音料として請求
音声録音を文字起こしするPOST /transcribe/録音の文字起こし、要約はありません。1分あたり$0.002
プロンプトPOST /prompt/クレデンシャルにピン留めされた履歴書を生成、編集、翻訳、または質問します。ステートフルです。1回のリクエストあたり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 ドキュメントを参照するか、 Swagger UI または ReDoc で閲覧することができる。.

認証

ヘッダー値必須
AuthorizationBearer key_<id>_<secret>、あなたのコンソール API キーはい
Content-Typeapplication/json または multipart/form-data、操作によって異なるはい、ボディを持つリクエストの場合

1 つのコンソールキーですべての操作が認証される。エンドポイントごとの資格情報やスコープ、有効化するものは存在しない。 認証を参照してください。.

APIバージョンヘッダーはありません。サーフェスはパスでバージョン管理され、追加の変更（新しいオプションフィールド、新しい操作）が既存の呼び出しを破壊せずに配信されます。

ベースURL

https://api.curriculo.me/public

クライアントをそのベースに指し、操作パスを追加してください。例： https://api.curriculo.me/public/parse/.

  • 1つの資格情報でどこでも。 1つのコンソールキーですべての操作が認証されます。
  • キーごとに制限が適用されます。 したがって、1つのノイズのある統合では別の予算を使用できません。
  • 失敗したリクエストは決して課金されません。 4xx または 5xx ではコストがかかりません。

プロダクションは公開されている唯一の環境です。

リクエストとレスポンスの形式

リクエストとレスポンスを参照してください。短いバージョン：

  • /parse/, /evaluate/, /prompt/ および /transcribe/ を取得 multipart/form-data.
  • /detect-language/ および /jobs/ を取得 application/json.
  • /translate/ および /summary/ を取得 application/json、または multipart/form-data でドキュメントまたは録音を送信します。
  • 1つのドキュメントは最大10MBまでです。リクエストボディは最大12MBまでですが、 /summary/は最大100MBの録音をサポートします。
  • 1つのアイテムを送信すると、そのアイテムのオブジェクトが返されます。複数のアイテムを送信すると、入力順に結果が返されます。

バッチ処理

バッチ用の別々のエンドポイントはありません。リストがバッチです。パースと評価の場合、リクエストごとに最大10のドキュメント、翻訳と言語検出の場合、最大200のテキストです。 バッチ処理を参照してください。.

レート制限

制限値
APIキーごと1分あたり600リクエスト
IPアドレスごと1分あたり2,000リクエスト
重い作業（パース、評価、要約）同時に3つの操作が実行され、サービス全体で共有されます。追加のリクエストはキューに登録されます
リクエストのタイムアウト300秒

レート制限についてはこちら.

エラー

エラーはJSONであり、重要なHTTPステータスを持ちます。すべてのレスポンスには、サポートに引用する X-Curriculo-Request-Id ヘッダーが含まれます。 エラーについてはこちら.

アカウントの管理

キー、使用状況、請求は デベロッパーコンソールで管理されます。APIキーは採用業務を行います。キーをmintしたり、請求を変更したりすることはできないため、漏洩したキーがアカウントの管理権限に昇格することはありません

次のステップ

Updated