Skip to content
AnswerixAI

API reference

How to read AnswerixAI data programmatically through the REST API, the Metrics API and the MCP server, and receive webhooks from AnswerixAI.

Updated

The AnswerixAI API reference documents the programmatic ways to work with your AI visibility data: three request surfaces that you call with an API key, and webhooks that AnswerixAI sends to you. All of them use the same data you see in the dashboard, scoped to your organization.

Which API should you use?

AnswerixAI has three API surfaces plus webhooks. Use the REST API (/api/mcp/*) for scripts and back-end integrations that need the full feature set, the read-only Metrics API (/api/v1/*) for reporting tools such as Looker Studio, and the MCP server (/api/mcp) for AI assistants. Webhooks send content opportunities, Daily Pulse digests and test events to your own URL.

Surface Base path Use it for
REST API /api/mcp/* Scripts and back-end integrations that need the full feature set: visibility, citations, topics, prompts, content opportunities, site audits, AI traffic and shopping data. Includes a few write actions.
Metrics API /api/v1/* Reporting tools such as Looker Studio, spreadsheets and dashboards. A read-only subset of the REST API.
MCP server /api/mcp AI assistants such as Claude Desktop, Claude Code and Cursor, using the Model Context Protocol.
Webhooks Your URL Receiving content opportunities you send to a workflow, Daily Pulse digests and test events.

The base URL is the address of the AnswerixAI app you sign in to. The quickest way to get it is to copy the MCP endpoint from Settings → API Keys and remove the trailing /api/mcp.

How do I authenticate?

Every request to the AnswerixAI REST API, Metrics API and MCP server authenticates with an ans_ API key sent as a bearer token in the Authorization header. The same key works on all three surfaces.

Authorization: Bearer ans_YOUR_KEY

Create keys in Settings → API Keys; each key is shown once. A key acts on all brands of its owner's organization, and revoking it takes effect immediately. Requests are limited to 250 per 15 minutes per IP address. Read Authentication for errors and limits, and API keys for managing keys.

What conventions do the APIs share?

The AnswerixAI APIs share four conventions: responses are JSON, most endpoints need a brand_id query parameter, dates use YYYY-MM-DD, and IDs are UUIDs. Errors return {"error": "<message>"} with an HTTP status code.

  • Responses are JSON. Errors return {"error": "<message>"} with an HTTP status code.
  • Most endpoints need a brand_id query parameter. Get your brand IDs from GET /api/mcp/brands or GET /api/v1/brands.
  • Dates use YYYY-MM-DD. A bare date_to includes the whole of that day.
  • IDs are UUIDs.

Related

Was this page helpful?