Skip to main content

Schema introspection

Every command below with arguments supports two read-only flags for tooling and AI agents:
  • --show-file-schema: print the JSON Schema for the full request object (the format --filename accepts).
  • --show-argument-schema <flag-name>: print the JSON Schema for one argument’s value. Pass the kebab flag name without the leading -- (e.g. org-id, not --org-id).
Both write pure JSON to stdout and never call the API. They cannot be combined with any other command-specific flag.

get

Get an organization’s templates manifest Return the latest version of an organization’s templates manifest: the YAML that defines the metrics and charts that new projects start with, as the templates page of the organization settings in the HoneyHive app shows it. The organization is identified by the org_id path parameter alone. The x-hh-org-id header does not participate. A workspace gets a copy of this manifest when it is created, and its projects use that copy. They use this manifest as well only when the workspace’s manifest sets config.merge_strategy to merge.

Usage

Accepted keys: Control plane fine-grained API key

Options

Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

update

Replace an organization’s templates manifest Save a new version of an organization’s templates manifest, which becomes the latest version. Existing projects are not changed. The organization is identified by the org_id path parameter alone. The x-hh-org-id header does not participate. A workspace gets a copy of this manifest when it is created, and its projects use that copy. They use this manifest as well only when the workspace’s manifest sets config.merge_strategy to merge. A new version therefore reaches projects in workspaces created afterward, and in existing workspaces whose manifest merges. To change what new projects in an existing workspace start with, update that workspace’s manifest. When an API key makes the request and the organization’s latest version already has this content, nothing is saved and that version is returned, so applying the same manifest repeatedly is safe.

Usage

Accepted keys: Control plane fine-grained API key

Options

Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.