Skip to main content

Base URL

All API endpoints are served from:

Authentication

Every endpoint that returns user data requires an API key. Two header forms are accepted; X-API-Key is recommended.

Authorization: Bearer header

Equivalent in every way; useful when you’re routing through middleware that already understands bearer tokens.
The /v1/embed/* endpoints are public and intentionally do not require authentication.

Get an API key

  1. Sign up or log in at the
  2. Create an organization and project
  3. Open the project’s API Keys section
  4. Click Create API Key and copy the key — it won’t be shown again

Machine-readable resources

For automated integrations and AI-assisted development: The playbook, the map, and the credential recipe are served at the root of mcp.particle.pro too. The OpenAPI document is generated from the server source on every release and the endpoint reference that follows is rendered from it; it is the authoritative reference for endpoint structure. For individual field semantics, defer to the live API response when the two disagree.

Client libraries

Generate a typed client in any language from the OpenAPI document (curl -fsS https://api.particle.pro/openapi.json -o particle-openapi.json) with openapi-generator, Stainless, or your stack’s equivalent; the quickstart shows every call with curl, fetch, and httpx directly. Agents get a ready-made client over MCP. Keyless agents paying per request use the x402 client libraries listed on Pay per request with x402.

Conventions

The defaults most endpoints share; where an operation differs, its schema in the reference below is authoritative. Concepts expands on each.