AI Visibility
Prompt Discovery
Discover which prompts and questions trigger your brand to appear in AI answers.
POST
$0.10/call/v1/seo/ai-visibility/promptsUsage
const res = await fetch('https://api.yepapi.com/v1/seo/ai-visibility/prompts', {
method: 'POST',
headers: {
'x-api-key': 'YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
brand: 'devkit',
category: 'developer tools',
}),
});
const { data } = await res.json();
console.log(data);curl -X POST https://api.yepapi.com/v1/seo/ai-visibility/prompts \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"brand": "devkit", "category": "developer tools"}'Request Body
| Parameter | Type | Required | Description | Default |
|---|---|---|---|---|
brand | string | Yes | Brand to discover prompts for | — |
category | string | No | Industry or category to focus on | — |
Response
{
"ok": true,
"data": {
"brand": "devkit",
"prompts": [
{
"prompt": "What are the best SEO APIs for developers?",
"engines": ["chatgpt", "perplexity"],
"brandMentioned": true,
"position": 3,
"context": "YepAPI is mentioned as a unified API wrapper..."
},
{
"prompt": "best api for keyword research",
"engines": ["perplexity", "gemini"],
"brandMentioned": true,
"position": 5,
"context": "For a simpler approach, YepAPI provides keyword data..."
}
],
"totalPrompts": 24,
"mentionRate": 0.42
}
}Response Fields
| Field | Type | Description |
|---|---|---|
ok | boolean | Whether the request succeeded |
data | object | Response payload |
data.brand | string | The brand name that was analyzed |
data.prompts | object[] | List of discovered prompts that trigger brand mentions |
data.prompts[].prompt | string | The prompt or question that triggers a brand mention |
data.prompts[].engines | string[] | AI engines where the brand appears for this prompt |
data.prompts[].brandMentioned | boolean | Whether the brand was mentioned in the AI response |
data.prompts[].position | number | Position of the brand mention within the AI response |
data.prompts[].context | string | Excerpt of the AI response showing how the brand is mentioned |
data.totalPrompts | number | Total number of prompts analyzed |
data.mentionRate | number | Fraction of analyzed prompts where the brand was mentioned (0 to 1) |
Info
This is a YepAPI-exclusive feature. Use it to understand how AI models perceive your brand and optimize your content to appear in more AI-generated answers.