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

# Liveness probe

> Reports that the API is reachable and serving requests



## OpenAPI

````yaml /openapi.generated.json get /api/v1/health
openapi: 3.0.3
info:
  title: Augment External API
  version: 1.0.0
  description: >
    Public, API-key-authenticated read surface for Augment company and offering
    data.
servers:
  - url: https://developer.augment.market
  - url: https://xxe4toqf29.execute-api.us-west-2.amazonaws.com/dev-ethan
security: []
paths:
  /api/v1/health:
    get:
      tags:
        - external-api-v1
      summary: Liveness probe
      description: Reports that the API is reachable and serving requests
      operationId: getExternalApiHealth
      responses:
        '200':
          description: The API is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthStatusResponse'
              example:
                status: healthy
                timestamp: '2025-01-15T12:00:00Z'
                version: 1.0.0
        '500':
          $ref: '#/components/responses/ErrorInternalError'
      security: []
components:
  schemas:
    HealthStatusResponse:
      type: object
      description: Liveness probe result
      properties:
        status:
          type: string
          description: Constant value 'healthy' when the API is serving requests
        timestamp:
          type: string
          format: date-time
          description: When the probe was served
        version:
          type: string
          description: Version of the API serving the request
      required:
        - status
        - timestamp
        - version
      additionalProperties: false
    ErrorEnvelope:
      type: object
      description: Error body returned by every failing response
      properties:
        error:
          type: string
          description: Human-readable error message
        code:
          $ref: '#/components/schemas/ErrorCode'
      required:
        - error
        - code
      additionalProperties: false
    ErrorCode:
      type: string
      description: >
        Machine-readable error code. Mirrors external/domain/errors.go exactly;
        the wire strings are part of the public contract and must not drift from
        that file.
      enum:
        - unauthenticated
        - invalid_key
        - key_revoked
        - insufficient_scope
        - client_suspended
        - not_found
        - invalid_parameter
        - rate_limited
        - service_unavailable
        - internal_error
  responses:
    ErrorInternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          example:
            error: Internal server error
            code: internal_error

````