Skip to main content

Catalog

Browse packs, cluster profiles, PaletteAI profiles, and Palette installers available in the catalog, and search across them. Authentication is optional: anonymous requests see public and gated items. Downloading any item requires a token, and gated items also require your organization to be entitled to them.

📄️ List NVIDIA AI Essentials resources

Returns NVIDIA AI Essentials resources from NVIDIA NGC, with optional search and resource type filters and fixed-size pages of up to 50 resources. Repeat resource_type or comma-separate its values to match any of them; q and resource_type must both match. metadata describes the whole catalog, while pagination.total counts the resources that match your filters. The catalog is refreshed from NGC periodically (every 5 minutes by default), so new NGC resources can take a few minutes to appear. Authentication is optional.

📄️ Get Palette installer binaries

Returns the installer binaries for a Palette or Vertex version. Choose the product with product (palette when omitted). With product=vm-launchpad-appliance, fips and csi are required and select the exact appliance variant. With product=ai-launchpad-appliance, the response has one entry per GPU vendor; use gpu to return only amd or nvidia. Each component's url, signatureBinUrl, and signatureUrl link to GET /v2/download/installer/{version_id}/{type}[/{slug}] (signature links add ?artifact=signature_bin_url or ?artifact=signature_url). The response includes the installer's visibility (public, gated, or private) and entitledClasses: the artifact classes your organization needs to download a gated or private installer. Authentication is optional. Downloading any item requires a token, and gated items also require your organization to be entitled to them.

📄️ List catalog packs

Returns the pack catalog: one item per pack, with FIPS and non-FIPS builds combined, and each item's versions[] limited to the versions that match every version-level filter. Use this to browse packs; to work with individual builds (for example the FIPS, non-FIPS, and per-architecture builds of one pack), use GET /v2/packs/{name}/versions. fips, palette_version, cloud_type, and arch must all match on the same version. palette_version is an upper bound: a version matches when its Palette version is at or below the target. Targets can be full SemVer or major.minor, with an optional lowercase v; with several targets, the highest one applies. Versions with no Palette version always match, and versions with an invalid Palette version never do. An empty target imposes no limit, and an invalid target returns 400. Encode + in build metadata as %2B. Authentication is optional. Downloading any item requires a token, and gated items also require your organization to be entitled to them.

📄️ Get a pack overview

Retrieve a single pack by name (spec.pack.name) with its pack-level metadata (display name, layer, cloud types, architectures) and the list of all available versions. Pack-level metadata reflects the latest version. Use this, with GET /v2/packs/{name}/versions, when you work with individual builds; to show one pack with its FIPS and non-FIPS builds grouped, use GET /v2/packs/catalog/{catalogid}. Optional filters narrow the versions: repeat a filter or comma-separate its values to match any of them; different filters must all match. Authentication is optional. Downloading any item requires a token, and gated items also require your organization to be entitled to them.

📄️ List versions of a pack

Retrieve all available versions of a single pack by name (spec.pack.name), each with full download coordinates (download_url, sha256, size_bytes), release date, architectures, and cloud types. Versions are returned newest-first and pack-level metadata reflects the latest version. Optional filters narrow the versions: repeat a filter or comma-separate its values to match any of them; different filters must all match. Authentication is optional. Downloading any item requires a token, and gated items also require your organization to be entitled to them.

📄️ Get a pack version by ID

Returns one pack version by pack name and version id (versions[].id from GET /v2/packs/{name}/versions or from the pack catalog), including the download URL, SHA-256 checksum, and size. A pack's catalog id does not identify a version. Optional filters narrow the versions: repeat a filter or comma-separate its values to match any of them; different filters must all match. Authentication is optional. Downloading any item requires a token, and gated items also require your organization to be entitled to them.

📄️ List PaletteAI profiles

Returns PaletteAI profiles grouped one item per profile (variants and versions combined, with list-level fields only), with server-side filtering and cursor pagination. Use this to browse PaletteAI profiles only; use GET /v2/profiles/catalog to browse PaletteAI and Profiles Hub profiles together. Use GET /v2/profiles/ai/{id} for full details. Authentication is optional. Downloading any item requires a token, and gated items also require your organization to be entitled to them.

📄️ Get a PaletteAI profile

Returns one PaletteAI profile, with all of its variants and versions, by the id from GET /v2/profiles/ai/catalog. Includes tags and resource requirements from the first visible profile in the default variant, plus visibility and entitledClasses on the profile and on each versions[] entry (empty lists are returned as []). Each version's artifact.url links to GET /v2/download/profile/ai/{version_id}/{type}[/{slug}]. Authentication is optional. Downloading any item requires a token, and gated items also require your organization to be entitled to them.

📄️ List Cluster Profiles

Returns the Cluster Profiles catalog: public PaletteAI and Profiles Hub profiles in one cursor-paginated list. Use this to browse both sources together; to browse one source with its source-specific filters and fields, use GET /v2/profiles/ai/catalog or GET /v2/profiles/hub/catalog. Each item includes source, sourceId, a composite id (palette-ai:{sourceId} or profiles-hub:{sourceId}), visibility, and entitledClasses. Profiles Hub items include versions[], with their packs grouped by component and download_url / signature_bin_url links to the GET /v2/download/profile/hub endpoints. PaletteAI items include a short variants[] list, tags from all published versions, and resource requirements from the latest version of the primary variant. Use GET /v2/profiles/catalog/{catalogid} for full details. Repeat a filter or comma-separate its values to match any of them; different filters must all match. Authentication is optional. Downloading any item requires a token, and gated items also require your organization to be entitled to them.

📄️ List Cluster Profiles filter values

Returns the values available for each Cluster Profiles catalog filter (source, type, kind, tags, use case, cloud type, Palette version), plus the total number of profiles in the catalog. Use it to populate filter choices for GET /v2/profiles/catalog. Empty Palette versions are omitted, and palette_versions is sorted newest first. Note that palette_versions is snake_case here (like use_cases and cloud_types), while catalog items use paletteVersions. Authentication is optional.

📄️ Get a Cluster Profiles entry

Returns one profile from the Cluster Profiles catalog by composite id (palette-ai:{sourceId} or profiles-hub:{sourceId}), bare sourceId, or name. The response holds the Profiles Hub details under hub or the PaletteAI details under ai: the same payloads as GET /v2/profiles/hub/catalog/{catalogid} and GET /v2/profiles/ai/{id}. The ai payload includes tags and resource requirements from the first visible profile in the default variant. fips and palette_version apply to Profiles Hub profiles. Authentication is optional. Downloading any item requires a token, and gated items also require your organization to be entitled to them.

📄️ List Profiles Hub profiles

Returns the Profiles Hub catalog: one item per profile (solution, curated stack, or reference architecture). Use this to browse Profiles Hub profiles only; use GET /v2/profiles/catalog to browse them together with PaletteAI profiles. Profile-level fields, including visibility and entitledClasses, come from the latest version. versions[] lists every available version with its packs grouped by component, visibility, and entitledClasses. variants[] lists the delivery-mode builds (airgap, FIPS, proxy), or [] when there are none. Repeat a filter or comma-separate its values to match any of them; different filters must all match. Authentication is optional. Downloading any item requires a token, and gated items also require your organization to be entitled to them.

📄️ Get a Profiles Hub profile

Returns one Profiles Hub catalog entry, with all of its versions, by catalog id or profile name. variants[] lists the delivery-mode builds (airgap, FIPS, proxy) with suffix, display_name, description, size_bytes, and download_url when known, or [] when there are none. Each versions[] entry includes its packs grouped by component, and download_url / signature_bin_url links to GET /v2/download/profile/hub/{version_id}/{type}[/{slug}]. Authentication is optional. Downloading any item requires a token, and gated items also require your organization to be entitled to them.

📄️ Get a Profiles Hub profile version

Returns one version of a Profiles Hub catalog entry by catalog id (or profile name) and version (an exact version such as 1.0.0, or a version id). Includes download_url and signature_bin_url (links to GET /v2/download/profile/hub/{version_id}/{type}[/{slug}]), release_date, packs grouped by component, visibility, entitledClasses, related metadata, and the entry's variants (or [] when there are none). Use this for the catalog view of a version; GET /v2/profiles/hub/{id} adds the changelog, compatibility, and version history. Authentication is optional. Downloading any item requires a token, and gated items also require your organization to be entitled to them.

📄️ Get Profiles Hub profile version details

Returns one Profiles Hub profile version by id, including pack dependencies, changelog, compatibility (providers, kubernetesVersions, paletteVersions, deploymentMode), download paths (profile bundle, package, and zstData), version_history for the profile's other versions, and variants: the delivery-mode builds (airgap, FIPS, proxy), or [] when there are none. Pass variant to get the download URLs, size, and description for that build. Use this for a version's full details; GET /v2/profiles/hub/catalog/{catalogid}/{versionid} returns the catalog view of a version. Authentication is optional. Downloading any item requires a token, and gated items also require your organization to be entitled to them.