API Reference
API Reference
API endpoints for open-auto-doc
API Reference
GET /api/search
Full-text search endpoint for documentation content. Powered by Fumadocs Core's server-side search functionality. Accepts search queries and returns matching documentation pages with relevant content snippets.
Authentication: None - Public endpoint
Parameters
| Name | Type | Required | Location | Description |
|---|---|---|---|---|
q | string | No | query | Search query string. Returns matching documents from the documentation content. |
language | string | No | query | Language code for search results (e.g., 'english'). Filters results by language if specified. |
Request Body
No request body required. All parameters passed as query strings.
Response
JSON array of search results. Each result contains: id (string), title (string), description (string), url (string), content (string). Example: [{ "id": "doc-123", "title": "Getting Started", "description": "How to get started", "url": "/docs/getting-started", "content": "Installation instructions..." }]