本文へスキップ

API と MCP

Piqline で開発する

ワークスペースのツールとエージェントを、HTTP または MCP で。1 つのキー、スコープ、読みやすいエラー。

  • 92 個のツール
  • 6 個のエージェント
  • 5 個のスコープ
  • REST と MCP

最初の呼び出し

curl -s https://piqline.com/api/v1/workspace \
  -H "Authorization: Bearer $PIQLINE_API_KEY"
レスポンス
{
  "workspace": { "id": "b7a1c3e0-5d2f-4c8a-9e41-2f6d0a7b1c93", "name": "Atelier" },
  "key": { "name": "Claude Code", "prefix": "piq_live_Ab12Cd", "scopes": ["read", "agents"] },
  "limits": { "requests_per_minute": 120, "requests_today": 1 }
}

ここから始める

Piqline API を使うと、スクリプトやエージェントからワークスペースにアクセスできます。ダッシュボードのアシスタントと同じツールと同じエージェントを、HTTP または MCP(Model Context Protocol)で利用できます。各呼び出しは 1 つのワークスペースを対象とし、キーを作成したメンバーの権限で実行されます。

必要なもの#

  • オーナーまたは管理者として参加している Piqline ワークスペース。メンバーはキーのページを閲覧のみできます。
  • HTTP リクエストを送れるツール(例では curl)、または MCP クライアント。

1. キーを作成する#

  1. 設定 → API と MCP を開きます。
  2. キーに名前を付け、スコープにチェックを入れ(最初は read)、有効期限を選びます。
  3. キーを作成 をクリックし、キーをコピーします。キーが表示されるのは 1 回だけです。

環境変数に保存します。

Shell
export PIQLINE_API_KEY="piq_live_…"

2. キーを確認する#

curl -s https://piqline.com/api/v1/workspace \
  -H "Authorization: Bearer $PIQLINE_API_KEY"

レスポンス:

JSON
{
  "workspace": { "id": "b7a1c3e0-5d2f-4c8a-9e41-2f6d0a7b1c93", "name": "Atelier" },
  "key": {
    "id": "0d4e8f2a-71c6-4b3d-8a55-c9e2b6f10d47",
    "name": "Claude Code",
    "prefix": "piq_live_Ab12Cd",
    "scopes": ["read", "agents"]
  },
  "acting_as": {
    "user_id": "3c9a52e1-8b47-4d06-a2f3-71e0b5d4c689",
    "email": "vous@exemple.fr",
    "role": "owner"
  },
  "limits": {
    "requests_per_minute": 120,
    "agent_runs_per_minute": 10,
    "requests_per_day": 20000,
    "requests_today": 1
  }
}

key.scopes はキーで実行できる操作を、limits は残りの利用枠を示します。401 は、キーがない、コピーを誤った、または失効したことを意味します。エラーを参照してください。

3. ツールを呼び出す (Call a tool)#

ツールはアシスタントの機能の 1 つです。コーパスの読み取り、ライブ検索、書き込み、アクションがあります。この例では、直近 7 日間の収集量を読み取ります。

curl -s https://piqline.com/api/v1/tools/getCoverageStats \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"period":"7d"}'

レスポンスにはツール名とその出力が入ります(ここでは短縮しています)。

JSON
{
  "tool": "getCoverageStats",
  "output": {
    "period": "7d",
    "itemsTotal": 1842,
    "itemsPeriod": 214,
    "items24h": 37,
    "sources": 12,
    "byPlatform": [{ "platform": "rss", "items": 904, "items24h": 20 }]
  }
}

呼び出し可能な 92 個のツールと、そのスコープおよび入力はカタログにまとめています。

4. エージェントに質問する (Ask an agent)#

エージェントは複数のツールを連鎖させ、自然言語で回答します。キーには agents スコープに加えて、エージェントが使うツールのスコープが必要です。

curl -s https://piqline.com/api/v1/agents/piqline \
  -H "Authorization: Bearer $PIQLINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"input":"Combien de sources suit ce workspace, et lesquelles sont en erreur ?"}'

レスポンス(短縮):

JSON
{
  "agent": "piqline",
  "status": "completed",
  "text": "Le workspace suit 12 sources, dont 2 en erreur : …",
  "tool_calls": [{ "tool": "listSources", "state": "output-available" }],
  "pending": []
}

詳しくはエージェントを参照してください。

5. MCP クライアントを接続する (Connect an MCP client)#

Claude Code の場合:

Shell
claude mcp add --transport http piqline https://piqline.com/api/mcp \
  --header "Authorization: Bearer $PIQLINE_API_KEY"

その他のクライアントは MCP サーバーで説明しています。

未対応の機能#

  • Webhook。 お客様のシステムへのプッシュ通知はありません。新しく入ってくるデータを追うには、getSignals または searchItems を一定間隔でポーリングしてください。
  • 公式 SDK。 OpenAPI ドキュメントがすべてのルートを記述しています。クライアントジェネレーターを使うと、お使いの言語の SDK を生成できます。
  • OAuth サインイン。 受け付けるのはキーのみです。claude.ai や ChatGPT のコネクターのように OAuth を必須とするものは、まだ接続できません。
  • 一括エクスポート。 ツールは件数を制限した結果ページを返します(searchItems は最大 40 件)。

API についてのご質問や、このページの誤りはありませんか。 お問い合わせ.