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. project-id, not --project-id).
Both write pure JSON to stdout and never call the API. They cannot be combined with any other command-specific flag.

list

List evaluators List active evaluators using their latest definitions. Archived evaluators are excluded. Requires project.evaluator.list.

Usage

Accepted keys: Data plane fine-grained API key

Options

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

create

Create an evaluator Create a project-scoped evaluator and immutable version 1. Slugs are unique within a project and cannot subsequently be changed. Requires project.evaluator.post; publish=true additionally requires project.evaluator.publish.

Usage

Accepted keys: Data plane fine-grained API key

Options

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

get

Get the latest evaluator version Return the latest definition with current lifecycle state, including archived evaluators. Requires project.evaluator.get.

Usage

Accepted keys: Data plane fine-grained API key

Options

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

replace

Replace an evaluator definition Replace the complete definition of an active evaluator. A changed definition creates the next server-assigned version; an identical definition retains its version and message. Requires project.evaluator.update; publish=true additionally requires project.evaluator.publish. Archived evaluators return 409.

Usage

Accepted keys: Data plane fine-grained API key

Options

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

archive

Archive an evaluator Archive and unpublish the evaluator, preserving its slug and immutable history. Repeated archival succeeds without changing its timestamps. Requires project.evaluator.delete.

Usage

Accepted keys: Data plane fine-grained API key

Options

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

list-versions

List evaluator versions List immutable definitions in descending version order, including archived evaluators. Each item includes current evaluator lifecycle state. Requires project.evaluator.list.

Usage

Accepted keys: Data plane fine-grained API key

Options

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

get-version

Get a specific evaluator version Return the requested immutable definition with current evaluator lifecycle state. The selected version may differ from latest_version and published_version. Requires project.evaluator.get.

Usage

Accepted keys: Data plane fine-grained API key

Options

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

publish

Publish an evaluator version Select an existing version for automatic evaluation. Repeated publication of the same version is a no-op. Archived evaluators return 409. Requires project.evaluator.publish.

Usage

Accepted keys: Data plane fine-grained API key

Options

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

unpublish

Unpublish an evaluator Clear the publication pointer without changing definitions or history. Already-unpublished and archived evaluators succeed. Requires project.evaluator.publish.

Usage

Accepted keys: Data plane fine-grained API key

Options

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