Marqo Telemetry API

openapi: 3.1.0
info:
  title: Marqo REST Documents Telemetry API
  version: '2.26'
  summary: Open-source multimodal vector search engine REST API.
  description: 'Marqo is an open-source vector search engine that bundles index storage

    (Vespa) and embedding inference (Sentence Transformers, OpenCLIP, ONNX)

    behind a single FastAPI HTTP surface. The engine is reachable at

    `http://{host}:8882` by default and publishes its live OpenAPI schema at

    `/openapi.json` with interactive Swagger UI at `/docs`. The same surface

    is exposed by the hosted Marqo Cloud product at `https://api.marqo.ai`

    with bearer-token authentication.


    This profile is a hand-curated, best-effort companion spec covering the

    most-used operations across indexes, documents, search, embeddings,

    models, and telemetry. For the canonical, version-pinned specification

    of a deployment, fetch `/openapi.json` directly from the running engine.

    '
  contact:
    name: Marqo
    url: https://www.marqo.ai
  license:
    name: Apache 2.0
    url: https://github.com/marqo-ai/marqo/blob/mainline/LICENSE
servers:
- url: http://localhost:8882
  description: Default Marqo open-source engine endpoint
- url: https://api.marqo.ai
  description: Marqo Cloud endpoint (bearer authentication)
security: []
tags:
- name: Telemetry
  description: Health, readiness, and engine-level metadata.
paths:
  /:
    get:
      tags:
      - Telemetry
      summary: Root Health Check
      operationId: root
      responses:
        '200':
          description: Engine is up.
  /health:
    get:
      tags:
      - Telemetry
      summary: Health Check
      operationId: health
      responses:
        '200':
          description: Engine and backing Vespa are healthy.
  /memory:
    get:
      tags:
      - Telemetry
      summary: Memory Usage
      operationId: memory
      responses:
        '200':
          description: Process memory snapshot.
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Marqo Cloud API key passed as `Authorization: Bearer {api_key}`.

        The open-source engine accepts unauthenticated requests by default.

        '