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 Retrieve an organization’s display name and email domains. The organization is identified by the org_id path parameter alone; the x-hh-org-id header does not participate. Your organization’s id is listed on the API keys page of your organization settings in the HoneyHive app.

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

Update an organization Update an organization’s display name. The organization is identified by the org_id path parameter alone; the x-hh-org-id header does not participate. The organization’s email domains cannot be changed through the API. Set them in the organization settings of the HoneyHive app.

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.