GET /v1/vendor-catalog/{cid}

Read the shared vendor catalog (get). Requires a signed-in connection. Pages contain at most 100 rows and 1 MiB. Oversized expanded reads can be read as individual documents through /raw. Shares a per-principal budget of 120 reads per minute with MCP.

All operations · Reusable schemas

Complete operation contract

{
  "operationId": "vendor_catalog.get",
  "description": "Read the shared vendor catalog (get). Requires a signed-in connection. Pages contain at most 100 rows and 1 MiB. Oversized expanded reads can be read as individual documents through /raw. Shares a per-principal budget of 120 reads per minute with MCP.",
  "parameters": [
    {
      "name": "cid",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "description": "CIDv1 raw blake3 over exact stored bytes"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Catalog read",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/CatalogDocument"
          }
        }
      }
    },
    "400": {
      "description": "Invalid input or cursor",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "401": {
      "description": "Sign-in required",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "404": {
      "description": "Unknown vendor, plan or document",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "429": {
      "description": "Catalog read budget exhausted; Retry-After: 60",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "503": {
      "description": "Catalog unavailable; Retry-After applies",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}