> ## Documentation Index > Fetch the complete documentation index at: https://docs.geoly.ai/llms.txt > Use this file to discover all available pages before exploring further. # 获取单条监测记录 > Answer text is only returned when include=answer_text. Citations, search sources and shopping are bounded (30/30/20), with total counts and truncation flags. Internal provider errors and raw analysis are excluded. Responses exceeding 4 MB are rejected before settlement; omit include to fetch metadata. Billed per call at the price in x-geoly-cost, using the existing MCP credit meter. Billing outcomes are in meta.quota. ## OpenAPI ````yaml api-reference/openapi.json GET /api/v1/records/{record_id} openapi: 3.1.0 info: title: GEOly Data API version: '1' description: >- Typed endpoints of the GEOly Data API (`x-geoly-stability: stable`): the account behind the key (GET /api/v1/quota, /api/v1/brand), the brand catalog (GET /api/v1/topics, /api/v1/prompts), monitoring records (GET /api/v1/prompts/{prompt_id}/records, /api/v1/records/{record_id}) and the incremental record feed (GET /api/v1/records), writes (POST /api/v1/prompts, POST /api/v1/prompts/{prompt_id}/runs) and windowed reports (POST /api/v1/reports/*). Authenticate with an API key bound to one brand; the brand is implied by the key and never appears in paths. Stability: within /api/v1 the shape and meaning of every declared field is stable — fields are never removed, renamed or retyped, units never change, and enums only grow (response enums are open: ignore unknown values and unknown fields). Metric definitions follow the product and are recorded in the changelog. Breaking changes only ship under /api/v2. Envelope: `{ data, page?, meta }`. `meta.quota` is the billing outcome of the call; `meta.schema_conformant` is false only if the report output drifted from this document (the data is still returned). Pagination: send `limit` (and `cursor` from `page.next_cursor` for the next page, with exactly the same filters). `page.next_cursor === null` is the only end-of-list signal; `page.capped: true` means the position limit was reached before the end. GET /api/v1/prompts uses a true keyset cursor (ordered by created_at, id): a row whose sort key is unchanged and that still matches the filters is never skipped or repeated because other rows were added or archived meanwhile, and there is no position limit. It is not a snapshot: every page re-applies the filters, so a row archived before you reach it drops out of an active listing. `x-geoly-pagination` describes each list. Errors use one envelope `{error:{code,message,details?},meta}`; `error.code` is drawn from the closed list in `x-geoly-error-codes`. Branch on the HTTP status and `error.code`, never on `message`. Stable keys of `error.details`: errors[] ({param, reason, allowed?, message}), reason, required, retry_after_seconds, max_bytes, actual_bytes, _quota, and resource / id (404 NOT_FOUND of a single-resource endpoint such as GET /api/v1/prompts/{prompt_id}). Billing: each call is billed at the price in `x-geoly-cost` ({tier, base, unit, long_window_multiplier, guard_rpm}: nominal price per call in credits, the same as the matching GEOly MCP tool (GET /api/v1/records has none: it is offered only on this API, so its price and guard are its own), against the MCP credits pool; tier "free" with base 0 = not charged — this includes operations whose matching MCP tool is registered as not charged (charged:false: POST /api/v1/prompts and POST /api/v1/prompts/{prompt_id}/runs), so no nominal price is declared for them; guard_rpm is the per-organization requests-per-minute guard of that endpoint — counted per organization together with the same organization's calls of the matching GEOly MCP tool on the other surfaces (MCP, Agent API)). The billing outcome of every call is in `meta.quota`. A monitoring run still consumes monitoring credits, a separate pool, as described on that operation. The HTTP tool wrappers under /api/v1/tools and /api/v1/tools/{tool} are retired: every method answers 410 TOOL_SURFACE_RETIRED, and for a known tool details.replacement names the resource endpoint. Use these resource endpoints. MCP and Agent API remain available. servers: - url: https://app.geoly.ai security: - bearerAuth: [] tags: - name: Records description: Monitoring records and optional full answer text. - name: Account description: The organization, credits and brand behind this API key. - name: Catalog description: >- Topics and prompts of the brand behind this API key (GET, no metrics computed; the price of each operation is in x-geoly-cost). - name: Reports description: >- Windowed brand-visibility reports (POST with a JSON body; nothing is created). paths: /api/v1/records/{record_id}: get: tags: - Records summary: One monitoring record, optionally including its answer description: >- Answer text is only returned when include=answer_text. Citations, search sources and shopping are bounded (30/30/20), with total counts and truncation flags. Internal provider errors and raw analysis are excluded. Responses exceeding 4 MB are rejected before settlement; omit include to fetch metadata. Billed per call at the price in x-geoly-cost, using the existing MCP credit meter. Billing outcomes are in meta.quota. operationId: getRecord parameters: - name: record_id in: path required: true description: Resource id for this API key brand. schema: type: string minLength: 1 maxLength: 64 - name: include in: query required: false description: Return the full answer text; otherwise answer_text is null. schema: type: string enum: - answer_text responses: '200': description: >- One monitoring record, optionally including its answer. `data` follows Record when meta.schema_conformant is true. headers: Request-Id: $ref: '#/components/headers/Request-Id' GEOly-API-Version: $ref: '#/components/headers/GEOly-API-Version' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-DB-Budget-Limit: $ref: '#/components/headers/X-DB-Budget-Limit' X-DB-Budget-Used: $ref: '#/components/headers/X-DB-Budget-Used' X-DB-Budget-Reset: $ref: '#/components/headers/X-DB-Budget-Reset' content: application/json: schema: $ref: '#/components/schemas/RecordEnvelope' '400': description: >- INVALID_ARGUMENT (unknown query parameter, non-integer or out-of-range number, invalid enum value — details.errors[] lists each {param, reason, allowed?}). Not charged. headers: Request-Id: $ref: '#/components/headers/Request-Id' GEOly-API-Version: $ref: '#/components/headers/GEOly-API-Version' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-DB-Budget-Limit: $ref: '#/components/headers/X-DB-Budget-Limit' X-DB-Budget-Used: $ref: '#/components/headers/X-DB-Budget-Used' X-DB-Budget-Reset: $ref: '#/components/headers/X-DB-Budget-Reset' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': description: 'UNAUTHORIZED: missing or invalid API key.' headers: Request-Id: $ref: '#/components/headers/Request-Id' GEOly-API-Version: $ref: '#/components/headers/GEOly-API-Version' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '402': description: >- QUOTA_EXCEEDED / SUBSCRIPTION_INACTIVE / ORG_NOT_ELIGIBLE. Not charged. headers: Request-Id: $ref: '#/components/headers/Request-Id' GEOly-API-Version: $ref: '#/components/headers/GEOly-API-Version' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-DB-Budget-Limit: $ref: '#/components/headers/X-DB-Budget-Limit' X-DB-Budget-Used: $ref: '#/components/headers/X-DB-Budget-Used' X-DB-Budget-Reset: $ref: '#/components/headers/X-DB-Budget-Reset' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '403': description: >- API_KEY_BRAND_REQUIRED (the key is not bound to a brand) / PERMISSION_DENIED (the key lacks the read permission in x-geoly-required-permission; details.required names it). Not charged. headers: Request-Id: $ref: '#/components/headers/Request-Id' GEOly-API-Version: $ref: '#/components/headers/GEOly-API-Version' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-DB-Budget-Limit: $ref: '#/components/headers/X-DB-Budget-Limit' X-DB-Budget-Used: $ref: '#/components/headers/X-DB-Budget-Used' X-DB-Budget-Reset: $ref: '#/components/headers/X-DB-Budget-Reset' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: >- NOT_FOUND: no record with this record_id for the brand of this API key (details.reason = "not_found", details.resource = "record", details.id echoes the record_id). Billing follows meta.quota.charge. headers: Request-Id: $ref: '#/components/headers/Request-Id' GEOly-API-Version: $ref: '#/components/headers/GEOly-API-Version' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-DB-Budget-Limit: $ref: '#/components/headers/X-DB-Budget-Limit' X-DB-Budget-Used: $ref: '#/components/headers/X-DB-Budget-Used' X-DB-Budget-Reset: $ref: '#/components/headers/X-DB-Budget-Reset' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '422': description: >- RESPONSE_TOO_LARGE: response exceeds 4 MB; omit include=answer_text to retrieve metadata. Rejected before settlement. headers: Request-Id: $ref: '#/components/headers/Request-Id' GEOly-API-Version: $ref: '#/components/headers/GEOly-API-Version' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-DB-Budget-Limit: $ref: '#/components/headers/X-DB-Budget-Limit' X-DB-Budget-Used: $ref: '#/components/headers/X-DB-Budget-Used' X-DB-Budget-Reset: $ref: '#/components/headers/X-DB-Budget-Reset' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '429': description: >- RATE_LIMITED / GUARDED_RATE_LIMITED / BUSY / BUDGET_EXCEEDED. Not charged; honor Retry-After and pace with X-DB-Budget-*. headers: Request-Id: $ref: '#/components/headers/Request-Id' GEOly-API-Version: $ref: '#/components/headers/GEOly-API-Version' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-DB-Budget-Limit: $ref: '#/components/headers/X-DB-Budget-Limit' X-DB-Budget-Used: $ref: '#/components/headers/X-DB-Budget-Used' X-DB-Budget-Reset: $ref: '#/components/headers/X-DB-Budget-Reset' Retry-After: $ref: '#/components/headers/Retry-After' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '500': description: >- INTERNAL_ERROR: unexpected server error (not charged). Retry once with backoff; report the Request-Id if it persists. headers: Request-Id: $ref: '#/components/headers/Request-Id' GEOly-API-Version: $ref: '#/components/headers/GEOly-API-Version' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-DB-Budget-Limit: $ref: '#/components/headers/X-DB-Budget-Limit' X-DB-Budget-Used: $ref: '#/components/headers/X-DB-Budget-Used' X-DB-Budget-Reset: $ref: '#/components/headers/X-DB-Budget-Reset' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '503': description: >- TOOL_TIMEOUT / OVERLOADED / CIRCUIT_OPEN / TOOL_FAILED. Not charged; retry later, honoring Retry-After when present. (502 / 504 are never used.) headers: Request-Id: $ref: '#/components/headers/Request-Id' GEOly-API-Version: $ref: '#/components/headers/GEOly-API-Version' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-DB-Budget-Limit: $ref: '#/components/headers/X-DB-Budget-Limit' X-DB-Budget-Used: $ref: '#/components/headers/X-DB-Budget-Used' X-DB-Budget-Reset: $ref: '#/components/headers/X-DB-Budget-Reset' Retry-After: $ref: '#/components/headers/Retry-After' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' security: - bearerAuth: [] components: headers: Request-Id: description: >- Unique id of this request (equals meta.request_id). Include it when reporting a problem. schema: type: string GEOly-API-Version: description: API contract version. Always "1" on /api/v1. schema: type: string X-RateLimit-Limit: description: >- Requests allowed per credential in the current one-minute window. Sent on every response after the API key has been authenticated; absent on errors raised while authenticating (401) and on 405. schema: type: integer X-RateLimit-Remaining: description: Requests left in the current window. schema: type: integer X-RateLimit-Reset: description: Seconds until the current window resets (0–60). schema: type: integer X-DB-Budget-Limit: description: >- Organization database-seconds budget per rolling 60 minutes. Sent on every response after authentication. schema: type: integer X-DB-Budget-Used: description: Database seconds used by the organization in the last 60 minutes. schema: type: integer X-DB-Budget-Reset: description: Seconds until the oldest usage bucket expires. schema: type: integer Retry-After: description: Seconds to wait before retrying (429; 503 when retryable). schema: type: integer schemas: RecordEnvelope: type: object properties: data: oneOf: - $ref: '#/components/schemas/Record' - type: 'null' description: >- One monitoring record, optionally including its answer. null only when meta.schema_conformant is false and the output could not be mapped. meta: $ref: '#/components/schemas/CuratedMeta' required: - data - meta ErrorEnvelope: type: object properties: error: type: object properties: code: type: string description: '[Extensible enum] One of x-geoly-error-codes.' examples: - INVALID_BODY - INVALID_ARGUMENT - INVALID_CURSOR - IDEMPOTENCY_KEY_INVALID - FAILED_PRECONDITION - UNAUTHORIZED - SUBSCRIPTION_INACTIVE - QUOTA_EXCEEDED - ORG_NOT_ELIGIBLE - PLAN_LIMIT_REACHED - API_KEY_BRAND_REQUIRED - ORG_SELECTION_REQUIRED - ORGANIZATION_REQUIRED - PERMISSION_DENIED - REPORT_NOT_FOUND - NOT_FOUND - METHOD_NOT_ALLOWED - IDEMPOTENCY_KEY_REUSED - REQUEST_IN_PROGRESS - IDEMPOTENCY_OUTCOME_UNKNOWN - TOOL_SURFACE_RETIRED - PAYLOAD_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - QUERY_TOO_EXPENSIVE - RESPONSE_TOO_LARGE - RATE_LIMITED - GUARDED_RATE_LIMITED - BUSY - BUDGET_EXCEEDED - INTERNAL_ERROR - TOOL_TIMEOUT - OVERLOADED - CIRCUIT_OPEN - TOOL_FAILED - FEED_NOT_READY - IDEMPOTENCY_UNAVAILABLE message: type: string description: For humans; do not parse. details: type: object description: >- Stable keys: errors[] ({param, reason, allowed?, message}) on INVALID_ARGUMENT; reason; required (PERMISSION_DENIED); retry_after_seconds (429); max_bytes / actual_bytes (413 / 422); _quota (receipt); resource / id (404 NOT_FOUND of a single-resource endpoint). Other keys are informational and may change. required: - code - message meta: $ref: '#/components/schemas/CuratedErrorMeta' required: - error - meta Record: type: object properties: id: type: string platform_code: type: string platform_name: type: string record_date_at: type: string format: date-time business_date: type: string pattern: ^\d{4}-\d{2}-\d{2}$ status: type: string examples: - pending - running - completed - failed - timeout - cancelled - skipped description: >- [Extensible enum] Known values: "pending", "running", "completed", "failed", "timeout", "cancelled", "skipped"; more may be added. position: type: - integer - 'null' mention_rank: type: - integer - 'null' mentions: type: - integer - 'null' minimum: 0 sentiment: type: - string - 'null' examples: - positive - neutral - negative - mixed description: >- [Extensible enum] Known values: "positive", "neutral", "negative", "mixed"; more may be added. sentiment_polarity: type: - number - 'null' minimum: -1 maximum: 1 prompt_id: type: string prompt_text: type: string in_flight: type: boolean executed_at: type: - string - 'null' format: date-time created_at: type: string format: date-time updated_at: type: string format: date-time ai_model: type: - string - 'null' country: type: - string - 'null' sentiment_highlights: type: - array - 'null' items: type: string displayed: type: object properties: sentiment: type: - string - 'null' examples: - positive - neutral - negative - mixed description: >- [Extensible enum] Known values: "positive", "neutral", "negative", "mixed"; more may be added. mention_rank: type: - integer - 'null' required: - sentiment - mention_rank additionalProperties: {} web_search_status: type: string examples: - searched - not_searched - unknown description: >- [Extensible enum] Known values: "searched", "not_searched", "unknown"; more may be added. search_queries: type: array items: type: string related_prompts: type: - array - 'null' items: type: string shopping_visible: type: - boolean - 'null' ai_overview_triggered: type: - boolean - 'null' answer_text: type: - string - 'null' answer_text_state: type: string examples: - included - not_requested - empty description: >- [Extensible enum] Known values: "included", "not_requested", "empty"; more may be added. citations: type: array items: type: object properties: id: type: string source_type: type: string examples: - citation - link_attached - source_chip description: >- [Extensible enum] Known values: "citation", "link_attached", "source_chip"; more may be added. url: type: - string - 'null' site_name: type: - string - 'null' domain: type: - string - 'null' title: type: - string - 'null' position: type: - integer - 'null' cited: type: - boolean - 'null' description: type: - string - 'null' link_text: type: - string - 'null' marker_positions: type: array items: type: integer is_brand_mention: type: boolean required: - id - source_type - url - site_name - domain - title - position - cited - description - link_text - marker_positions - is_brand_mention additionalProperties: {} total_citations: type: integer minimum: 0 citations_truncated: type: boolean search_sources: type: array items: type: object properties: id: type: string rank: type: - integer - 'null' url: type: string title: type: - string - 'null' snippet: type: - string - 'null' published: type: - string - 'null' required: - id - rank - url - title - snippet - published additionalProperties: {} total_search_sources: type: integer minimum: 0 search_sources_truncated: type: boolean shopping: type: array items: type: object properties: id: type: string title: type: string rating: type: - number - 'null' reviews: type: - integer - 'null' minimum: 0 link: type: - string - 'null' image_url: type: - string - 'null' seller: type: - string - 'null' final_price: type: - number - 'null' price_currency: type: - string - 'null' tag: type: - string - 'null' required: - id - title - rating - reviews - link - image_url - seller - final_price - price_currency - tag additionalProperties: {} total_shopping: type: integer minimum: 0 shopping_truncated: type: boolean mentioned_brands: type: - array - 'null' items: type: object properties: entity_id: type: - string - 'null' description: >- Brand-entity id, the same id the brand-board report uses. null when source is legacy. source: description: >- [Extensible enum] entity = the brand-entity layer. legacy = fallback for an answer that has no entity rows yet: the brand comes from the older mentioned-brands table, with no entity id, no mention count and no role. Known values: "entity", "legacy"; more may be added. type: string examples: - entity - legacy name: type: string is_own_brand: type: boolean role: type: - string - 'null' stance: type: - string - 'null' examples: - preferred - equal - inferior - we_absent description: >- [Extensible enum] Known values: "preferred", "equal", "inferior", "we_absent"; more may be added. stance_source: type: - string - 'null' examples: - vote - prmb description: >- [Extensible enum] Known values: "vote", "prmb"; more may be added. mention_count: type: - integer - 'null' minimum: 0 description: >- Mentions of this brand in the answer. null when source is legacy (the fallback table has no count). domain: type: - string - 'null' required: - entity_id - source - name - is_own_brand - role - stance - stance_source - mention_count - domain additionalProperties: {} mentioned_brands_state: type: string examples: - ok - unavailable description: >- [Extensible enum] Known values: "ok", "unavailable"; more may be added. required: - id - platform_code - platform_name - record_date_at - business_date - status - position - mention_rank - mentions - sentiment - sentiment_polarity - prompt_id - prompt_text - in_flight - executed_at - created_at - updated_at - ai_model - country - sentiment_highlights - displayed - web_search_status - search_queries - related_prompts - shopping_visible - ai_overview_triggered - answer_text - answer_text_state - citations - total_citations - citations_truncated - search_sources - total_search_sources - search_sources_truncated - shopping - total_shopping - shopping_truncated - mentioned_brands - mentioned_brands_state additionalProperties: {} CuratedMeta: type: object properties: request_id: type: string report: type: string description: >- Report name for POST /api/v1/reports/{report}; resource labels include quota, brand, topics, prompt-catalog, prompt, prompt-records, prompt-records-latest, record, record-feed, created-prompt and prompt-run. duration_ms: type: integer quota: $ref: '#/components/schemas/QuotaMeta' schema_conformant: type: boolean description: >- true = data matches the documented schema exactly (every declared key present). false = the report output drifted; data is still returned as mapped (or null) — treat it as best effort. required: - request_id - report - duration_ms - schema_conformant CuratedErrorMeta: type: object properties: request_id: type: string report: type: string duration_ms: type: integer quota: $ref: '#/components/schemas/QuotaMeta' required: - request_id QuotaMeta: type: object description: >- Billing outcome of this call. remaining / resets_at / unlimited are null on paths that never reserved credits (free reports, calls rejected before execution) — except QUOTA_EXCEEDED, which carries the live balance. Absent when the call was rejected before the report ran (schema errors, cursor errors, authentication). properties: cost: type: integer description: Credits actually charged for this call. unlimited: type: - boolean - 'null' remaining: type: - integer - 'null' description: >- Credits left this period; null when unlimited or unknown on this path. resets_at: type: - string - 'null' format: date-time charge: type: string examples: - charged - min_fee - free - refunded - refund_pending - unbilled description: >- [Extensible enum] charged = normal settlement (per row, or one call for a call-priced read — including a not-found from the prompt or record detail); min_fee = minimum call fee (no data / not found from a per-row report / platform not purchased / missing locale); free = free report or endpoint; refunded / refund_pending = failed and refunded; unbilled = rejected before execution, or not metered. min_fee_reason: type: - string - 'null' examples: - missing_locale - no_data - null description: '[Extensible enum]' required: - cost - unlimited - remaining - resets_at - charge - min_fee_reason securitySchemes: bearerAuth: type: http scheme: bearer description: >- API key from Settings → Developer → API keys (prefix geom_). Each key is bound to one brand. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.