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

# Service status

> Anonymous liveness signal. Always returns 200; `status` flips to
`degraded` when the cheap data-plane probe fails, so monitors can
distinguish app-up from db-down.




## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/status
openapi: 3.1.0
info:
  title: Kordless API
  version: 1.0.0
  description: |
    The Kordless API creates deterministic quotes against published Book
    Versions and returns immutable Quote Receipts. The same pipeline serves
    headless API-key traffic, Business-member sessions, and anonymous
    end-customer surfaces.

    ## Authentication

    Headless routes require a secret API key as a bearer token:

    ```
    Authorization: Bearer sk_test_...
    ```

    Test keys use the `sk_test_` prefix; Live keys use `sk_live_`. The key
    binds a Workspace, Project, and one Environment — a Test key can never
    address Live data. Member routes under `/v1/businesses/{businessId}`
    authenticate the caller's session and Business membership. The
    `/v1/public_quotes` routes are anonymous by design.

    ## Idempotency

    Quote creation accepts an optional `idempotencyKey` in the request body.
    Retrying with the same key and the same payload replays the original
    Quote; the same key with a different payload returns `409
    idempotency_conflict`. When omitted, the server generates an `auto_<uuid>`
    key.

    ## Envelopes and request IDs

    Success responses are `{ "data": …, "requestId": … }`; failures are
    `{ "error": { "code", "message", "requestId", "details?" } }`. Every
    response also carries an `x-request-id` header, echoed on created Quotes
    as `requestCorrelationId`.
servers:
  - url: https://your-kordless-instance.com
    description: Replace with your Kordless instance base URL
security:
  - BearerAuth: []
tags:
  - name: Quotes
    description: Headless quote creation and retrieval with an API key.
  - name: Public quotes
    description: Anonymous end-customer quotes against the Live-published Book.
  - name: Business portal
    description: Member-session routes used by the hosted Business Portal.
  - name: API keys
    description: >-
      Workspace-session routes for the API-key lifecycle (create, rotate,
      revoke).
  - name: Webhooks
    description: >-
      Workspace-session routes for webhook endpoints, deliveries, test events,
      and replay.
  - name: Request logs
    description: Workspace-session log search and Quote Intent traces.
  - name: Status
    description: Anonymous liveness signal.
paths:
  /v1/status:
    get:
      tags:
        - Status
      summary: Service status
      description: |
        Anonymous liveness signal. Always returns 200; `status` flips to
        `degraded` when the cheap data-plane probe fails, so monitors can
        distinguish app-up from db-down.
      operationId: getStatus
      responses:
        '200':
          description: The current service status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
      security: []
components:
  schemas:
    StatusResponse:
      type: object
      required:
        - status
        - version
        - time
      properties:
        status:
          type: string
          enum:
            - ok
            - degraded
        version:
          type: string
        time:
          type: string
          format: date-time
        checks:
          type: object
          properties:
            database:
              type: string
              enum:
                - ok
                - unreachable
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Secret API key (`sk_test_…` or `sk_live_…`). The key binds a Workspace,
        Project, and Environment.

````