> ## Documentation Index > Fetch the complete documentation index at: https://docs.citino.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get one prompt > One question: your figures on it, per engine, every brand named, the sources read, and its replacement if it was reworded. ## OpenAPI ````yaml /api-reference/openapi.json get /projects/{projectId}/prompts/{promptId} openapi: 3.1.0 info: title: Citino API version: v1 description: >- Read how AI engines answer your market's questions, and keep your prompts, competitors, segments and engines in step from code. Every number carries its band and sample size. servers: - url: https://api.citino.ai/v1 security: - bearerAuth: [] tags: - name: Brand and competitors - name: Definitions - name: Engines - name: Projects - name: Alerts - name: Attribution - name: Claims - name: Crawlability - name: Crawler activity - name: Metrics - name: Experiments - name: Prompts - name: Objections - name: Monthly reports - name: Reports - name: Runs - name: Searches - name: Sources - name: Work items - name: Settings paths: /projects/{projectId}/prompts/{promptId}: get: tags: - Prompts summary: Get one prompt description: >- One question: your figures on it, per engine, every brand named, the sources read, and its replacement if it was reworded. operationId: getProjectsByProjectIdPromptsByPromptId parameters: - name: projectId in: path required: true schema: type: string - name: promptId in: path required: true schema: type: string - name: window in: query required: false description: >- A named window ending today in the project's market, or custom with from and to. Default 30d. schema: description: >- A named window ending today in the project's market, or custom with from and to. Default 30d. type: string enum: - 7d - 30d - 90d - 180d - 365d - custom - name: from in: query required: false description: First day, inclusive. Required with window=custom. schema: description: First day, inclusive. Required with window=custom. type: string pattern: ^\d{4}-\d{2}-\d{2}$ - name: to in: query required: false description: Last day, inclusive. Required with window=custom. schema: description: Last day, inclusive. Required with window=custom. type: string pattern: ^\d{4}-\d{2}-\d{2}$ - name: segments in: query required: false description: >- One value: your-segments (the default, the segments you claimed), all-segments, or one segment id. schema: description: >- One value: your-segments (the default, the segments you claimed), all-segments, or one segment id. type: string minLength: 1 maxLength: 120 - name: engines in: query required: false description: Comma-separated engine keys, narrowing the project's own engines. schema: description: Comma-separated engine keys, narrowing the project's own engines. type: string minLength: 1 maxLength: 200 responses: '200': description: OK content: application/json: schema: type: object properties: project_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: The project asked about. scope: type: object propertyNames: type: string additionalProperties: {} description: >- What the figures cover: the window, its dates, the engines and the answers counted, with a sentence saying so. prompt: type: object properties: id: type: string text: type: string intent: type: string scope: type: string segments: type: array items: type: string facets: type: array items: type: string status: type: string first_run_date: anyOf: - type: string pattern: ^\d{4}-\d{2}-\d{2}$ - type: 'null' answers: type: integer minimum: -9007199254740991 maximum: 9007199254740991 visibility: type: object properties: value: type: - number - 'null' unit: type: string enum: - percent - points - count - score - rank - ratio band: type: - number - 'null' 'n': type: integer minimum: -9007199254740991 maximum: 9007199254740991 delta: type: - number - 'null' within_noise: type: boolean low_sample: type: boolean state: type: string enum: - measured - no_data - never_named note: type: string required: - value - unit - band - 'n' - delta - within_noise - low_sample - state additionalProperties: false description: >- A measured number with its uncertainty. value is null with n = 0 (no answers yet); within_noise true means a delta is not a move. position: anyOf: - type: object properties: value: type: - number - 'null' unit: type: string enum: - percent - points - count - score - rank - ratio band: type: - number - 'null' 'n': type: integer minimum: -9007199254740991 maximum: 9007199254740991 delta: type: - number - 'null' within_noise: type: boolean low_sample: type: boolean state: type: string enum: - measured - no_data - never_named note: type: string required: - value - unit - band - 'n' - delta - within_noise - low_sample - state additionalProperties: false description: >- A measured number with its uncertainty. value is null with n = 0 (no answers yet); within_noise true means a delta is not a move. - type: 'null' required: - id - text - intent - scope - segments - facets - status - first_run_date - answers - visibility - position additionalProperties: false series: type: object properties: start: type: string pattern: ^\d{4}-\d{2}-\d{2}$ interval: type: string const: day unit: type: string const: percent series: type: array items: type: object properties: label: type: string brand_id: type: string own: type: boolean values: type: array items: type: - number - 'null' required: - label - brand_id - own - values additionalProperties: false markers: type: array items: type: object properties: date: type: string pattern: ^\d{4}-\d{2}-\d{2}$ kind: type: string enum: - drift - set_change required: - date - kind additionalProperties: false required: - start - interval - unit - series - markers additionalProperties: false by_engine: type: array items: type: object properties: engine: type: string visibility: type: object properties: value: type: - number - 'null' unit: type: string enum: - percent - points - count - score - rank - ratio band: type: - number - 'null' 'n': type: integer minimum: -9007199254740991 maximum: 9007199254740991 delta: type: - number - 'null' within_noise: type: boolean low_sample: type: boolean state: type: string enum: - measured - no_data - never_named note: type: string required: - value - unit - band - 'n' - delta - within_noise - low_sample - state additionalProperties: false description: >- A measured number with its uncertainty. value is null with n = 0 (no answers yet); within_noise true means a delta is not a move. position: type: object properties: value: type: - number - 'null' unit: type: string enum: - percent - points - count - score - rank - ratio band: type: - number - 'null' 'n': type: integer minimum: -9007199254740991 maximum: 9007199254740991 delta: type: - number - 'null' within_noise: type: boolean low_sample: type: boolean state: type: string enum: - measured - no_data - never_named note: type: string required: - value - unit - band - 'n' - delta - within_noise - low_sample - state additionalProperties: false description: >- A measured number with its uncertainty. value is null with n = 0 (no answers yet); within_noise true means a delta is not a move. required: - engine - visibility - position additionalProperties: false brands_named: type: array items: type: object properties: brand: type: object properties: id: description: Empty when nobody leads. type: - string - 'null' name: type: - string - 'null' own: type: boolean required: - id - name - own additionalProperties: false visibility: type: object properties: value: type: - number - 'null' unit: type: string enum: - percent - points - count - score - rank - ratio band: type: - number - 'null' 'n': type: integer minimum: -9007199254740991 maximum: 9007199254740991 delta: type: - number - 'null' within_noise: type: boolean low_sample: type: boolean state: type: string enum: - measured - no_data - never_named note: type: string required: - value - unit - band - 'n' - delta - within_noise - low_sample - state additionalProperties: false description: >- A measured number with its uncertainty. value is null with n = 0 (no answers yet); within_noise true means a delta is not a move. mean_position: type: object properties: value: type: - number - 'null' unit: type: string enum: - percent - points - count - score - rank - ratio band: type: - number - 'null' 'n': type: integer minimum: -9007199254740991 maximum: 9007199254740991 delta: type: - number - 'null' within_noise: type: boolean low_sample: type: boolean state: type: string enum: - measured - no_data - never_named note: type: string required: - value - unit - band - 'n' - delta - within_noise - low_sample - state additionalProperties: false description: >- A measured number with its uncertainty. value is null with n = 0 (no answers yet); within_noise true means a delta is not a move. required: - brand - visibility - mean_position additionalProperties: false sources: type: array items: type: object properties: domain: type: string type: type: string influenceable: type: boolean group: type: string enum: - actionable - competitor_owned - yours retrieved: type: integer minimum: -9007199254740991 maximum: 9007199254740991 cited: type: integer minimum: -9007199254740991 maximum: 9007199254740991 retrieved_share: type: number description: >- Percent of answers whose engine reports what it read. cited_share: type: number description: Percent of every answer. required: - domain - type - influenceable - group - retrieved - cited - retrieved_share - cited_share additionalProperties: false retrieval_share: type: object properties: value: type: - number - 'null' unit: type: string enum: - percent - points - count - score - rank - ratio band: type: - number - 'null' 'n': type: integer minimum: -9007199254740991 maximum: 9007199254740991 delta: type: - number - 'null' within_noise: type: boolean low_sample: type: boolean state: type: string enum: - measured - no_data - never_named note: type: string required: - value - unit - band - 'n' - delta - within_noise - low_sample - state additionalProperties: false description: >- A measured number with its uncertainty. value is null with n = 0 (no answers yet); within_noise true means a delta is not a move. replacement: anyOf: - type: object properties: replaces: anyOf: - type: object properties: prompt_id: type: string text: type: string deprecated_at: type: string required: - prompt_id - text - deprecated_at additionalProperties: false - type: 'null' replaced_by: anyOf: - type: object properties: prompt_id: type: string text: type: string first_run_date: type: string required: - prompt_id - text - first_run_date additionalProperties: false - type: 'null' required: - replaces - replaced_by additionalProperties: false - type: 'null' required: - project_id - scope - prompt - series - by_engine - brands_named - sources - retrieval_share - replacement additionalProperties: false example: project_id: 00000000-0000-4000-8000-000000000001 scope: window: 30d from: '2026-10-09' to: '2026-11-07' engines: - chatgpt - google-ai-overview - perplexity segmentScope: claimed segments: - wms promptScope: category promptsInScope: 1 answers: 30 subtitle: 30 answers in the last 30 days customPromptsExcluded: true prompt: id: p_acme_001 text: best 3PL software for a growing ecommerce brand intent: compare scope: category segments: - wms facets: [] status: active first_run_date: '2026-11-04' answers: 30 visibility: value: 60 unit: percent band: null 'n': 30 delta: null within_noise: true low_sample: false state: measured position: value: 2 unit: rank band: null 'n': 18 delta: null within_noise: true low_sample: true state: measured series: start: '2026-10-09' interval: day unit: percent series: - label: Initech brand_id: 00000000-0000-4000-8000-000000000002 own: true values: - null - null - null - label: Globex brand_id: 00000000-0000-4000-8000-000000000003 own: false values: - null - null - null markers: [] by_engine: - engine: chatgpt visibility: value: 60 unit: percent band: null 'n': 30 delta: null within_noise: true low_sample: false state: measured position: value: 2 unit: rank band: null 'n': 18 delta: null within_noise: true low_sample: true state: measured - engine: google-ai-overview visibility: value: null unit: percent band: null 'n': 0 delta: null within_noise: true low_sample: true state: no_data note: needs one full run position: value: null unit: rank band: null 'n': 0 delta: null within_noise: true low_sample: true state: no_data note: needs one full run - engine: perplexity visibility: value: null unit: percent band: null 'n': 0 delta: null within_noise: true low_sample: true state: no_data note: needs one full run position: value: null unit: rank band: null 'n': 0 delta: null within_noise: true low_sample: true state: no_data note: needs one full run brands_named: - brand: id: 00000000-0000-4000-8000-000000000002 name: Initech own: true visibility: value: 60 unit: percent band: null 'n': 30 delta: null within_noise: true low_sample: false state: measured mean_position: value: 2 unit: rank band: null 'n': 18 delta: null within_noise: true low_sample: true state: measured - brand: id: 00000000-0000-4000-8000-000000000003 name: Globex own: false visibility: value: 30 unit: percent band: null 'n': 30 delta: null within_noise: true low_sample: false state: measured mean_position: value: 2 unit: rank band: null 'n': 9 delta: null within_noise: true low_sample: true state: measured sources: [] retrieval_share: value: null unit: percent band: null 'n': 0 delta: null within_noise: true low_sample: true state: no_data note: needs one full run replacement: null '400': description: The request is invalid; `error.field` names the parameter. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: 'No live API key in an `Authorization: Bearer` header.' content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: The key lacks the scope named in the message, or cannot write. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: No such resource in this key's projects. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Over the key's or the workspace's rate limit; see `Retry-After`. content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: Busy or timed out; retry after `Retry-After`. content: application/json: schema: $ref: '#/components/schemas/Error' x-codeSamples: - lang: bash label: curl source: >- curl "https://api.citino.ai/v1/projects/{projectId}/prompts/{promptId}" \ -H "Authorization: Bearer $CITINO_API_KEY" - lang: python label: Python source: |- import os import requests res = requests.get( "https://api.citino.ai/v1/projects/{projectId}/prompts/{promptId}", headers={"Authorization": f"Bearer {os.environ['CITINO_API_KEY']}"}, ) print(res.json()) - lang: javascript label: JavaScript source: >- const res = await fetch("https://api.citino.ai/v1/projects/{projectId}/prompts/{promptId}", { headers: { Authorization: `Bearer ${process.env.CITINO_API_KEY}`, }, }); console.log(await res.json()); components: schemas: Error: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string description: >- validation, unauthorized, forbidden, not_found, conflict, plan_limit, rate_limited, busy, query_timeout message: type: string field: type: string detail: type: object securitySchemes: bearerAuth: type: http scheme: bearer description: >- An API key from Workspace settings → API keys, sent as `Authorization: Bearer `. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.