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

# Authenticated OpenAPI document

> Authenticated OpenAPI document



## OpenAPI

````yaml /openapi.json get /openapi.json
openapi: 3.1.1
info:
  title: Vitalog
  version: 1.0.1
  description: >-
    Single-user structured observations with equivalent REST and MCP domain
    services. Environment AUTH_KEY or revocable personal Bearer keys with
    required name, permissions and explicit expiry (including Never); Primary
    key management requires AUTH_KEY; the UI uses separate, root-verified
    30-minute management sessions. MCP clients use OAuth authorization code with
    S256 PKCE, issued after root sign-in. Clients are resolved through HTTPS
    metadata, pre-registration or dynamic registration. OAuth tokens grant MCP
    access only.
servers:
  - url: https://vitalog-api.example.com
    description: Production REST and MCP API
  - url: http://localhost:3000
    description: Loopback development; production requires TLS ingress
security: []
paths:
  /openapi.json:
    get:
      tags:
        - Service
      summary: Authenticated OpenAPI document
      description: Authenticated OpenAPI document
      operationId: get__openapi_json
      responses:
        '200':
          description: OpenAPI 3.1.1
      security:
        - staticKey: []
        - apiKey: []
components:
  securitySchemes:
    staticKey:
      type: http
      scheme: bearer
      description: >-
        Environment AUTH_KEY. Full ledger access and primary API-key
        administration. Not OAuth or JWT.
    apiKey:
      type: http
      scheme: bearer
      description: >-
        Generated opaque vlk_ key with a required name, explicit read/edit
        permissions, optional administrative inspection and chosen expiry
        (including Never). Enforces the same ceiling on REST and MCP; cannot
        administer credentials or account settings. Not OAuth or JWT.

````

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