Lit Protocol Configuration API

openapi: 3.2.0
info:
  title: lit-api-server Configuration API
  description: Lit Express Node API Server
  version: 0.1.0
servers:
- url: /core/v1/
  description: Lit Protocol Express API (Core v1)
tags:
- name: Configuration
paths:
  /get_lit_action_client_config:
    get:
      tags:
      - Configuration
      operationId: get_lit_action_client_config
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/LitActionClientConfigResponse'
                - $ref: '#/components/schemas/ErrMessage'
      summary: Get lit action client config
      x-summary-source: derived
  /cache_metadata:
    get:
      tags:
      - Configuration
      description: 'CPL-351: metadata about the action code cached for the caller''s account. Returns TTL/size/last-run metadata only — never the cached code itself.'
      operationId: get_cache_metadata
      parameters:
      - name: X-Api-Key
        in: header
        description: 'Account or usage API key. Alternatively use Authorization: Bearer <key>.'
        required: true
        schema:
          type: string
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/CacheMetadataResponse'
                - $ref: '#/components/schemas/ErrMessage'
      summary: Get cache metadata
      x-summary-source: derived
  /get_supported_languages:
    get:
      tags:
      - Configuration
      description: 'Advertises the node''s language capability surface: which languages, runtimes, and execution methods this node admits. No guards — like `get_lit_action_client_config`, it exists so clients can discover capability before uploading anything.'
      operationId: get_supported_languages
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/SupportedLanguagesResponse'
                - $ref: '#/components/schemas/ErrMessage'
      summary: Get supported languages
      x-summary-source: derived
  /get_api_payers:
    get:
      tags:
      - Configuration
      operationId: get_api_payers
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                - type: array
                  items:
                    type: string
                - $ref: '#/components/schemas/ErrMessage'
      summary: Get api payers
      x-summary-source: derived
  /get_admin_api_payer:
    get:
      tags:
      - Configuration
      operationId: get_admin_api_payer
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                - type: string
                - $ref: '#/components/schemas/ErrMessage'
      summary: Get admin api payer
      x-summary-source: derived
  /version:
    get:
      tags:
      - Configuration
      operationId: get_version
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/VersionResponse'
                - $ref: '#/components/schemas/ErrMessage'
      summary: Get version
      x-summary-source: derived
  /get_system_stats:
    get:
      tags:
      - Configuration
      operationId: get_system_stats
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/SystemStatsResponse'
                - $ref: '#/components/schemas/ErrMessage'
      summary: Get system stats
      x-summary-source: derived
components:
  schemas:
    CacheMetadataResponse:
      description: GET /cache_metadata — metadata for the cached action code correlated to the authenticated master account. Excludes the cached binaries themselves.
      type: object
      required:
      - account_address
      - entries
      - entry_count
      - total_size_bytes
      properties:
        account_address:
          description: On-chain account wallet address the caller's key resolves to.
          type: string
        entry_count:
          description: Number of cached entries correlated to this account.
          type: integer
          format: uint64
          minimum: 0.0
        total_size_bytes:
          description: Sum of `size_bytes` across the returned entries.
          type: integer
          format: uint64
          minimum: 0.0
        entries:
          description: The cached entries, sorted by most recent execution first.
          type: array
          items:
            $ref: '#/components/schemas/CacheEntryMetadataItem'
    CacheStats:
      description: Entry statistics for one in-process cache.
      type: object
      required:
      - description
      - entry_count
      - name
      properties:
        name:
          type: string
        description:
          type: string
        entry_count:
          type: integer
          format: uint64
          minimum: 0.0
        approx_bytes:
          description: Approximate bytes held, for caches built with a byte weigher. `None` when the cache only counts entries.
          type:
          - integer
          - 'null'
          format: uint64
          minimum: 0.0
    CacheEntryMetadataItem:
      description: 'One cached action-code entry in a `GET /cache_metadata` response (CPL-351).


        Describes the cached data only — never the code/binary itself.'
      type: object
      required:
      - created_at_ms
      - ipfs_id
      - last_run_at_ms
      - run_count
      - size_bytes
      properties:
        ipfs_id:
          description: IPFS id (cache key) of the cached action code.
          type: string
        size_bytes:
          description: Size of the cached code in bytes.
          type: integer
          format: uint64
          minimum: 0.0
        created_at_ms:
          description: Unix-epoch milliseconds when the entry was first cached.
          type: integer
          format: uint64
          minimum: 0.0
        last_run_at_ms:
          description: Unix-epoch milliseconds of the most recent execution.
          type: integer
          format: uint64
          minimum: 0.0
        run_count:
          description: Number of executions recorded against this entry.
          type: integer
          format: uint64
          minimum: 0.0
        ttl_seconds:
          description: Time-to-live of the entry, in seconds. `None` for the API-server IPFS cache, which is capacity-bounded (LRU) rather than time-expired.
          type:
          - integer
          - 'null'
          format: uint64
          minimum: 0.0
    ExecutionModel:
      type: string
      enum:
      - deno
    LitActionClientConfigResponse:
      description: GET /get_lit_action_client_config — effective ClientBuilder configuration values, including any chain-config overrides applied at startup.
      type: object
      required:
      - async_timeout_ms
      - client_timeout_ms_buffer
      - max_code_length
      - max_console_log_length
      - max_fetch_count
      - max_get_keys_count
      - max_response_length
      - max_retries
      - memory_limit_mb
      - timeout_ms
      properties:
        timeout_ms:
          type: integer
          format: uint64
          minimum: 0.0
        async_timeout_ms:
          type: integer
          format: uint64
          minimum: 0.0
        memory_limit_mb:
          type: integer
          format: uint32
          minimum: 0.0
        max_code_length:
          type: integer
          format: uint64
          minimum: 0.0
        max_response_length:
          type: integer
          format: uint64
          minimum: 0.0
        max_console_log_length:
          type: integer
          format: uint64
          minimum: 0.0
        max_fetch_count:
          type: integer
          format: uint32
          minimum: 0.0
        max_get_keys_count:
          type: integer
          format: uint32
          minimum: 0.0
        max_retries:
          type: integer
          format: uint32
          minimum: 0.0
        client_timeout_ms_buffer:
          type: integer
          format: uint64
          minimum: 0.0
    ErrMessage:
      type: string
    SupportedLanguagesResponse:
      description: Returned by `/get_supported_languages` — the node's language capability surface (see `actions::languages`).
      type: object
      required:
      - languages
      properties:
        languages:
          type: array
          items:
            $ref: '#/components/schemas/LanguageFeature'
    LanguageFeature:
      description: One supported language, as advertised by `GET /get_supported_languages`.
      type: object
      required:
      - display_name
      - execution_model
      - methods
      - name
      - runtimes
      properties:
        name:
          description: Stable id used in requests, e.g. "python", "rust", "javascript".
          type: string
        display_name:
          description: Human label, e.g. "Python".
          type: string
        execution_model:
          description: 'Underlying runner: "deno" (JS).'
          allOf:
          - $ref: '#/components/schemas/ExecutionModel'
        runtimes:
          description: Provisionable runtime versions — each maps to an install recipe and a cache profile (NOT baked into the image). Multiple may coexist (e.g. 3.12 and 3.13). Empty for compiled/static languages.
          type: array
          items:
            $ref: '#/components/schemas/LanguageRuntime'
        methods:
          description: Which methods this language accepts on this node.
          type: array
          items:
            $ref: '#/components/schemas/ExecutionMethod'
    ExecutionMethod:
      oneOf:
      - description: Pick language + runtime, send code; server desugars into a bundle.
        type: string
        enum:
        - raw_script
      - description: Code-only tar over the minimal base rootfs; runtime provisioned by the startup script's cached install commands (or a static binary).
        type: string
        enum:
        - bundle
      - description: Self-contained OCI image bringing its own runtime/interpreter. Node-gated; may be curated in prod.
        type: string
        enum:
        - oci_bundle
    VersionResponse:
      type: object
      required:
      - commit_version
      - name
      - submodule_versions
      - version
      properties:
        name:
          type: string
        version:
          type: string
        commit_version:
          type: string
        submodule_versions:
          type: array
          items:
            type: array
            items:
            - type: string
            - type: string
            maxItems: 2
            minItems: 2
    SystemStatsResponse:
      description: Returned by `/get_system_stats` — CVM memory usage and in-process cache statistics powering the monitor dapp's system dashboard.
      type: object
      required:
      - caches
      - memory
      - runners
      properties:
        memory:
          $ref: '#/components/schemas/MemoryStats'
        caches:
          type: array
          items:
            $ref: '#/components/schemas/CacheStats'
        runners:
          type: array
          items:
            $ref: '#/components/schemas/RunnerInfo'
    MemoryStats:
      description: CVM-level memory figures from `/proc/meminfo` plus this process's resident set from `/proc/self/status`. Fields are `None` on platforms without procfs (e.g. local macOS development).
      type: object
      properties:
        total_kb:
          type:
          - integer
          - 'null'
          format: uint64
          minimum: 0.0
        available_kb:
          type:
          - integer
          - 'null'
          format: uint64
          minimum: 0.0
        used_kb:
          type:
          - integer
          - 'null'
          format: uint64
          minimum: 0.0
        process_rss_kb:
          type:
          - integer
          - 'null'
          format: uint64
          minimum: 0.0
    RunnerInfo:
      description: Presence of a Lit Action runner's Unix socket. `socket_present` means the runner container has been deployed and created its socket — it is not a liveness probe (`/health` covers reachability).
      type: object
      required:
      - name
      - socket_path
      - socket_present
      properties:
        name:
          type: string
        socket_path:
          type: string
        socket_present:
          type: boolean
    LanguageRuntime:
      type: object
      required:
      - id
      - is_default
      - prewarmed
      - version
      properties:
        id:
          description: Value clients pass as `runtime` and the manifest's `runtime` field, e.g. "python3.13". Selects an install recipe + cache profile.
          type: string
        version:
          description: Full version string, e.g. "3.13.1".
          type: string
        is_default:
          description: Chosen when the client omits `runtime`.
          type: boolean
        prewarmed:
          description: True once this profile's install layers are materialized in the runner's cache. Always false today.
          type: boolean
x-provenance:
  method: harvested
  publisher: Lit Protocol
  source: https://api.chipotle.litprotocol.com/core/v1/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)