エージェント向けクイックスタート

サインアップして「あとはお願い」と言うだけ。あとはエージェントが引き継ぎます。

このページは、AIエージェントが新規ユーザーを docspi にゼロからオンボーディングするための完全な手順書です。ペアリング、MCP設定、プロジェクト作成、ドキュメント保存、公開までを、人間が API を手打ちすることなく実行できます。

5つのステップ

人間が docspi にサインアップする
エージェントが device-code フローでアカウントとペアリングする
エージェントがトークンでdocspi APIを直接呼び出す（任意でローカルのdocspi-mcpを設定することもできる）
エージェントがプロジェクトを作成しドキュメントを保存する
エージェントがドキュメントを公開URLとして公開する

1. サインアップ

人間が docspi のアカウントを作成します。ブラウザ操作が必要なのはこのステップだけです。

無料アカウントを作成

2. エージェントをペアリングする

docspi はスマートTVのサインインに似た device-code 型のペアリングフローを採用しています。エージェントがペアリングリクエストを開始し、人間が承認するための短いコードを提示し、承認されるまでポーリングします。

ペアリングリクエストを開始する:

curl -s -X POST https://docspi.ai/api/agent-pairing/start \
  -H "Content-Type: application/json" \
  -d '{"clientName": "Claude Code / my-project", "projectSlugs": ["*"], "expiresInDays": 90}'

{
  "userCode": "WJHQ-KMPX",
  "deviceCode": "5f2b1c...c9",
  "verificationUri": "https://docspi.ai/pair",
  "verificationUriComplete": "https://docspi.ai/pair?code=WJHQ-KMPX",
  "expiresIn": 600,
  "interval": 5
}

projectSlugs は必須です — このトークンが操作できる特定のプロジェクトslugを指定するか、現在および将来の全プロジェクトを明示的に要求する場合は ["*"] を指定してください。expiresInDays は任意（1〜365、既定90）です。レスポンスには一度だけ返される deviceCode（エージェントの認証情報なので秘匿すること）と、人間が開く verificationUriComplete が含まれます。

人間に verificationUriComplete のリンク（または /pair を開いて userCode を入力）を開いて「承認」をクリックしてもらってください。承認したと確認が取れるまで次に進まないでください。

承認されるまでポーリングする:

DEVICE_CODE="5f2b1c...c9"
while true; do
  RES=$(curl -s -X POST https://docspi.ai/api/agent-pairing/poll \
    -H "Content-Type: application/json" \
    -d "{\"deviceCode\": \"$DEVICE_CODE\"}")
  ERR=$(echo "$RES" | jq -r '.error // empty')
  if [ -z "$ERR" ]; then
    export DOCSPI_API_TOKEN=$(echo "$RES" | jq -r '.token')
    break
  elif [ "$ERR" = "authorization_pending" ]; then
    sleep 5
  else
    echo "Pairing stopped: $ERR"; break
  fi
done

`interval` 秒（既定5秒）ごとにポーリングします。未承認の間は authorization_pending が返り、人間が承認するとレスポンスにエージェント用のAPIトークンが含まれます。

3. APIを呼び出す（またはMCPを設定する）

ステップ2で取得したトークンを、任意のHTTPクライアントで Authorization: Bearer ヘッダーとして使用してください — これが常に利用可能な主たる連携方法です。docspi-mcp（下記）はMCP対応クライアント向けに同じエンドポイントをラップしたものですが、ソースのみで配布されており npm には登録されていません。`npx -y docspi-mcp` は404になるため、リポジトリからビルドしてください。

curl -s https://docspi.ai/api/v1/agents \
  -H "Authorization: Bearer $DOCSPI_API_TOKEN"
# -> { "data": [...] }  (401 { "error": { "code": "DOCSPI_UNAUTHORIZED", ... } } if missing/invalid)

/docs/api に記載のすべてのエンドポイントが同じヘッダーを受け付けます。トークンが期限切れ・無効・欠落している場合は 401 と DOCSPI_UNAUTHORIZED のJSONエラーが返ります。

任意 — MCPクライアント設定（ソースからビルド、/docs/mcp 参照）:

{
  "mcpServers": {
    "docspi": {
      "command": "node",
      "args": [
        "/absolute/path/to/Docspi/docspi-mcp/dist/index.js"
      ],
      "env": {
        "DOCSPI_API_URL": "https://docspi.ai/api",
        "DOCSPI_API_TOKEN": "dsp_xxxxxxxxxxxxxxxxxxxx"
      }
    }
  }
}

パスは docspi-mcp を clone してビルドした場所（docspi-mcp/ 内で npm install && npm run build）に置き換えてください。このサーバーの公開npmパッケージは存在しません。

4. プロジェクトを作成しドキュメントを保存する

プロジェクトを作成し、仮想パスを指定してドキュメントを保存します。存在しないフォルダは docspi が自動的に作成します。

curl -s -X POST https://docspi.ai/api/projects \
  -H "Authorization: Bearer $DOCSPI_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Acme Runbook", "description": "Operational runbook for Acme"}'
# -> { "data": { "id": "<projectId>", "slug": "acme-runbook", ... } }

curl -s -X POST https://docspi.ai/api/projects/$PROJECT_ID/documents/save \
  -H "Authorization: Bearer $DOCSPI_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"virtualPath": "/getting-started.md", "content": "# Getting started\n..."}'
# -> { "data": { "nodeId": "<nodeId>", ... } }

5. 公開する

保存した内容から公開ドキュメントのレコードを作成し、公開状態に切り替えます。これでドキュメントは認証不要の公開URLで閲覧できるようになります。

curl -s -X POST https://docspi.ai/api/published-docs \
  -H "Authorization: Bearer $DOCSPI_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"projectId": "'"$PROJECT_ID"'", "publicTitle": "Getting Started", "slug": "getting-started", "content": "# Getting started\n..."}'
# -> { "data": { "id": "<publishedDocId>", ... } }

curl -s -X POST https://docspi.ai/api/published-docs/$PUBLISHED_DOC_ID/publish \
  -H "Authorization: Bearer $DOCSPI_API_TOKEN"
# now live at https://docspi.ai/d/<tenant-slug>/acme-runbook/getting-started

機械可読なリファレンス

サインアップして「あとはお願い」と言うだけ。あとはエージェントが引き継ぎます。

5つのステップ

人間が docspi にサインアップする

エージェントが device-code フローでアカウントとペアリングする

エージェントがトークンでdocspi APIを直接呼び出す（任意でローカルのdocspi-mcpを設定することもできる）

エージェントがプロジェクトを作成しドキュメントを保存する

エージェントがドキュメントを公開URLとして公開する

{ "userCode": "WJHQ-KMPX", "deviceCode": "5f2b1c...c9", "verificationUri": "https://docspi.ai/pair", "verificationUriComplete": "https://docspi.ai/pair?code=WJHQ-KMPX", "expiresIn": 600, "interval": 5 }

DEVICE_CODE="5f2b1c...c9" while true; do RES=$(curl -s -X POST https://docspi.ai/api/agent-pairing/poll \ -H "Content-Type: application/json" \ -d "{\"deviceCode\": \"$DEVICE_CODE\"}") ERR=$(echo "$RES" | jq -r '.error // empty') if [ -z "$ERR" ]; then export DOCSPI_API_TOKEN=$(echo "$RES" | jq -r '.token') break elif [ "$ERR" = "authorization_pending" ]; then sleep 5 else echo "Pairing stopped: $ERR"; break fi done

{ "mcpServers": { "docspi": { "command": "node", "args": [ "/absolute/path/to/Docspi/docspi-mcp/dist/index.js" ], "env": { "DOCSPI_API_URL": "https://docspi.ai/api", "DOCSPI_API_TOKEN": "dsp_xxxxxxxxxxxxxxxxxxxx" } } } }

curl -s -X POST https://docspi.ai/api/projects \ -H "Authorization: Bearer $DOCSPI_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{"name": "Acme Runbook", "description": "Operational runbook for Acme"}' # -> { "data": { "id": "<projectId>", "slug": "acme-runbook", ... } }

curl -s -X POST https://docspi.ai/api/projects/$PROJECT_ID/documents/save \ -H "Authorization: Bearer $DOCSPI_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{"virtualPath": "/getting-started.md", "content": "# Getting started\n..."}' # -> { "data": { "nodeId": "<nodeId>", ... } }

curl -s -X POST https://docspi.ai/api/published-docs \ -H "Authorization: Bearer $DOCSPI_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{"projectId": "'"$PROJECT_ID"'", "publicTitle": "Getting Started", "slug": "getting-started", "content": "# Getting started\n..."}' # -> { "data": { "id": "<publishedDocId>", ... } }

curl -s -X POST https://docspi.ai/api/published-docs/$PUBLISHED_DOC_ID/publish \ -H "Authorization: Bearer $DOCSPI_API_TOKEN" # now live at https://docspi.ai/d/<tenant-slug>/acme-runbook/getting-started