Skip to main content
The Mavel REST API gives you programmatic access to everything the dashboard shows: projects, brands, prompts, topics, tags, captured answers, and reports. The interactive reference in this tab is generated from the live OpenAPI 3.0 spec at app.mavel.ai/api/v1/openapi.json.
API access is available on the Growth plan and above. See Plans.

​
Authentication

Pass your API key in the X-API-Key header on every request:
Create and manage keys in the dashboard. See API keys. Keys are project-scoped; keep them out of URLs, logs, and client-side code.

​
Base URL and versioning

The API is versioned in the path. Breaking changes only ship in a new version.

​
Rate limits

200 requests / minute / project. Exceeding the limit returns HTTP 429; back off and retry after the window resets.

​
Pagination

List endpoints paginate with limit and offset query parameters. Iterate by increasing offset by limit until a page comes back with fewer than limit items.

​
Errors

Errors return a machine-readable envelope with an HTTP status, a SCREAMING_SNAKE_CASE code, and a human-readable message: