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

# /api/v1

> Returns a human-readable message with some useful information about the API.



## OpenAPI

````yaml /openapi/server.json get /
openapi: 3.1.0
info:
  title: Hexclave REST API
  version: 1.0.0
  description: >-
    The Hexclave REST API. All request headers are documented as canonical
    `X-Hexclave-*`; the equivalent `X-Stack-*` aliases are accepted on every
    endpoint for backwards compatibility. Response headers
    `X-Hexclave-actual-status`, `X-Hexclave-known-error`, and
    `X-Hexclave-request-id` are emitted alongside their legacy `X-Stack-*`
    equivalents.
servers:
  - url: https://api.hexclave.com/api/v1
    description: Hexclave REST API
security: []
paths:
  /:
    get:
      tags: []
      summary: /api/v1
      description: >-
        Returns a human-readable message with some useful information about the
        API.
      parameters:
        - name: X-Hexclave-Project-Id
          in: header
          schema:
            type: string
            example: e0b52f4d-dece-408c-af49-d23061bb0f8d
            description: The unique identifier of the project
          description: The unique identifier of the project
          example: e0b52f4d-dece-408c-af49-d23061bb0f8d
          required: false
        - name: X-Hexclave-Branch-Id
          in: header
          schema:
            type: string
            example: e0b52f4d-dece-408c-af49-d23061bb0f8d
            description: The unique identifier of the project
          description: The unique identifier of the project
          example: e0b52f4d-dece-408c-af49-d23061bb0f8d
          required: false
        - name: X-Hexclave-Access-Type
          in: header
          schema:
            type: string
            enum:
              - client
              - server
              - admin
          required: false
        - name: X-Hexclave-Access-Token
          in: header
          schema:
            type: string
          required: false
        - name: X-Hexclave-Refresh-Token
          in: header
          schema:
            type: string
          required: false
        - name: X-Hexclave-Publishable-Client-Key
          in: header
          schema:
            type: string
          required: false
        - name: X-Hexclave-Secret-Server-Key
          in: header
          schema:
            type: string
          required: false
        - name: X-Hexclave-Super-Secret-Admin-Key
          in: header
          schema:
            type: string
          required: false
        - name: X-Stack-Project-Id
          in: header
          schema:
            type: string
            example: e0b52f4d-dece-408c-af49-d23061bb0f8d
            description: The unique identifier of the project
          description: The unique identifier of the project
          example: e0b52f4d-dece-408c-af49-d23061bb0f8d
          required: false
        - name: X-Stack-Branch-Id
          in: header
          schema:
            type: string
            example: e0b52f4d-dece-408c-af49-d23061bb0f8d
            description: The unique identifier of the project
          description: The unique identifier of the project
          example: e0b52f4d-dece-408c-af49-d23061bb0f8d
          required: false
        - name: X-Stack-Access-Type
          in: header
          schema:
            type: string
            enum:
              - client
              - server
              - admin
          required: false
        - name: X-Stack-Access-Token
          in: header
          schema:
            type: string
          required: false
        - name: X-Stack-Refresh-Token
          in: header
          schema:
            type: string
          required: false
        - name: X-Stack-Publishable-Client-Key
          in: header
          schema:
            type: string
          required: false
        - name: X-Stack-Secret-Server-Key
          in: header
          schema:
            type: string
          required: false
        - name: X-Stack-Super-Secret-Admin-Key
          in: header
          schema:
            type: string
          required: false
      responses:
        '200':
          description: Successful response
          content:
            text/plain:
              schema:
                type: string
                example: >-
                  Welcome to the Hexclave API endpoint! Please refer to the
                  documentation at https://docs.hexclave.com/


                  Authentication: None

````