DataShield MCP Dataset Library
BrowseUploadHelpAPIPricingManagement

API overview

Public read APIs, admin APIs, and how to explore endpoints via OpenAPI.

Where to start

  • Human UI: /api-docs
  • OpenAPI JSON: /api/openapi.json

Public APIs (no auth)

Search datasets

GET /api/public/datasets

Query params:

  • q: full-text query
  • provider: provider filter (e.g. SOCRATA, ARCGIS)
  • tag: repeatable tag filter
  • limit, offset: pagination

Example:

curl -sS "http://localhost:3000/api/public/datasets?q=air%20quality&limit=25" | jq

Dataset detail

GET /api/public/datasets/{id}

Returns:

  • dataset row
  • resources
  • fields (if analytics imported)
  • analytics profiles (recent)

Admin APIs

Admin endpoints live under:

  • /api/app/* (management UI)
  • /api/admin/* (ops actions like purge logs)

Authentication options:

  1. Emergency admin token (break-glass) via x-admin-token
  2. SSO header auth if you deploy behind an auth proxy (see the admin auth doc)

Agent access

If you're building agent workflows, combine:

  • /api/public/* for discovery and metadata
  • /api/help/* for agent-consumable documentation
  • npm run mcp for MCP stdio integration