REST API とは
外部サービスからBASEのデータにアクセスする仕組みです。
エンドポイント
利用可能な5つのAPIエンドポイントを紹介します。
トークン発行
API接続用のトークンを発行します。
ChatGPT GPTs 連携
ChatGPTのGPTsからBASEを使う設定手順です。
動作確認
curlコマンドでAPIの動作を確認します。
よくある質問
トラブル時の対処法やよくある疑問にお答えします。
REST API とは
BASE REST API を使うと、ChatGPT などの外部 AI サービスや自作アプリケーションから BASE のナレッジデータにアクセスできます。
REST API（このページ）
ChatGPT GPTs、Gemini、外部アプリなど幅広い AI サービスから接続できます。標準的な HTTP リクエストで利用可能。
MCP 接続（別ガイド）
Claude Desktop 専用の接続方式です。Claude Desktop をお使いの場合はこちらがおすすめです。
API 連携を行うと、Base に記録された内容が外部 AI サービスに送信されます。 パスワード、API キー、個人識別番号などの機密情報を含む Base は接続しないでください。
エンドポイント
5つの読み取り専用エンドポイントを提供しています。ベースURL: https://base.kodama.com/api/v1
GET /bases/{base_id}/info
Base の概要情報（名前、公開設定、総ページ数）を取得します。
GET /bases/{base_id}/pages
Base 内の全ページ一覧を表示順で取得します。
GET /bases/{base_id}/pages/{content_id}
指定ページの本文（Markdown）とメタ情報を取得します。
GET /bases/{base_id}/search?q={keywords}
キーワードでページのタイトル・本文を検索し、スコア順で返します。
GET /bases/{base_id}/tree
ページの階層構造をネストされたツリー形式で取得します。
API トークンを発行する
API にアクセスするための「鍵」を発行します。この鍵をAPI トークンと呼びます。
-
トークン発行ページを開く
BASE にログインした状態で、マイページの「API Token」リンクをクリックしてトークン発行ページを開きます。
-
トークンを作成する
以下の設定で新しいトークンを作成します:
スコープ readを選択（読み取り専用）許可する Base 接続したい Base の ID を入力（必ず設定してください） 有効期限 お好みで選択（迷ったら「90日」がおすすめ） 「許可する Base」は必須項目です。トークンは指定した Base にのみアクセスできます。他の Base のデータが AI に送信されることはありません。 -
トークンをコピーして保存する
作成されたトークンが表示されます。
kid_で始まる長い文字列です。 この画面を閉じると二度と表示されません。必ずコピーして安全な場所に保存してください。
ChatGPT GPTs を設定する
ChatGPT の GPTs（カスタム GPT）に BASE を接続します。
-
GPT を作成する
ChatGPT で「GPT を作成」（または「Explore GPTs」→「Create」）を開きます。
-
Instructions を設定する
GPT の「Instructions」に、Base の用途と ID を記載します。
Instructions の記載例:
- 「Base ID
my-knowledgeのナレッジベースから情報を検索・取得して回答してください。」 - 「ユーザーの質問に関連するページを searchPages で検索し、必要に応じて getPage で本文を取得してから回答してください。」
- 「Base ID
-
Actions を追加する
「Configure」タブで「Actions」→「Create new action」を選択します。
-
OpenAPI スキーマをインポートする
「Import from URL」をクリックし、以下の URL を入力します:
https://base.kodama.com/api/openapi.yamlインポートが完了すると、5つのエンドポイントが Actions として登録されます。
-
認証を設定する
Actions の認証設定で以下を入力します:
Authentication 「API Key」を選択 API Key 発行した KID トークン（ kid_xxx...）を入力Auth Type 「Bearer」を選択 -
保存して使う
「Save」で保存したら、GPT に話しかけてみましょう。BASE のナレッジを参照した回答が得られます。
おすすめのプロンプト:
- 「BASE にどんなページがありますか？」
- 「セキュリティに関するページを検索して」
- 「認証機構のページの内容を要約して」
動作確認（curl）
ターミナルから curl コマンドで API の動作を確認できます。
-
Base 情報を取得するcurl -H "Authorization: Bearer あなたのAPIトークン" \ https://base.kodama.com/api/v1/bases/your-base-id/info
-
ページ一覧を取得するcurl -H "Authorization: Bearer あなたのAPIトークン" \ https://base.kodama.com/api/v1/bases/your-base-id/pages
-
キーワードで検索するcurl -H "Authorization: Bearer あなたのAPIトークン" \ https://base.kodama.com/api/v1/bases/your-base-id/search?q=検索ワード
-
成功時のレスポンス例// GET /api/v1/bases/my-knowledge/info { "base_id": "my-knowledge", "description": "社内ナレッジベース", "view": "L", "total_pages": 42 }
--data-urlencode オプションを使用してください。よくある質問
お困りの際はこちらをご確認ください。
- 「UNAUTHORIZED」エラーが返る
-
API トークンが無効または期限切れです。トークン発行ページで新しいトークンを作成してください。
Authorization: Bearerのスペルが正しいかも確認してください。 - 「FORBIDDEN」エラーが返る
- 指定した Base ID に対して閲覧権限（Reader 以上）がありません。Base のオーナーにメンバー追加を依頼してください。Base ID のスペルが正しいかも確認してください。
- ChatGPT が API を呼んでくれない
- GPTs の Instructions に Base ID を明記し、「BASE の API を使って情報を検索してから回答してください」と指示を追加してみてください。 Actions の認証設定（Bearer トークン）が正しく保存されているかも確認してください。
- Claude Desktop で使いたい場合は？
- Claude Desktop には REST API ではなく、専用の MCP 接続がおすすめです。 MCP 接続ガイドをご覧ください。
- API で記事を編集できますか？
- 現在は読み取り専用です。API 経由での記事の作成・編集・削除はできません。記事の編集はこれまで通り BASE の Web サイトから行ってください。
- OpenAPI スキーマはどこにありますか？
- https://base.kodama.com/api/openapi.yaml で公開しています。 ChatGPT GPTs の Actions に「Import from URL」で直接インポートできます。