Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help.mentionpilot.ai/llms.txt

Use this file to discover all available pages before exploring further.

The MentionPilot API lets you access everything in your account programmatically — brands, prompts, competitors, sources, and visibility reports. Use it to pull data into your own dashboards, automate reporting, or build custom integrations.

​
Base URL

All API requests go to: 
https://app.mentionpilot.ai/api/v1

​
Authentication

Every request requires a Bearer token. See the Authentication page for how to generate and use API keys.

​
Request format

All endpoints accept JSON in the request body. Set the Content-Type header accordingly. 
Content-Type: application/json

​
What you can do

Brand

Get, create, and delete brands. Fetch aggregated visibility, sentiment, and position metrics for a brand.

Prompt

List prompts, toggle active status, and fetch per-prompt visibility metrics with sentiment and position breakdowns.

Competitor

Retrieve tracked competitors with full metrics, or untracked competitors with visibility-only data.

Sources

Fetch the web sources AI platforms used when generating responses for your prompts.

​
Response format

All responses return JSON. Successful responses include "success": true. 
{
  "success": true,
  ...
}
Errors include "success": false and an "error" message. 
{
  "success": false,
  "error": "brand_id is required"
}

​
HTTP status codes

CodeMeaning
200Success
400Invalid request — check your parameters
401Missing or invalid API key
403Your key doesn’t have access to this resource
404Resource not found
500Server error
All endpoints accept JSON in the request body. Set the Content-Type header accordingly. 
Content-Type: application/json

​
What you can do

Brand

Get, create, and delete brands. Fetch aggregated visibility, sentiment, and position metrics for a brand.

Prompt

List prompts, toggle active status, and fetch per-prompt visibility metrics with sentiment and position breakdowns.

Competitor

Retrieve tracked competitors with full metrics, or untracked competitors with visibility-only data.

Sources

Fetch the web sources AI platforms used when generating responses for your prompts.

​
Response format

All responses return JSON. Successful responses include "success": true. 
{
  "success": true,
  ...
}
Errors include "success": false and an "error" message. 
{
  "success": false,
  "error": "brand_id is required"
}

​
HTTP status codes

CodeMeaning
200Success
400Invalid request — check your parameters
401Missing or invalid API key
403Your key doesn’t have access to this resource
404Resource not found
500Server error