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

> ## Agent Instructions
> Describe what the running code does. Do not invent hosted pricing, launch dates, or security guarantees. Share and viewer links are a configured base URL plus an artifact path. Show localhost and a placeholder origin such as https://library.example.com.

# Check that the API is initialized

> Returns `{ status: "ok" }` after the process has started. No credentials.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/health
openapi: 3.1.0
info:
  title: Factrove HTTP API
  version: 0.1.0
  description: >-
    Generated from `@factrove/contracts` schemas and the HTTP operation catalog.
    Product routes live under `/api/v1`. Auth and API key management live under
    `/api/auth`. Do not treat this file as hand-written. Run `pnpm docs:openapi`
    after contract or route-catalog changes.
servers:
  - url: http://localhost:3001
    description: Local development API origin
  - url: https://api.example.com
    description: Example self-hosted API origin
security: []
tags:
  - name: Health
    description: Process liveness.
  - name: Auth
    description: Sessions and API keys.
  - name: Artifacts
    description: Upload, list, rename, delete, detail, and content.
  - name: Shares
    description: Owner public-link and password controls.
  - name: Public
    description: Anonymous share detail, unlock, and HTML.
paths:
  /api/v1/health:
    get:
      tags:
        - Health
      summary: Check that the API is initialized
      description: >-
        Returns `{ status: "ok" }` after the process has started. No
        credentials.
      operationId: getHealth
      responses:
        '200':
          description: The API is initialized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthEnvelope'
              example:
                status: ok
      security: []
components:
  schemas:
    HealthEnvelope:
      type: object
      properties:
        status:
          type: string
          const: ok
      required:
        - status
      additionalProperties: false

````

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