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

# Check your API key

> Confirms the key works and shows the account it belongs to and its hourly budget.



## OpenAPI

````yaml GET /test
openapi: 3.1.0
info:
  title: HITL API
  version: 1.0.0
  description: >-
    Run the workflows you build in HITL, follow each run until a person has
    answered, and manage who reviews them.
servers:
  - url: https://api.hitl.sh/v1
security:
  - bearerAuth: []
tags:
  - name: Workflows
  - name: Runs
  - name: Reviewers
  - name: Webhooks
  - name: Account
  - name: Uploads
paths:
  /test:
    get:
      tags:
        - Account
      summary: Check your API key
      description: >-
        Confirms the key works and shows the account it belongs to and its
        hourly budget.
      operationId: account-test-key
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: boolean
                  msg:
                    type: string
                  data:
                    type: object
                    properties:
                      api_key_id:
                        type: string
                      user_id:
                        type: string
                      email:
                        type: string
                      account_status:
                        type: string
                      rate_limit:
                        type: object
                        properties:
                          limit:
                            type: integer
                          remaining:
                            type: integer
                          reset_at:
                            type: string
                            format: date-time
              example:
                error: false
                msg: API key is valid
                data:
                  api_key_id: 6af2ce9d8207961501f59493
                  user_id: 6af2ce47967ce8777084a292
                  email: jordan.lee@example.com
                  account_status: active
                  rate_limit:
                    limit: 100
                    remaining: 4988
                    reset_at: '2026-11-10T09:00:00Z'
        '401':
          $ref: '#/components/responses/E401'
components:
  responses:
    E401:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: true
            msg: Invalid API key
  schemas:
    Error:
      type: object
      required:
        - error
        - msg
      properties:
        error:
          type: boolean
          example: true
        msg:
          type: string
          description: What went wrong, in plain words
        code:
          type: string
          description: >-
            A machine-readable reason, when there is one (for example
            `confirmation_required`)
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `hitl_live_…`'

````

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