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

# Check status

> Liveness, callable without credentials. With a project API key it also confirms
the key and, for an app of the key's project named by `X-Hasp-AppId`, reports
whether the app is in maintenance.



## OpenAPI

````yaml /openapi/data-v1.json get /status
openapi: 3.1.2
info:
  title: HASP Data API
  version: '2026-07-12'
  description: >-
    The HASP Data API reads and writes the records of an app's entities. Each
    entity's fields are declared in the

    app's schema (`GET /projects/{project}/schema`); a record is those fields
    plus `id`, `created_at`, and `updated_at`.

    Two app-level endpoints serve the runtime SDK: `GET /bootstrap` and `GET
    /status`, addressed by `X-Hasp-AppId`.


    Authenticate with a project API key (`Authorization: Bearer
    hasp_pak_live_…`), a delegated agent credential

    (`Bearer hasp_agt_live_…`), or — from the app itself — the runtime session
    cookie. Reads of a public app may be

    anonymous with an `X-Hasp-AppId` header naming the app. See

    [Authentication](https://docs.usehasp.com/ai-api/authentication#data-api).


    Errors use the same envelope as the AI API: `{"success": false, "error":
    {"type", "code", "message", "param",

    "details", "retryable", "request_id"}, "meta": {"request_id"}}`.
servers:
  - url: https://{org}.usehasp.run/api/hasp/v1
    description: App runtime origin
    variables:
      org:
        default: your-org
        description: Your organization's runtime subdomain.
security:
  - projectApiKey: []
  - agentCredential: []
  - runtimeSession: []
paths:
  /status:
    get:
      tags:
        - Status
      summary: Check status
      description: >-
        Liveness, callable without credentials. With a project API key it also
        confirms

        the key and, for an app of the key's project named by `X-Hasp-AppId`,
        reports

        whether the app is in maintenance.
      operationId: usehasp.status
      parameters:
        - name: X-Hasp-AppId
          in: header
          description: >-
            With a project API key: an app of the key's project whose
            maintenance state to report. Ignored without credentials, and for an
            app of another project.
          schema:
            type: string
      responses:
        '200':
          description: >-
            Liveness, plus the key and app detail an authenticated caller is
            entitled to.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - ok
                      - maintenance
                  message:
                    type: string
                  estimatedSeconds:
                    type: integer
                  authenticated:
                    type: boolean
                  auth_type:
                    type: string
                    const: api_key
                  project:
                    type: object
                    properties:
                      id:
                        type: string
                    required:
                      - id
                  key:
                    type: object
                    properties:
                      role:
                        type: string
                      prefix:
                        type: string
                    required:
                      - role
                      - prefix
                required:
                  - status
        '401':
          description: >-
            `INVALID_API_KEY`, `API_KEY_REVOKED`, or `API_KEY_EXPIRED`: the
            bearer token sent is not a usable project API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: >-
            `IP_NOT_ALLOWED`: the project API key's IP allowlist excludes this
            address.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '423':
          description: >-
            `ORG_FROZEN`: HASP has frozen the key's organization during an
            incident; requests are refused until it is unfrozen.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - projectApiKey: []
        - {}
components:
  schemas:
    ApiError:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            type:
              type: string
              description: The error category.
            code:
              type: string
              description: >-
                Stable machine-readable code; branch on this. See
                https://docs.usehasp.com/ai-api/reference/errors.
            message:
              type: string
            param:
              type:
                - string
                - 'null'
              description: The first input path at fault, when there is one.
            details:
              type:
                - object
                - 'null'
              description: >-
                Validation failures keyed by input path (`data.title`,
                `records.3.title`, `filter.age`).
              additionalProperties:
                type: array
                items:
                  type: string
            retryable:
              type: boolean
            request_id:
              type: string
          required:
            - type
            - code
            - message
            - retryable
            - request_id
        meta:
          type: object
          properties:
            request_id:
              type: string
          required:
            - request_id
      required:
        - success
        - error
        - meta
      title: ApiError
  securitySchemes:
    projectApiKey:
      type: http
      description: Project API key, for server-to-server access to one project.
      scheme: bearer
      bearerFormat: hasp_pak_{live|test}_…
    agentCredential:
      type: http
      description: Delegated agent credential, scoped by its authorization grants.
      scheme: bearer
      bearerFormat: hasp_agt_{live|test}_…
    runtimeSession:
      type: apiKey
      description: >-
        The signed-in user's session on the app runtime host; what the JS SDK
        uses.
      in: cookie
      name: hasp-runtime-session

````

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