---
title: "Every module of every kind with its platform switch, instances, usage and health"
method: GET
path: "/api/admin/catalog"
tags: ["catalog"]
---

# Every module of every kind with its platform switch, instances, usage and health

`GET /api/admin/catalog`

## Request

- Base URL: `https://api.wizbi.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.wizbi.ai/api/admin/catalog`
- Auth: none declared

## Query parameters

- `kind` 'connector' | 'channel' | 'agent' | 'capability' | 'auth-provider' | 'tenant-integration' | 'model-provider'

## Response `200`

The catalog.

- object
  - `env` string, required
  - `modules` object[], required
    - `ref` string, required
    - `manifest` object, required
      - `manifestVersion` 2, required
      - `kind` 'connector' | 'channel' | 'agent' | 'capability' | 'auth-provider' | 'tenant-integration' | 'model-provider', required
      - `id` string, required
      - `version` string, required
      - `status` 'ga' | 'beta' | 'experimental' | 'deprecated', required
      - `name` object, required
        - `he` string, required
        - `en` string, required
        - `pt` string, required
      - `summary` object, required
        - `he` string, required
        - `en` string, required
        - `pt` string, required
      - `category` string, required
      - `icon` string, required
      - `owner` 'core' | 'core-agent' | 'core-channels' | 'core-data' | 'core-files' | 'core-identity' | 'core-notify' | 'core-platform', required
      - `costUnit` 'none' | 'call' | 'token' | 'message' | 'query' | 'byte_scanned' | 'second' | 'character' | 'file', required
      - `lifecycle` object, required
        - `stage` 'active' | 'deprecated' | 'sunset', required
        - `deprecatedAt` string
        - `sunsetAt` string
        - `replacedBy` string
        - `notice` object
          - `he` string, required
          - `en` string, required
          - `pt` string, required
      - `minCoreVersion` string, required
      - `breakingChanges` object[]
        - `version` string, required
        - `upgradeDeadline` string, required
        - `message` object, required
          - `he` string, required
          - `en` string, required
          - `pt` string, required
        - `migrationDocs` string
      - `docs` string, required
      - `configSchema` object
      - `secrets` object[]
        - `name` string, required
        - `required` boolean
        - `description` string
        - `scope` 'instance' | 'platform'
        - `rotationDays` integer
        - `lastRotated` string
      - `capabilities` string[]
      - `dependsOn` string[]
      - `health` object
        - `probe` 'test' | 'http' | 'self' | 'none'
        - `intervalMin` integer
      - `slo` object
        - `errorRate` number, required
        - `p95Ms` integer, required
        - `availability` number, required
      - `alerts` object
        - `channel` 'alerts' | 'errors' | 'security' | 'dev'
      - `metrics` string[]
      - `toolProviders` string[]
      - `tools` string[]
      - `defaults` object, required
        - `platformEnabled` boolean, required
        - `orgEnabled` boolean, required
      - `envs` object, required
        - `local` 'on' | 'off' | 'flag', required
        - `qa` 'on' | 'off' | 'flag', required
        - `prod` 'on' | 'off' | 'flag', required
      - `flag` string
      - `conformance` object
        - `gaps` object
    - `manifestComplete` boolean, required
    - `platform` object, required
      - `enabled` boolean, required
      - `source` 'state' | 'default', required
      - `version` integer, required
      - `reason` string
      - `updatedBy` string
      - `updatedAt` string, date-time
    - `effective` object, required
      - `ref` string, required
      - `kind` 'connector' | 'channel' | 'agent' | 'capability' | 'auth-provider' | 'tenant-integration' | 'model-provider', required
      - `id` string, required
      - `enabled` boolean, required
      - `offReason` 'unknown_module' | 'env_off' | 'flag_off' | 'platform_off' | 'org_off' | 'dependency_off' | 'instance_off' | 'sunset' | 'upgrade_required' | 'not_entitled' | 'audience_off' | 'null', nullable, required
      - `blockedBy` string
      - `env` 'on' | 'off' | 'flag', required
      - `platform` object, required
        - `enabled` boolean, required
        - `source` 'state' | 'default', required
        - `version` integer, required
      - `org` object
        - `enabled` boolean, required
        - `source` 'state' | 'default', required
        - `version` integer, required
        - `orgId` string, required
      - `instance` object
        - `id` string, required
        - `enabled` boolean, required
        - `version` string
        - `upgradeBy` string
      - `lifecycle` object
        - `stage` 'active' | 'deprecated' | 'sunset', required
        - `sunsetAt` string
        - `replacedBy` string
      - `entitlement` object
        - `entitled` boolean, required
        - `source` 'unrestricted' | 'unmanaged' | 'plan' | 'profile' | 'grant' | 'none', required
        - `plan` 'solo' | 'team' | 'company' | 'enterprise' | 'null', nullable, required
        - `minPlan` 'solo' | 'team' | 'company' | 'enterprise'
      - `audienceBlock` 'room' | 'group'
      - `toolsOff` string[]
    - `orgsDisabled` integer
    - `instances` object, required
      - `total` integer, required
      - `enabled` integer, required
      - `orgs` integer
    - `usage7d` object, nullable, required
      - `calls` integer, required
      - `errors` integer, required
      - `p50Ms` number
      - `lastCallAt` string, date-time
      - `days` object[]
        - `day` string, required
        - `calls` integer, required
        - `errors` integer, required
      - `costUsd` number
    - `health` object, nullable, required
      - `status` 'ok' | 'degraded' | 'failing' | 'unknown', required
      - `checkedAt` string, date-time
      - `errorCode` string
      - `instances` integer
      - `failing` integer
  - `incomplete` string[]

## Other responses

- `400`: Invalid request.
- `403`: Not allowed, or the feature is off for the organization.
- `404`: Unknown agent or version.
- `409`: Stale version.

---

[API](https://skmtc.dev/wizbi/apis/wizbi-core-api.md) · [All operations](https://skmtc.dev/wizbi/apis/wizbi-core-api/llms.txt) · [OpenAPI document](https://skmtc.dev/wizbi/apis/wizbi-core-api/revisions/5a47416c82ec?raw)