Skip to content

Search (1.0.0)

Query your project's documentation and API reference content from external tools, scripts, or integrations (for example, MCP servers or custom search UIs).

Path prefix: If your project is deployed with a path prefix (for example, https://docs.example.com/docs/), prepend that prefix to the API paths (for example, /docs/_search).

For path prefix configuration, see custom domain configuration.

Authentication

This API uses the same authentication as the project. Public projects (when access.requiresLogin is not set or is false), don't require authentication when you call the API. If the project is protected, (access.requiresLogin: true or has RBAC configuration), you must send the same cookie-based session that the browser uses after users logs in.

The API does not support API keys or bearer tokens; authentication is session (cookie) only. For unauthenticated requests to protected projects, both endpoints return empty results instead of errors.

To learn more about access and authentication options, see Access control.

CORS and credentials

When calling from a browser (for example, a custom search UI on another origin), the project must allow your origin in CORS. Send credentials (cookies) with fetch(..., { credentials: 'include' }) so that session cookies are sent for protected projects.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Redocly
Terms of Service
Languages
Servers
Mock server
https://redocly.com/_mock/docs/realm/customization/search-api/openapi/
Project server
https://{projectUrl}/