サービスエンドポイントのリファレンス

このページ上のすべてのパスは、以下を基準としています：

https://api.champrep.com

「認証とAPIキー」に記載されているとおり、スコープ付きベアラークレデンシャルを使用してください。リストされているルートであっても、現在のサービスの可用性、プランおよび組織の設定、ロールの権限、リソースへのアクセス、およびリアルタイムの使用状況制御の対象となります。サービスマップ認証と API キーAPI。掲載されているルートは、現在のサービスの可用性、プランおよび組織の設定、ロールの権限、リソースへのアクセス、およびリアルタイムの使用状況制御の影響を受けます。

サービスマップ

エリア	プレフィックス	スコープ
ID およびプロフィール	`/v1/auth`, `/v1/users`	`users:read` および認証情報のコンテキスト
サービス横断検索	`/v1/search`	検索対象となる各サービスの読み取り範囲
Drive	`/v1/drive`	`drive:read`, `drive:write`, `drive:delete`
Chat	`/v1/chat`	`chat:read`, `chat:write`
Calendar	`/v1/calendar`	`calendar:read`, `calendar:write`
Contacts	`/v1/contacts`	`contacts:read`, `contacts:write`
Meet	`/v1/meet`	`meet:read`, `meet:write`
Notes	`/v1/notes`	`notes:read`, `notes:write`
Learn	`/v1/learn`, `/v1/courses`	`courses:read`, `courses:write`
CHAMPREP AI	`/v1/ai`	`ai:chat`
Mail	`/v1/mail`	`mail:read`, `mail:write`, `mail:send`
Work	`/v1/work`	`work:read`, `work:write`, `work:delete`
Org Chart	`/v1/charts`	`charts:read`, `charts:write`, `charts:delete`
Forms	`/v1/forms`	`forms:read`, `forms:write`
Invoice	`/v1/invoice`	`invoice:read`, `invoice:write`, `invoice:send`, `invoice:delete`
CHAMPREP QA	`/v1/qa`	`qa:read`, `qa:write`
CHAMPREP Business	`/v1/business`	`business:read`, `business:manage`
請求	`/v1/billing`	`billing:read`, `billing:manage`
Webhook	`/v1/webhooks`	`webhooks:manage`

GET, HEAD、および OPTIONS 通常、読み取りスコープが必要です。作成、更新、およびアクションメソッドには、書き込みまたは管理スコープが必要です。削除メソッドには、サービスで定義されている場合、削除スコープが必要です。ルートによっては、宛先サービスにおいて追加のロールまたはリソースの権限が必要となる場合があります。

ID およびゲートウェイの状態

方法	パス	目的
`GET`	`/v1/version`	Gatewayの公開バージョン情報を返します。
`GET`	`/v1/auth/whoami`	アクティブなユーザー、プロフィール、認証情報、およびプランのコンテキストを取得します。
`GET`	`/v1/auth/quota`	現在のキーおよびゲートウェイのクォータのスナップショットを取得します。
`GET`	`/v1/users/me`	現在のユーザーのプロフィールを取得します。
`GET`	`/v1/users/me/notifications`	現在のユーザーが確認できる通知を一覧表示します。

ブラウザを利用したデータCLI交換では、以下の機能も使用されます。 /v1/auth/cli/start, /v1/auth/cli/device、および /v1/auth/cli/poll。これらのルートは公式のによって実装されていますCLI。カスタムアプリケーションは、キーAPIで要件が満たされる場合、CLI承認プロトコルを模倣すべきではありません。

サービス横断検索

方法	パス	スコープ	目的
`GET`	`/v1/search`	サービスごとの詳細については、以下をご覧ください。	この認証情報でアクセス可能なすべてのサービスを、1回の呼び出しで検索してください。
`GET`	`/v1/search/services`	なし	この認証情報で検索可能なサービスをリストアップしてください。

/v1/search 検索をサポートする各サービスにリクエストを分散させ、結果を統合します。パラメータ：

パラメータ	デフォルト	目的
`q`	必須	検索語句。
`limit`	`5`	サービスごとの最大結果数は、最大 `20`.
`services`	すべて	カンマ区切りのリストの例： `mail,drive`。これにより、ファンアウトを絞り込むことができます。
`semantic`	`false`	設定 `true` AIを使用して検索結果の順位を再調整し、簡潔な回答を取得します。ご自身のAIクレジットが消費されます。

AI 機能付きスマート検索

semantic=true すでに表示されている検索結果の上にAIパスを追加します。AIパスは質問を読み取り、その回答の適切さに応じて一致する結果を並べ替え、それぞれに簡潔な理由を付加し、1段落分の answer.

この機能は、ご自身のAIクレジットで支払われます — これはアシスタントが CHAMPREP AI使用するのと同じ月間割り当て分です。ご自身でリクエストしない限り課金されることはなく、キーワード検索にはAIクレジットは一切消費されません。

すべての応答では、何が起きたかが以下のように報告されます： semantic:

"semantic": { "requested": true, "applied": true, "answer": "..." }

AIパスが実行できない場合、キーワードによる検索結果は変更されずに返され、 semantic 理由の説明：

`reason`	意味
`AI_CREDITS_EXHAUSTED`	今月のAIクレジットを使い切りました。
`PLAN_NO_AI`	ご利用のプランにはAIサービスが含まれていません。
`AI_UNAVAILABLE`	今回、AIサービスに接続できませんでした。

AIパスが失敗しても、検索自体が失敗することはありません。お電話にて /v1/search/services まず、スマート検索が利用可能かどうかをご確認ください。スマート検索では semantic.available さらに、残りのクレジットも表示されます。利用できない場合は、AIオプションを非表示にしてください。

サービスは、その認証情報に読み取りスコープが含まれている場合にのみ対象となります (mail:read, drive:read, notes:read, calendar:read, chat:read, work:read, invoice:read, contacts:read) そして 有効なプランで許可されている場合に限ります。どちらのチェックも失敗した場合はクローズされるため、利用できないサービスは結果に含まれることはありません。

Chat メッセージは保存時に暗号化され、検索はあなたが所属するルーム内でのみ行われ、アーカイブ全体ではなく最近の履歴を対象とします。

curl -H "Authorization: Bearer $CHAMPREP_API_KEY" \
  "https://api.champrep.com/v1/search?q=roadmap&services=mail,notes&limit=3"

結果はサービスごとにグループ化され、統一された形式に正規化されるため、クライアントはすべてのサービスを同じ方法でレンダリングします：

{
  "success": true,
  "data": {
    "query": "roadmap",
    "groups": [
      {
        "service": "notes",
        "label": "Notes",
        "results": [
          { "id": "6650...", "title": "Q3 roadmap", "subtitle": "Planning notes for...", "timestamp": "2026-08-02T10:14:00Z" }
        ]
      }
    ],
    "totalResults": 1,
    "searched": ["notes", "mail"],
    "skipped": [{ "service": "drive", "reason": "INSUFFICIENT_SCOPE" }],
    "cost": 2
  }
}

続きを読む skipped 空の結果を「何も見つかりませんでした」とみなす前に、各エントリにはそのサービスが除外された理由が説明されています — INSUFFICIENT_SCOPE, NOT_IN_PLAN、または SERVICE_UNAVAILABLE バックエンドの応答が遅すぎたり、一時的に接続できない場合などです。1つのサービスが利用できないからといって、クエリ全体が失敗することはありません。残りの結果は引き続き返されます。

検索にかかる費用

検索は結果グループごとに1つのサービスに到達するため、そのように課金されます： 実際に検索されたサービスごとに 1つのレート制限単位。 cost 各レスポンスのフィールドには、正確にどのような課金が行われたかが示されており、 X-RateLimit-Remaining レスポンスを受け取る前に反映されます。

リクエスト	検索されたサービス	費用
`?q=roadmap` 8つすべてを含むプランの場合	8	8
`?q=roadmap&services=mail`	1	1
`?q=roadmap` のみを含むプランの場合 Notes	1	1

利用できないサービスに対しては課金されることはありませんので、絞り込みを行うことで services は、対話型検索の応答性を維持するための最もコスト効率の良い方法です。常にデバウンスを行ってください。キー入力ごとにリクエストを送信することは避けてください。

Drive

方法	パス	スコープ	目的
`GET`	`/v1/drive/files`	`drive:read`	ファイルの一覧表示または検索を行います。以下の `search` 必要に応じてクエリを実行します。
`GET`	`/v1/drive/folders`	`drive:read`	ルートフォルダの内容を一覧表示します。
`GET`	`/v1/drive/folders/{folderId}`	`drive:read`	フォルダの内容を一覧表示します。
`GET`	`/v1/drive/starred`	`drive:read`	スター付きアイテムを一覧表示します。
`GET`	`/v1/drive/recent`	`drive:read`	最近使用した項目を一覧表示します。
`GET`	`/v1/drive/shared`	`drive:read`	共有アイテムを一覧表示します。
`GET`	`/v1/drive/quota`	`drive:read`	現在のストレージ使用量と空き容量を取得します。
`POST`	`/v1/drive/upload`	`drive:write`	アップロード先を作成します。
`POST`	`/v1/drive/files`	`drive:write`	アップロードが成功した後、ファイルのメタデータを保存します。
`POST`	`/v1/drive/download`	`drive:read`	ダウンロード先を作成します。
`POST`	`/v1/drive/folders`	`drive:write`	フォルダを作成します。
`POST`	`/v1/drive/rename`	`drive:write`	アイテムを移動または名前変更します。
`POST`	`/v1/drive/delete`	`drive:delete`	1つまたは複数の項目を削除します。
`DELETE`	`/v1/drive/files/{fileId}`	`drive:delete`	従来の単一アイテム処理手順でファイルを削除します。

アップロードは、アップロード先をリクエストし、そのアップロード先へデータを転送し、その結果として生成されたメタデータを保存するという、複数のステップからなる操作です。この一連の処理を独自に実装する必要がないCLI 場合は、公式のまたはSDK をご利用ください。

Chat

方法	パス	スコープ	目的
`GET`	`/v1/chat/rooms`	`chat:read`	アクティブなプロフィールから閲覧可能な会議室を一覧表示します。
`GET`	`/v1/chat/rooms/{roomId}`	`chat:read`	1つのルームを読み取ります。
`POST`	`/v1/chat/rooms`	`chat:write`	ルームを作成します。
`GET`	`/v1/chat/rooms/{roomId}/messages`	`chat:read`	ルームのメッセージを一覧表示します。
`POST`	`/v1/chat/rooms/{roomId}/messages`	`chat:write`	ルームメッセージを送信します。
`GET`	`/v1/chat/messages/search`	`chat:read`	メッセージを検索します。
`GET`	`/v1/chat/unread`	`chat:read`	未読件数を返します。
`GET`	`/v1/chat/favorites`	`chat:read`	お気に入りのメッセージを一覧表示します。

Calendar

方法	パス	スコープ	目的
`GET`	`/v1/calendar/events`	`calendar:read`	イベントの一覧表示；以下に対応しています `startDate` および `endDate` クエリ。
`GET`	`/v1/calendar/events/{eventId}`	`calendar:read`	1つの予定を読み取ります。
`POST`	`/v1/calendar/events`	`calendar:write`	イベントを作成します。
`PATCH`	`/v1/calendar/events/{eventId}`	`calendar:write`	イベントを更新します。
`DELETE`	`/v1/calendar/events/{eventId}`	`calendar:write`	イベントを削除します。
`GET`	`/v1/calendar/upcoming`	`calendar:read`	今後の会議を一覧表示します。
`GET`	`/v1/calendar/invitations`	`calendar:read`	保留中の招待状を一覧表示します。

イベントのタイムスタンプは、明示的なタイムゾーンを指定したISO 8601形式で送信されます。イベントの作成および更新には、アクティブなプランおよび組織に設定されたクォータが消費されます。このサービスでは、プランごとの一律の固定制限は定義されてAPIいません。

Contacts

方法	パス	スコープ	目的
`GET`	`/v1/contacts`	`contacts:read`	連絡先を一覧表示します。
`GET`	`/v1/contacts/search`	`contacts:read`	で連絡先を検索します。 `q` または `email`.
`GET`	`/v1/contacts/favorites`	`contacts:read`	お気に入りを一覧表示します。
`GET`	`/v1/contacts/labels`	`contacts:read`	ラベルを一覧表示します。
`GET`	`/v1/contacts/{contactId}`	`contacts:read`	1件の連絡先を読み取ります。
`POST`	`/v1/contacts`	`contacts:write`	連絡先を追加します。
`PUT`	`/v1/contacts/{contactId}`	`contacts:write`	連絡先のメタデータを更新します。
`DELETE`	`/v1/contacts/{contactId}`	`contacts:write`	連絡先を削除します。

Meet

方法	パス	スコープ	目的
`GET`	`/v1/meet/rooms`	`meet:read`	会議室を一覧表示します。
`GET`	`/v1/meet/rooms/{roomId}`	`meet:read`	1つのルームを読み取ります。
`POST`	`/v1/meet/rooms`	`meet:write`	ルームを作成します。
`GET`	`/v1/meet/sessions`	`meet:read`	ミーティングのセッションを一覧表示します。
`GET`	`/v1/meet/sessions/{sessionId}/participants`	`meet:read`	セッションの参加者を一覧表示します。
`GET`	`/v1/meet/recordings`	`meet:read`	利用可能な録画を一覧表示します。
`GET`	`/v1/meet/transcriptions`	`meet:read`	文字起こしを一覧表示します。
`GET`	`/v1/meet/transcriptions/{sessionId}`	`meet:read`	最終セッションの文字起こしを読み取ります。
`GET`	`/v1/meet/usage`	`meet:read`	現在のミーティングの利用状況を返します。

録音および文字起こしへのアクセスは、会議の所有権、同意、保存期間、プラン、および組織のポリシーによって異なります。

Notes

方法	パス	スコープ	目的
`GET`	`/v1/notes`	`notes:read`	ノートを一覧表示します。
`GET`	`/v1/notes/shared`	`notes:read`	アクティブなプロフィールと共有されているノートを一覧表示します。
`GET`	`/v1/notes/{noteId}`	`notes:read`	1つのノートを読み取ります。
`POST`	`/v1/notes`	`notes:write`	メモを作成します。
`PATCH`	`/v1/notes/{noteId}`	`notes:write`	ノートを更新します。
`DELETE`	`/v1/notes/{noteId}`	`notes:write`	メモを削除します。
`POST`	`/v1/notes/{noteId}/share`	`notes:write`	サポートされているアクセス設定を使用して、ノートを共有します。

Learn およびコース

/v1/learn および /v1/courses 同じ厳選されたコースのルートを公開します。

方法	パス	スコープ	目的
`GET`	`/v1/learn`	`courses:read`	利用可能なコースを一覧表示します。
`GET`	`/v1/learn/enrolled/my`	`courses:read`	アクティブなユーザーの受講登録を一覧表示します。
`GET`	`/v1/learn/{courseId}`	`courses:read`	1つのコースを読み取ります。
`GET`	`/v1/learn/{courseId}/sections`	`courses:read`	コースのセクションを一覧表示します。
`POST`	`/v1/learn`	`courses:write`	ロールで許可されている場合、コースを作成します。
`PUT`	`/v1/learn/{courseId}`	`courses:write`	ロールで許可されている場合、コースを更新します。

以下の /v1/courses そのエイリアスをすでに使用している統合を維持する場合は、代わりにプレフィックスを使用してください。

CHAMPREP AI

方法	パス	スコープ	目的
`POST`	`/v1/ai/chat`	`ai:chat`	プロンプトまたはサポートされている会話ペイロードを送信します。
`GET`	`/v1/ai/conversations`	`ai:chat`	保存された会話の一覧を表示します。
`GET`	`/v1/ai/conversations/{conversationId}`	`ai:chat`	1つの会話を読み取ります。
`DELETE`	`/v1/ai/conversations/{conversationId}`	`ai:chat`	会話を削除します。
`GET`	`/v1/ai/usage`	`ai:chat`	現在の AI の使用状況を返します。

AIの出力は不完全または不正確な場合があります。重要な出力内容は確認し、アクティブなユーザーが開示する権限を持たないデータを送信しないでください。

Mail

方法	パス	スコープ	目的
`GET`	`/v1/mail/accounts`	`mail:read`	接続済みのメールアカウントを一覧表示します。
`GET`	`/v1/mail/emails`	`mail:read`	メッセージを一覧表示します。
`GET`	`/v1/mail/emails/{emailId}`	`mail:read`	1 つのメッセージを読み取ります。
`GET`	`/v1/mail/threads`	`mail:read`	スレッドを一覧表示します。
`GET`	`/v1/mail/threads/{threadId}`	`mail:read`	1つのスレッドを読み取ります。
`POST`	`/v1/mail/send`	`mail:send`	メッセージを送信します。
`GET`	`/v1/mail/domains`	`mail:read`	表示可能なメールドメインを一覧表示します。

Work

「GatewayWork」サーフェスは、以下のサポート対象のバージョン管理された WorkAPIを反映しています。 /v1/work。ゲートウェイは、HTTPメソッドから必要なスコープを判別します：

読み取りメソッドには work:read.
`create` および `update` メソッドには `` が必要です。 work:write.
削除メソッド、および破壊的な一括処理やインポートのキャンセル操作には、 work:delete.

一般的なルートには以下が含まれます：

方法	パス	目的
`GET`, `POST`	`/v1/work/boards`	ボードを一覧表示または作成します。
`GET`, `PUT`, `DELETE`	`/v1/work/boards/{boardId}`	ボードの読み取り、更新、またはアーカイブを行います。
`GET`	`/v1/work/boards/{boardId}/kanban`	ボードのカンバンビューを読み取ります。
`GET`	`/v1/work/boards/{boardId}/export/csv`	ボードをCSV形式でエクスポートします。
`GET`	`/v1/work/boards/{boardId}/export/json`	構造化されたボードのスナップショットをエクスポートします。
`GET`, `POST`	`/v1/work/tickets`	チケットを検索または作成します。
`GET`, `PUT`, `DELETE`	`/v1/work/tickets/{ticketId}`	チケットの読み取り、更新、またはアーカイブを行います。
`GET`	`/v1/work/me/dashboard`	アクティブなダッシュボードWorkの概要を取得します。
`GET`	`/v1/work/me/quota`	現在のの使用Work状況と制限を返します。
`GET`, `POST`	`/v1/work/import/jobs`	サポートされているインポートジョブを一覧表示または管理します。

ボード、チケット、スプリント、自動化、インポート、時間記録、コメント、添付ファイル、保存済みビュー、およびワークスペースのメンバーシップについては、Gatewayのスコープチェック後も、それぞれのWork ロールおよびリソース権限が引き続き適用されます。

Org Chart

「」サーフェOrg Chartスは、以下の下に利用可能です。 /v1/charts。読み取りメソッドには以下が必要です charts:read、作成および更新メソッドには以下が必要です charts:write、および削除メソッドには以下が必要です charts:delete.

一般的なルートには以下が含まれます：

方法	パス	目的
`GET`	`/v1/charts/me/org-chart`	アクティブなユーザーのチャートを読み取ります。
`GET`	`/v1/charts/me/position`	アクティブなチャートの位置を確認してください。
`GET`	`/v1/charts/me/connections`	関係接続の読み取り。
`GET`	`/v1/charts/me/suggestions`	関係性の提案を確認してください。
`GET`	`/v1/charts/users/search`	ユーザーを検索して、チャートの関連性を確認してください。
`GET`	`/v1/charts/orgs/{orgId}/chart`	組織図を読み取ります。
`PATCH`	`/v1/charts/orgs/{orgId}/config`	チャート設定を更新します。
`POST`	`/v1/charts/orgs/{orgId}/chart/nodes`	チャートノードを作成します。
`PATCH`, `DELETE`	`/v1/charts/orgs/{orgId}/chart/nodes/{nodeId}`	ノードを更新または削除します。

拡張サービスインターフェース

また、Gateway では以下のバージョン管理されたサービスプレフィックスも公開されています：

プレフィックス	読み取りスコープ	書き込みまたはアクションのスコープ	スコープの削除
`/v1/forms`	`forms:read`	`forms:write`	—
`/v1/invoice`	`invoice:read`	`invoice:write`; アクションの送信または発行には以下を使用します `invoice:send`	`invoice:delete`
`/v1/qa`	`qa:read`	`qa:write`	—
`/v1/business`	`business:read`	`business:manage`	—
`/v1/billing`	`billing:read`	`billing:manage`	—

これらのプレフィックスを使用することで、Gatewayの下位にあるサポート対象のリソースサフィックスを維持しつつ、認証、サービスへのアクセス、スコープ、レート制限、および監査コンテキストを一元化できます。ブラウザのトラフィックからリソースパスを推測するのではなく、公式サービス、 SDKまたはサービスによって明示的に公開されているルートを使用することを推奨します。

課金はコントロールプレーンのインターフェースです。宛先サービスのゲートウェイによってユーザーが支払いの修正やアップグレードを行えなくなった場合でも、 API Gatewayアクセス、レート制限、および課金スコープの対象となります。

Webhook

Webhook管理では以下を使用します /v1/webhooks および webhooks:manage。詳細は、専用の Webhookガイドエンドポイントの登録、署名付き配信の検証、リプレイ保護、およびシークレットのローテーションについては、専用のWebhookガイドをご参照ください。

統合機能を最新の状態に保つ

使用 GET /v1/version Gatewayのバージョン情報については、こちらをご参照ください。
クライアントが認識できない追加のレスポンスフィールドは無視してください。
プランの値をハードコーディングするのではなく、リアルタイムのリミットヘッダーを読み取ってください。
最小権限のスコープセットを使用してください。
新しいルートを採用する際は、ドキュメントサイトおよびリリースSDKノートに従ってください。