REST API

Skimle のプロジェクトを基盤に開発する

プロジェクトデータの読み書きと、プロジェクトを最初から最後まで実行するための JSON エンドポイント。Bearer キーで認証し、アクションを送信すれば、JSON が返ってきます。

3つのステップで始める

ゼロから最初の認証済みリクエストまで。

1

API キーを作成

プロジェクトキーは1つのプロジェクトにアクセスできます。アカウントキーは1つのチームにアクセスでき、その中にプロジェクトを作成できます。どちらにも閲覧と編集のレベルがあります。

  1. 1. API キーのページを開く
  2. 2. キーでアクセスするプロジェクトを選び、閲覧または編集の権限を選択
  3. 3. キーをコピー(Skimle はハッシュのみを保存します)

キーはすぐにコピーしてください。

キーの完全な値は作成時に一度だけ表示されます。ダイアログを閉じると、こちらにはハッシュしか残らないため、紛失したキーは再発行が必要です。

2

最初のリクエストを送信

キーを Bearer トークンとして、アクションを JSON の本文で渡します。どのエンドポイントも JSON を受け取り、JSON を返します。

curl -X POST https://app.skimle.com/api/skimle-read \
  -H "Authorization: Bearer skm_…r" \
  -H "Content-Type: application/json" \
  -d '{ "action": "get_categories" }'

閲覧用キーは r、編集用キーは e で終わります。プロジェクトキーは /api/skimle-read と /api/skimle-write を、アカウントキーは /api/skimle-account を呼び出します。

3

API リファレンスを開く

すべてのエンドポイントを、説明、リクエストの形式、試用パネルとともに確認できます。各ルートは action をキーとする判別共用体の本文を受け付けます。

OpenAPI 3.1 の仕様そのものはこちらで入手できます: /api/openapi.json.

開発を始めましょう

プロジェクトキーを管理するか、エージェント型クライアント向けの MCP サーバーをご覧ください。