# SurrealDB Platform API

> api.surrealdb.com is the SurrealDB platform API: one HTTP surface for accounts, personal access tokens, SurrealDB Cloud, learning, support, and website content, plus the SurrealDB Cloud MCP server. Every public endpoint is described by a published OpenAPI document.

Requests and responses are JSON and every field name on the wire is `snake_case`. Every public endpoint lives under `/api/`.

## API description

- [OpenAPI document](https://api.surrealdb.com/openapi/public.yaml): OpenAPI 3.0 for the whole public API - paths, parameters, schemas, and security schemes. Start here.
- [API reference](https://api.surrealdb.com/docs): Swagger UI rendered over the same document
- [Health](https://api.surrealdb.com/health): Liveness probe
- [Version](https://api.surrealdb.com/version): Build metadata

## Documentation search

- [Search the documentation](https://api.surrealdb.com/api/docs/v1/search?q=how+to+connect): Hybrid keyword and semantic search over the SurrealDB documentation. No token required. Pass `q`, and optionally `product=surrealdb|spectron`. Every result `url` is a path on https://surrealdb.com, so prefix it to cite the page. Prefer this over guessing SurrealQL syntax.

## Authentication

Public endpoints take a bearer JWT issued by the SurrealDB Auth0 tenant, or a SurrealDB personal access token (`sdbp_...`) that the API exchanges for one. The protected resource metadata names the authorization server to obtain a token from and the scopes to ask for, and a 401 from any `/api/` route repeats that pointer in its `WWW-Authenticate` header.

- [Protected resource metadata](https://api.surrealdb.com/.well-known/oauth-protected-resource): RFC 9728 for the platform API. Also served at `/.well-known/oauth-protected-resource/api`.
- [Agent authentication guide](https://surrealdb.com/auth.md): How agents obtain and use SurrealDB credentials

## MCP

- [SurrealDB Cloud MCP](https://api.surrealdb.com/api/mcp): SurrealDB Cloud as MCP tools, with its own OAuth discovery at `/.well-known/oauth-protected-resource/api/mcp`
- [MCP host](https://mcp.surrealdb.com/llms.txt): The same server, served at the root of https://mcp.surrealdb.com

## Documentation

- [SurrealDB documentation](https://surrealdb.com/docs): Product, SurrealQL, and API reference
- [SurrealDB Cloud](https://surrealdb.com/cloud): The managed service behind `/api/cloud`
- [SurrealDB](https://surrealdb.com): Product overview, and the llms.txt for the main site