> ## 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.

# Validate API key

> Validates the provided API key and returns usage information when the key is valid.



## OpenAPI

````yaml /openapi.yaml get /validate
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:
  /validate:
    get:
      summary: Validate API key
      description: >-
        Validates the provided API key and returns usage information when the
        key is valid.
      operationId: validateApiKey
      responses:
        '200':
          description: API key is valid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateResponse'
              example:
                success: true
                valid: true
                usage:
                  total: 1337
                  quotaLimit: 5000
        '401':
          description: API key is missing or invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthErrorResponse'
      security:
        - apiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl https://reygrid.com/api/v1/validate \
              -H "Authorization: Bearer $REYGRID_API_KEY"
        - lang: python
          label: Python SDK
          source: |-
            from reygrid import ReyGrid

            client = ReyGrid(api_key="YOUR_API_KEY")

            res = client.validate()
            print(res.valid, res.usage.total, res.usage.quotaLimit)
        - lang: javascript
          label: TypeScript SDK
          source: |-
            import { ReyGrid } from "reygrid";

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

            const { valid, usage } = await client.validate();
            console.log(valid, usage.total, usage.quotaLimit);
components:
  schemas:
    ValidateResponse:
      type: object
      required:
        - success
        - valid
        - usage
      properties:
        success:
          type: boolean
        valid:
          type: boolean
        usage:
          $ref: '#/components/schemas/Usage'
    AuthErrorResponse:
      type: object
      required:
        - error
        - code
      properties:
        error:
          type: string
          example: Unauthorized
        code:
          type: string
          example: AUTH_REQUIRED
    Usage:
      type: object
      required:
        - total
        - quotaLimit
      properties:
        total:
          type: integer
        quotaLimit:
          type: integer
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API-Key
      description: ReyGrid API key sent as a Bearer token.

````

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