> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xpoz.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Health check

> Liveness and dependency health. Returns 503 when SingleStore is unhealthy.



## OpenAPI

````yaml https://api.xpoz.ai/openapi.json get /health
openapi: 3.1.0
info:
  title: XPOZ API
  version: 1.0.0
  description: >-
    Social media data API for Twitter/X, Instagram, Reddit, and TikTok.


    **Data endpoints** (`/api/data/*`) are authenticated with an API access key
    and are metered against the account's credits. Most stored-data endpoints
    share the same query options: `fields` selects which attributes to return,
    `since`/`until` bound the date range, and `responseType` picks between a
    synchronous first page (`fast`), a full paged query run as a background
    operation (`paging`), and a CSV export (`csv`). `/live` endpoints fetch from
    the platform on demand and page with a cursor instead.


    **Account, billing, and crawl-settings endpoints** are used by the XPOZ
    dashboard and authenticate with the user's session.
servers:
  - url: https://api.xpoz.ai
    description: Production
security: []
tags:
  - name: Twitter (live)
    description: >-
      On-demand Twitter/X fetches straight from the platform, cursor-paginated.
      Not available for trial access keys.
  - name: Instagram (live)
    description: >-
      On-demand Instagram fetches straight from the platform, cursor-paginated.
      Not available for trial access keys.
  - name: Reddit (live)
    description: >-
      On-demand Reddit fetches straight from the platform, cursor-paginated. Not
      available for trial access keys.
  - name: TikTok (live)
    description: >-
      On-demand TikTok fetches straight from the platform, cursor-paginated. Not
      available for trial access keys.
  - name: Operations
    description: Polling for background operations started with `responseType=paging`.
  - name: Account
    description: Access keys, plan, and usage of the signed-in user.
  - name: Billing
    description: Stripe checkout, subscription changes, and add-on purchases.
  - name: Crawl Settings
    description: Tracked items collected on a schedule.
  - name: System Status
    description: Platform status page and notifications.
  - name: Platform
    description: Health, metrics, and this spec.
paths:
  /health:
    get:
      tags:
        - Platform
      summary: Health check
      description: >-
        Liveness and dependency health. Returns 503 when SingleStore is
        unhealthy.
      operationId: getHealth
      responses:
        '200':
          description: Healthy or degraded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthStatus'
        '503':
          description: Unhealthy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthStatus'
      security: []
components:
  schemas:
    HealthStatus:
      type: object
      properties:
        status:
          type: string
          enum:
            - healthy
            - degraded
            - unhealthy
        version:
          type: string
        uptime:
          type: number
          description: Seconds.
        timestamp:
          type: string
          format: date-time
        dependencies:
          type: object
          properties:
            singlestore:
              $ref: '#/components/schemas/ServiceHealth'
          required:
            - singlestore
      required:
        - status
        - version
        - uptime
        - timestamp
        - dependencies
    ServiceHealth:
      type: object
      properties:
        status:
          type: string
          enum:
            - healthy
            - degraded
            - unhealthy
        responseTime:
          type: number
        error:
          type: string
      required:
        - status

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.