本サービスでは、サービス改善のためCookieとアナリティクスを利用しています。 詳細はプライバシーポリシーをご確認ください。
キャリアバンクAI の公開 API 仕様書です。現在、一般公開 API は準備中です。 エンタープライズ・パートナー向けの早期アクセスはこちらからお問い合わせください。
公開 API は Beta 利用可能です
読み取り専用エンドポイントと、APIキー認証による個人データ取得エンドポイントが利用できます。 APIキーは ダッシュボード から発行してください。
以下のエンドポイントは認証なしで利用できます。キャッシュは 1 時間（max-age=3600）です。
/api/v1/industries認証不要業界マスターデータ一覧（slug, label, avgSalary）を返します。
curl https://careerbankai.com/api/v1/industries
/api/v1/job-categories認証不要職種マスターデータ一覧（slug, label, category）を返します。
curl https://careerbankai.com/api/v1/job-categories
/api/v1/glossary認証不要転職用語集（slug, term, definition）の全件を返します。
curl https://careerbankai.com/api/v1/glossary
/api/v1/templates認証不要無料テンプレートのメタデータ一覧とダウンロードURLを返します。
curl https://careerbankai.com/api/v1/templates
全エンドポイントは以下の統一フォーマットで JSON を返します。
{
"data": [...], // リソース配列
"meta": {
"total": 30, // 総件数
"version": "1" // APIバージョン
}
}認証が必要なエンドポイントでは Authorization: Bearer ヘッダーに API キーを指定します。
curl -H "Authorization: Bearer cb_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" https://careerbankai.com/api/v1/me
レート制限: APIキー別 60 リクエスト / 60 秒。超過時は HTTP 429 を返します。
APIキーの発行方法
ダッシュボードの /dashboard/api-keys からAPIキーを発行できます。
/api/v1/me要認証認証ユーザーのプロフィールと各実績の集計を返します。
curl -H "Authorization: Bearer cb_xxx" https://careerbankai.com/api/v1/me
{
"error": {
"code": "RATE_LIMIT_EXCEEDED",
"message": "Too many requests. Retry after 60 seconds.",
"status": 429
}
}| HTTP Status | 説明 |
|---|---|
| 200 | 正常レスポンス |
| 400 | リクエストパラメータ不正 |
| 401 | 認証エラー（APIキー未指定 / 無効） |
| 429 | レート制限超過 |
| 500 | サーバー内部エラー |
以下はサービス内部で使用するエンドポイントです。外部からの利用は想定していません。
| エンドポイント | 用途 |
|---|---|
| /api/health | サービスとDB の死活確認 |
| /api/contact | お問い合わせフォーム送信（POST） |
| /api/qr/[slug] | QRコード画像生成 |
2026-05-12
公開エンドポイント（industries / job-categories / glossary / templates）初期リリース