# Docs API

> Search and read these docs from a script or agent through api.vigilbase.com/docs/v1, or through the search_docs and get_docs_page MCP tools.

Source: https://docs.vigilbase.com/tools/developers/docs-api

The Docs API searches and returns the pages of docs.vigilbase.com. Agents can use it to answer questions about Vigilbase from the current docs. It needs no account or key.

| Topic | Details |
| --- | --- |
| Base URL | `https://api.vigilbase.com/docs/v1` |
| OpenAPI | `https://api.vigilbase.com/docs/v1/openapi.json` |
| Authentication | None |
| Rate limit | 60 requests a minute per client IP |
| Language | English |
| MCP | `search_docs` and `get_docs_page` on the [MCP server](https://docs.vigilbase.com/tools/developers/mcp-server) |

## Search the docs

`GET /search` returns the pages that contain every word of `q`, best first. Matches in a title rank first, then matches in a heading, then the description, then the body text.

| Parameter | Required | Details |
| --- | --- | --- |
| `q` | Yes | The words to find, 2 to 200 characters. Only the first eight words count. |
| `limit` | No | The most results to return, 1 to 20. The default is 10. |

```bash filename=search.sh
curl -sS 'https://api.vigilbase.com/docs/v1/search?q=api+keys&limit=3'
```

```json filename=response.json
{
  "results": [
    {
      "path": "tools/developers/api-keys",
      "title": "API keys",
      "description": "Create a developer API key to raise the Agent API rate limits.",
      "url": "https://docs.vigilbase.com/tools/developers/api-keys",
      "markdownUrl": "https://docs.vigilbase.com/tools/developers/api-keys.md"
    }
  ]
}
```

When the match is under a heading, the result also has `heading` (`id` and `text`), and `url` points to that heading.

## Read a page

`GET /pages?path=<path>` returns one page as Markdown. `path` is the page URL without the host, as in a search result's `path`. Leave it empty for the docs home.

```bash filename=page.sh
curl -sS 'https://api.vigilbase.com/docs/v1/pages?path=one/api'
```

The response has `path`, `title`, `description`, `url`, `markdownUrl`, `markdown` and, when it is known, `updatedAt`. Links in `markdown` are absolute. The same Markdown is also at the page URL plus `.md`, for example `https://docs.vigilbase.com/one/api.md`.

## Errors and limits

Errors are `application/problem+json` ([RFC 9457](https://www.rfc-editor.org/rfc/rfc9457)) with a `code`:

| Status | Code | Cause |
| --- | --- | --- |
| `400` | `bad_request` | `q` is missing or too short, `limit` is out of range, or `path` is not a docs path |
| `404` | `not_found` | No published page has that path |
| `429` | `rate_limit_exceeded` | More than 60 requests in a minute from one client IP. `Retry-After` says when to try again. |
| `503` | `service_unavailable` | The rate limiter is unavailable. Retry after a few seconds. |

Every response carries `RateLimit` and `RateLimit-Policy` headers. Any origin may call the API from a browser.