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

# Health check

> Checks whether the ReyGrid API is operational.



## OpenAPI

````yaml /openapi.yaml get /ping
openapi: 3.0.3
info:
  title: ReyGrid API
  version: 1.0.3
  description: |
    ReyGrid API

    ## Persistent user conversations

    If you want to build a separate conversation system for each user,
    build a wrapper layer around the ReyGrid API.

    The wrapper should manage the application's own user IDs and map them
    to ReyGrid conversations.

    The wrapper is responsible for:
    - Managing and identifying users.
    - Storing the relationship between the application's userId and
      ReyGrid conversationId.
    - Persisting conversation IDs in the application's own database.
    - Reusing the stored conversationId when the same user continues
      a conversation.
    - Verifying that conversation IDs belong to the expected user before
      using them.

    ReyGrid's userId can also be used as a stable identifier for persistent
    conversations. However, if the application requires its own user and
    conversation management, it should maintain this mapping in its own
    database.
servers:
  - url: https://reygrid.com/api/v1
security: []
paths:
  /ping:
    get:
      summary: Health check
      description: Checks whether the ReyGrid API is operational.
      operationId: ping
      responses:
        '200':
          description: API health status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PingResponse'
              example:
                success: true
                status: UP
                service: reygrid-api
                version: 1.0.3
                metadata:
                  uptime: 86400
                  timestamp: '2026-10-05T10:21:34.120Z'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: curl https://reygrid.com/api/v1/ping
        - lang: python
          label: Python SDK
          source: |-
            from reygrid import ReyGrid

            client = ReyGrid(api_key="YOUR_API_KEY")

            print(client.ping().status)  # "UP"
        - lang: javascript
          label: TypeScript SDK
          source: |-
            import { ReyGrid } from "reygrid";

            const client = new ReyGrid({ apiKey: "YOUR_API_KEY" });

            const { status } = await client.ping(); // "UP"
components:
  schemas:
    PingResponse:
      type: object
      required:
        - success
        - status
        - service
        - version
      properties:
        success:
          type: boolean
        status:
          type: string
          enum:
            - UP
            - DOWN
        service:
          type: string
        version:
          type: string
        metadata:
          $ref: '#/components/schemas/PingMetadata'
    PingMetadata:
      type: object
      properties:
        uptime:
          type: integer
          description: API process uptime in seconds
        timestamp:
          type: string
          format: date-time

````

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