For AI agents: a documentation index is available at /docs/llms.txt. Read this API reference as Markdown.
Aiso API
Programmatic access to your AI visibility data and the conversation dataset. Search real conversations, read transcripts, and expand prompts with Conversation Explorer. Query tracked prompts, brand mentions, visibility, sentiment, position, and the sources cited by ChatGPT and Gemini. All endpoints return JSON and authenticate with a per-account API key.
This API is in beta. Endpoints and response shapes may evolve.
One key per account
Project calls use x-aiso-project-id; Explorer does not.
Brand visibility
Mentions, sentiment, and position.
Source intelligence
Domains and URLs cited by AI.
Authentication
Include your API key in the x-api-key header on every request. You have one key per account. For project-specific calls, also send x-aiso-project-id with the project UUID. Generate a key in the Aiso app . Keys are stored as SHA-256 hashes, so the raw key is shown once on creation and cannot be retrieved again.
curl -X GET "https://app.getaiso.com/api/v1/projects" \
-H "x-api-key: aiso_abc123..."
curl -X GET "https://app.getaiso.com/api/v1/prompts" \
-H "x-api-key: aiso_abc123..." \
-H "x-aiso-project-id: YOUR_PROJECT_UUID"Rate limits
Default limits are 10 requests per minute and 20 requests per day per API key. Admins can adjust these per user. Every response includes headers you can use to manage retries.
| Header | Description |
|---|---|
X-RateLimit-Limit | Max requests in the current window. |
X-RateLimit-Remaining | Requests remaining before throttling. |
X-RateLimit-Reset | Seconds until the window resets. |
Base URL
https://app.getaiso.com/api/v1Models and filtering
Aiso tracks two AI models. Use gpt for OpenAI ChatGPT with web search and gemini for Google Gemini with Google Search grounding. Report endpoints accept a flexible query body with dates, pagination, dimensions, filters, and sort order.
| Parameter | Type | Description |
|---|---|---|
start_date | string (YYYY-MM-DD) | Snapshots on or after this date. |
end_date | string (YYYY-MM-DD) | Snapshots on or before this date. |
limit | number (1–10,000) | Max rows. Default 1,000. |
offset | number | Skip N rows. Default 0. |
dimensions | string[] | Break down by prompt_id, model_id, date, week, or month. |
filters | object[] | { field, operator: "in" | "not_in", values: [] } |
order_by | object[] | { field, direction: "asc" | "desc" } |
{
"start_date": "2025-09-01",
"end_date": "2025-10-01",
"dimensions": ["date"],
"filters": [
{ "field": "model_id", "operator": "in", "values": ["gpt"] }
],
"order_by": [{ "field": "visibility", "direction": "desc" }],
"limit": 100
}/projectsProject
Returns project metadata. Without x-aiso-project-id, it lists all projects with summary fields. With the header, it returns one project including full domain_data.
{
"data": {
"id": "uuid",
"domain": "example.com",
"company_name": "Example Inc",
"niche": "CRM Software",
"topics": ["pricing", "features", "alternatives"],
"competitors": ["Competitor A", "Competitor B"],
"geography": "US",
"current_step": 2,
"has_tracking": false,
"created_at": "2025-09-22T...",
"updated_at": "2025-10-01T...",
"domain_data": {
"domain": "example.com",
"companyName": "Example Inc",
"niche": "CRM Software",
"topics": ["pricing", "features", "alternatives"],
"competitors": ["Competitor A", "Competitor B"],
"geography": "US",
"language": "English",
"entityType": "brand"
}
}
}/projectsCreate a project
Requires domain only. The server runs domain analysis once, saves domain_data, and returns it. Optional fields: country, language, entity_type, and prompts. The response uses the same shape as the single-project GET and may take up to about two minutes.
{
"domain": "example.com",
"country": "US",
"language": "English",
"entity_type": "brand"
}Update a project
PATCH /projects updates project setup and requires x-aiso-project-id. All fields are optional: domain_data, extra_brands, hidden_brands, and brand_alias_groups. Names and domains in each alias group are treated as the same entity in visibility reports. The setup write limits described under MCP apply.
{
"extra_brands": ["Brand X"],
"hidden_brands": ["Brand Y"],
"brand_alias_groups": [
["Dior", "Christian Dior", "dior.com"],
["LV", "Louis Vuitton"]
]
}/promptsPrompts
List the prompts tracked in the project. Optionally filter by topic with ?topic=pricing.
{
"data": [
{
"id": "prompt-uuid",
"text": "What is the best CRM for small businesses?",
"topic": "alternatives",
"intent": "informational",
"funnel_stage": "awareness",
"branded": "non-branded",
"source": "generated"
}
],
"total_count": 42
}/brandsBrands
List the tracked brands, meaning your brand plus its competitors.
{
"data": [
{ "name": "Example Inc", "is_own": true, "is_competitor": false },
{ "name": "Competitor A", "is_own": false, "is_competitor": true }
],
"total_count": 5
}/snapshotsSnapshots
List analysis snapshots. Each snapshot is one visibility analysis run.
{
"data": [
{
"id": "snap-uuid",
"status": "complete",
"prompts_count": 42,
"run_at": "2025-10-01T12:00:00Z",
"completed_at": "2025-10-01T12:05:00Z"
}
],
"total_count": 8
}/reports/brandsBrand mentions
Measure visibility for your brand and competitors across tracked prompts. Each result includes mention rate, sentiment, and average position.
Filters: model_id, prompt_id, topic_id, and brand_id. Dimensions: prompt_id, model_id, date, week, month.
curl -X POST "https://app.getaiso.com/api/v1/reports/brands" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"start_date": "2025-09-01",
"end_date": "2025-10-01",
"dimensions": ["date"],
"filters": [
{ "field": "model_id", "operator": "in", "values": ["gpt"] }
],
"order_by": [{ "field": "visibility", "direction": "desc" }],
"limit": 100
}'{
"data": [
{
"brand": { "name": "Example Inc" },
"mention_count": 28,
"visibility": 0.67,
"visibility_count": 28,
"visibility_total": 42,
"sentiment": 72,
"sentiment_sum": 14,
"sentiment_count": 28,
"position": 2.3,
"position_sum": 64.4,
"position_count": 28,
"date": "2025-09-15"
}
],
"total_count": 150
}| Field | Description |
|---|---|
visibility | Mention rate from 0 to 1. How often the brand appears across tracked prompts. |
mention_count | Prompt responses where the brand was mentioned. |
sentiment | Normalized 0 to 100 score. 50 is neutral, above 50 is positive, below 50 is negative. |
position | Average rank position when mentioned, where 1 is first. Null if not mentioned. |
/reports/domainsSources
Find the domains cited by AI models in their responses. Filter by model_id or domain, then order by used_count or citation_count.
curl -X POST "https://app.getaiso.com/api/v1/reports/domains" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"start_date": "2025-09-01",
"order_by": [{ "field": "used_count", "direction": "desc" }],
"limit": 20
}'{
"data": [
{
"domain": "g2.com",
"domain_type": "ugc",
"used_count": 34,
"citation_count": 52,
"citation_rate": 1.53
}
],
"total_count": 87
}| Field | Description |
|---|---|
used_count | Times URLs from this domain appeared in AI responses. |
citation_count | Total inline citations from this domain. |
citation_rate | Citations per retrieval (citation_count / used_count). |
domain_type | you, competitor, ugc, editorial, corporate, reference, institutional, or other. |
/reports/urlsSource URLs
Drill into individual cited pages. Filter with model_id, domain, or url.
{
"data": [
{
"url": "https://g2.com/products/example/reviews",
"domain": "g2.com",
"domain_type": "ugc",
"title": "Example Reviews 2025 | G2",
"used_count": 12,
"citation_count": 18,
"citation_rate": 1.5
}
],
"total_count": 245
}Common recipes
Ready-made request bodies for the questions teams ask most.
Overall visibility for all brands
{ }Daily visibility trend for your brand
{
"dimensions": ["date"],
"filters": [
{ "field": "brand_id", "operator": "in", "values": ["Your Brand"] }
]
}Visibility by AI model (GPT vs Gemini)
{
"dimensions": ["model_id"]
}Weekly visibility trend
{
"dimensions": ["week"],
"start_date": "2025-08-01"
}Top cited domains (GPT only)
{
"filters": [
{ "field": "model_id", "operator": "in", "values": ["gpt"] }
],
"order_by": [{ "field": "used_count", "direction": "desc" }],
"limit": 10
}URL drilldown for a specific domain
{
"filters": [
{ "field": "domain", "operator": "in", "values": ["g2.com"] }
],
"order_by": [{ "field": "citation_count", "direction": "desc" }]
}Conversation Explorer
Search the conversation dataset with your account API key. Explorer routes do not use x-aiso-project-id. A semantic search that returns at least one conversation costs 1 tool credit, the same credit the Explorer page spends. Searches with no matches are free. Reading transcripts, listing intents, AI filtering, prompt expansion, and search history are free. With 0 credits, search returns 403.
Use the base URL above with each path below. These account-scoped routes use the same x-api-key authentication as the rest of the API.
POST /explorer/semantic
Semantic search returns up to 2,000 conversations without full transcripts. A non-empty result costs 1 tool credit; no matches are free.
{
"query": "best wireless headphones",
"brand": "Sony",
"intent": null,
"first_prompt_contains": null
}{
"data": {
"conversations": [
{
"id": 559924,
"first_prompt": "...",
"brands": [
"Sony"
],
"intent": "recommendation"
}
],
"credits_remaining": 9,
"credits_charged": 1
}
}GET /explorer/intents
List intent values accepted by semantic search.
{
"data": {
"intents": [
"comparison",
"recommendation"
]
}
}GET /explorer/conversations?id=12345
Read one full transcript. /explorer/conversations/12345 is the equivalent path.
{
"data": {
"id": 12345,
"first_prompt": "...",
"conversation": "Human: ...\nAssistant: ..."
}
}POST /explorer/ai-filter
Re-rank search results using an instruction. Send id and first_prompt from the search. Returns up to 100 IDs, most relevant first.
{
"conversations": [
{
"id": 559924,
"first_prompt": "Can you recommend headphones?"
}
],
"instruction": "Product recommendations only",
"searchQuery": "headphones"
}POST /explorer/prompt-expansion
Generate similar prompts from at least 5 selected conversations. answers.industry and answers.goal are required.
{
"selected_prompts": [
{
"id": 1,
"first_prompt": "Which headphones should I buy?"
},
{
"id": 2,
"first_prompt": "Best headphones for commuting?"
},
{
"id": 3,
"first_prompt": "Compare wireless headphones for calls"
},
{
"id": 4,
"first_prompt": "Headphones with good battery life?"
},
{
"id": 5,
"first_prompt": "Recommend noise cancelling headphones"
}
],
"answers": {
"industry": "Audio",
"goal": "Find comparison prompts"
},
"target_count": 100
}GET /explorer/searches?page=1&limit=10
List this account's saved Explorer searches.
POST /explorer/searches
Save a search and an optional snapshot of up to 200 conversations. Semantic searches are not saved automatically.
POST /explorer/searches/update
Replace a saved search snapshot. Body: { id, snapshot }.
MCP and Claude connector
Connect Claude, Cursor, or any MCP host directly to your Aiso account. The hosted MCP server wraps the v1 API as 19 tools, with no local install.
Using Claude on the web?
Aiso is now listed in Claude's connector directory. Use the directory route to connect without editing an MCP configuration file. Claude lists AISO Boost Ltd. as the developer and currently places the connector in its Community tier.
Open Aiso in Claude1. Create an API key
Go to API keys and create a key. Copy it when shown — it cannot be retrieved again.
2. Add to Cursor
Create .cursor/mcp.json in your project (or edit ~/.cursor/mcp.json globally), then restart Cursor or reload MCP from Settings.
{
"mcpServers": {
"aiso": {
"url": "https://app.getaiso.com/api/v1/mcp",
"headers": {
"x-api-key": "aiso_your_key_here",
"x-aiso-project-id": "your_project_uuid"
}
}
}
}For local dev, use http://localhost:3000/api/v1/mcp instead. Use list_projects to discover project IDs, then set x-aiso-project-id in the headers.
Legacy stdio clients
If your MCP host does not support remote URLs yet, proxy the hosted endpoint with mcp-remote:
{
"mcpServers": {
"aiso": {
"command": "npx",
"args": [
"-y",
"mcp-remote",
"https://app.getaiso.com/api/v1/mcp",
"--header",
"x-api-key:aiso_your_key_here",
"--header",
"x-aiso-project-id:your_project_uuid"
]
}
}
}Project header
GET /projects without a project header lists all your projects. With x-aiso-project-id, it returns one project. All other project-scoped routes require the header, or ?project_id= on GET.
Setup and prompt writes
POST /projects accepts a domain and runs analysis once, so there is no separate analyze endpoint. Setup and prompt management are open to all API key holders. Each project allows one setup write and one prompt write via the API or MCP: further setup updates return 409 once setup exists, and further prompt writes return 409 once prompts exist. The initial POST /projects may include prompts in the same request. Prompt suggestion and generation require stored setup (domain_data) and do not write to the database, so call add_prompts to save.
Visibility reports
Snapshots, brand, domain, and URL reports, and fanout metrics require a completed visibility analysis run for the project. Until then, those tools return 403 with guidance to reach out at getaiso.com for help.
Explorer tools use the same hosted MCP endpoint and API key. They do not need a project header. The same Explorer credit rules apply.
Available MCP tools
| Tool | Description |
|---|---|
get_access | Account limits and optional project info |
list_projects | All projects for your account |
get_project | One project with full domain_data |
list_prompts | Tracked prompts |
list_brands | Brands and competitors |
list_snapshots | Analysis runs |
brand_visibility_report | Visibility report |
domain_report | Domain citations |
url_report | URL citations |
get_fanout_metrics | Query fanout analytics |
get_fanouts_context | Fanouts dashboard context |
create_project | Create project (domain analysis included) |
update_project | Update project setup |
manage_brand_aliases | Set alias groups for names and domains representing the same brand |
add_prompts | Add prompts (one write per project) |
update_prompts | Update prompts (before first add_prompts only) |
manage_topic | Create, update, or delete topics (before first add_prompts only) |
suggest_topics | AI-suggest topics (requires setup, preview only) |
suggest_prompts | AI-suggest prompts (requires setup, preview only) |
generate_topic_prompts | Generate prompts for a topic (requires setup, preview only) |
explorer_search | Search conversations (1 credit when results are returned) |
explorer_list_intents | List intent filters |
explorer_get_conversation | Read a full transcript |
explorer_ai_filter | Re-rank search results |
explorer_expand_prompts | Generate similar prompts |
explorer_list_searches | List saved Explorer searches |
explorer_save_search | Save a search to history |
explorer_update_search | Update a saved search snapshot |
Troubleshooting
| Status | Meaning |
|---|---|
400 | Missing x-aiso-project-id on a project-scoped route, or missing required body field |
401 | Missing or invalid API key |
403 | Visibility data not available yet, or no Explorer credits remaining |
409 | Setup or prompt write already completed for this project |
429 | Rate limit exceeded |
MCP endpoint: https://app.getaiso.com/api/v1/mcp · Admin usage: /admin/api
Need conversations data?
Conversation Explorer is available through the Aiso API and MCP as documented above. For a separate Apify workflow, use the Apify Conversations API.
Open Apify Conversations APIErrors
Error responses always return { "error": "message" }.
| Status | Meaning |
|---|---|
401 | Missing or invalid API key. |
403 | Visibility data not available yet, or no Explorer credits remaining. |
409 | Setup or prompt write already completed, or project limit reached. |
404 | Project or resource not found. |
429 | Rate limit exceeded. |
500 | Internal server error. |