> ## Documentation Index > Fetch the complete documentation index at: https://rankspot.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get one AI response > The full answer as markdown, the pages it cited in order, the searches the platform ran, and every brand it named with its rank and sentiment. ## OpenAPI ````yaml https://api.rankspot.ai/docs-json get /v1/ai-visibility/responses/{id} openapi: 3.0.0 info: title: RankSpot Public API description: >- The RankSpot Public API gives you programmatic access to your workspace data — keywords, backlinks, competitors, planned actions, articles, and more. ## Authentication All endpoints require a Bearer API key in the `Authorization` header: ``` Authorization: Bearer ``` Generate API keys from **Settings → API Keys** in the RankSpot dashboard. Each key is scoped to a single workspace. ## Pagination List endpoints return a consistent envelope: ```json { "data": { "total": 120, "offset": 0, "limit": 20, "count": 20, "items": [...] } } ``` Use `offset` and `limit` query parameters to paginate. Default limit is **20**, maximum is **100**. ## Status codes | Code | Meaning | |------|---------| | 200 | Success | | 201 | Created | | 204 | No content (delete / unarchive) | | 400 | Validation error or business rule violation | | 401 | Missing or invalid API key | | 404 | Resource not found or belongs to another workspace | version: '1.0' contact: {} servers: - url: https://api.rankspot.ai description: Production security: [] tags: - name: AI Visibility description: >- How AI answer engines see your brand. Track prompts, read the answers ChatGPT, Perplexity and Google gave, and work through the pages they cited. Prompts are run on a daily schedule by RankSpot, so answers appear after the next run rather than on demand. - name: Articles description: >- AI-generated blog articles. Articles are created automatically when a `write_article` action is sent to generation — they cannot be created directly via the API. - name: Backlinks description: >- Backlinks discovered for your domain and your competitors' domains. Backlinks are auto-synced on a background interval and cannot be created via the API. - name: Categories description: Categories for organising actions and articles within your workspace. - name: Competitors description: >- Competitor domains tracked in your workspace. Once added, keywords and backlinks for each competitor are fetched asynchronously on a background sync interval. - name: Forum Opportunities description: >- Forum threads and community posts surfaced as potential link-building or engagement opportunities. - name: Keywords description: >- SEO keywords tracked in your workspace, enriched with search volume, competition, and AI-generated relevance scores. - name: People Also Ask description: >- "People also ask" questions discovered from search results for your tracked keywords. - name: Actions description: >- The SEO work planned for your workspace. Each action carries a `type` saying what kind of work it is and which target it points at — see `POST /v1/actions` for the full list. Only `write_article` can be turned into an article; the rest are a person's job. Create actions yourself or let RankSpot generate them. - name: Research description: >- Live lookups against the open web: a Google search and a page fetch. The only endpoints here that spend credits per call. Neither response reports what it cost — the charge is real, and your remaining balance is visible in the RankSpot dashboard. Returns 402 when the workspace is out of credits. - name: Search Console description: >- Google Search Console performance data — clicks, impressions, CTR, and average position for your connected property. Requires GSC to be connected from the RankSpot dashboard. - name: Workspace description: >- Who the workspace is: brand, domain, what the business does and who it sells to. Read this first — the rest of the API returns opportunities that only mean something in the context of a particular business. paths: /v1/ai-visibility/responses/{id}: get: tags: - AI Visibility summary: Get one AI response description: >- The full answer as markdown, the pages it cited in order, the searches the platform ran, and every brand it named with its rank and sentiment. operationId: AiResponsesController_findOne parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AiResponseDetailDto' '404': description: Response not found or belongs to another workspace. security: - bearer: [] components: schemas: AiResponseDetailDto: type: object properties: id: type: string example: 3f1c2b4e-8d5a-4a2f-9c3e-7b1d6a5e4c20 promptId: type: string example: 9a8b7c6d-5e4f-4321-8765-1a2b3c4d5e6f promptText: type: string example: best seo tools for small business platform: allOf: - $ref: '#/components/schemas/AiPlatform' runDate: type: string example: '2026-07-26' description: The UTC day the prompt was run, `YYYY-MM-DD`. ownBrandMentioned: type: boolean nullable: true description: >- Whether the answer named your own brand. null when the answer has not been analysed yet. Read `brands` for where it placed and how the answer spoke of it. citationsCount: type: number example: 12 brands: description: Brands the answer named, most prominent first. type: array items: $ref: '#/components/schemas/AnsweredBrandDto' answerMarkdown: type: string nullable: true description: The full answer as markdown. citations: type: array items: $ref: '#/components/schemas/AnswerCitationDto' fanoutQueries: example: - best seo tools 2026 description: The searches the platform ran while composing the answer. type: array items: type: string required: - id - promptId - promptText - platform - runDate - ownBrandMentioned - citationsCount - brands - answerMarkdown - citations - fanoutQueries AiPlatform: type: string enum: - chatgpt - perplexity - google_ai_overview - google_ai_mode AnsweredBrandDto: type: object properties: name: type: string example: RankSpot domain: type: string example: rankspot.ai competitorId: type: string example: 3f1c2b4e-8d5a-4a2f-9c3e-7b1d6a5e4c20 description: >- The competitor this brand resolved to. Addresses the same record as the Competitors endpoints, so a brand named in an answer can be looked up there. nameAsWritten: type: string example: Rankspot description: The surface form the answer used, kept for audit. position: type: number example: 1 nullable: true description: Where the answer placed this brand, 1-based. sentiment: type: number example: 85 nullable: true description: >- How favourably the answer spoke, 0-100. Read it in bands if you need one: 0-33 negative, 34-66 neutral, 67-100 positive. isOwnBrand: type: boolean example: true required: - name - domain - competitorId - nameAsWritten - position - sentiment - isOwnBrand AnswerCitationDto: type: object properties: id: type: string example: 3f1c2b4e-8d5a-4a2f-9c3e-7b1d6a5e4c20 url: type: string example: https://rankspot.ai/blog/ai-seo-tools/ domain: type: string example: rankspot.ai title: type: string nullable: true example: The 12 best AI SEO tools position: type: number example: 1 description: Where the answer placed this source, 1-based. isOwnDomain: type: boolean example: true status: allOf: - $ref: '#/components/schemas/ProcessedStatus' required: - id - url - domain - title - position - isOwnDomain - status ProcessedStatus: type: string enum: - new - processed securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http ````