← Docs

REST API クイックスタート

MCP を使わずに、任意の言語から HTTPS で NW DB にアクセスします。

認証ヘッダ

  • X-API-Key — Settings ページで発行（nwdb_ で始まる）
  • X-Workspace-ID — Workspace の UUID

レコード取得 (GET)

curl https://api.nwdb.dev/api/v1/records/users/records?limit=5 \
  -H "X-API-Key: nwdb_xxxxxxxxxxxxxxxxxxxx" \
  -H "X-Workspace-ID: ws_abc123"

JS/TS から:

const res = await fetch("https://api.nwdb.dev/api/v1/records/users/records?limit=5", {
  headers: {
    "X-API-Key": process.env.NWDB_API_KEY,
    "X-Workspace-ID": process.env.NWDB_WORKSPACE,
  },
});
const data = await res.json();

レコード投入 (POST)

curl -X POST https://api.nwdb.dev/api/v1/records/users/records \
  -H "X-API-Key: $NWDB_API_KEY" \
  -H "X-Workspace-ID: $NWDB_WORKSPACE" \
  -H "Content-Type: application/json" \
  -d '{"name": "Ada", "email": "ada@example.com"}'

主要エンドポイント

パス役割
/api/v1/tablesスキーマ管理
/api/v1/records/:t/recordsレコード CRUD
/api/v1/querySQL 実行（read-only）
/api/v1/vectors/:c/searchベクトル検索
/api/v1/agents/runAIエージェント実行
/api/v1/proxy/restPostgREST 自動生成 REST
/api/v1/proxy/graphqlPostGraphile 自動生成 GraphQL

完全な OpenAPI 定義は /api/v1/docs を参照してください。