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

# Liveness probe (no auth)



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/health
openapi: 3.1.0
info:
  title: Sydium Public API
  version: 1.0.0
servers:
  - url: https://api.sydium.com
security:
  - ApiKey: []
paths:
  /v1/health:
    get:
      summary: Liveness probe (no auth)
      operationId: health
      responses:
        '200':
          description: Service health
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
        '429':
          description: Rate limited (edge applies a per-IP ceiling to all paths)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security: []
components:
  schemas:
    HealthResponse:
      type: object
      required:
        - success
        - data
        - meta
      properties:
        success:
          const: true
        data:
          type: object
          required:
            - status
            - version
          properties:
            status:
              type: string
            version:
              type: string
        meta:
          type: object
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          const: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - unauthorized
                - forbidden
                - insufficient_permissions
                - not_found
                - unprocessable
                - rate_limited
                - invalid_state
                - external_service_error
                - internal_error
            message:
              type: string
        meta:
          type: object
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: Opaque API key (sk_live_... / sk_test_...)

````