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

list

Retrieve a list of datapoints Retrieve datapoints, optionally filtered by a list of datapoint IDs or dataset name.

Usage

honeyhive datapoints list [options]

Options

FlagTypeRequiredDescription
--datapoint-idsjsonnoList of datapoint ids to fetch
--dataset-namestringnoName of the dataset to get datapoints from
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

create

Create a new datapoint Create a single datapoint with inputs, history, ground truth, and metadata.

Usage

honeyhive datapoints create [options]

Options

FlagTypeRequiredDescription
--ground-truthjsonnoground_truth
--historyjsonnohistory
--inputsjsonnoinputs
--linked-datasetsjsonnolinked_datasets
--linked-eventstringnolinked_event
--metadatajsonnometadata
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

create-batch

Create multiple datapoints in batch Create multiple datapoints from events using field mappings and optional filters.

Usage

honeyhive datapoints create-batch [options]

Options

FlagTypeRequiredDescription
--check-statejsonnocheckState
--dataset-idstringnodataset_id
--date-rangejsonnodateRange
--eventsjsonnoevents
--filtersjsonnofilters
--mappingjsonnomapping
--select-all / --no-select-allbooleannoselectAll
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

get

Retrieve a specific datapoint Get a single datapoint by its unique identifier.

Usage

honeyhive datapoints get [options]

Options

FlagTypeRequiredDescription
--datapoint-idstringyesDatapoint ID like 65c13dbbd65fb876b7886cdb
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

update

Update a specific datapoint Update fields on an existing datapoint. Only the provided fields are modified.

Usage

honeyhive datapoints update [options]

Options

FlagTypeRequiredDescription
--datapoint-idstringyesID of datapoint to update
--ground-truthjsonnoground_truth
--historyjsonnohistory
--inputsjsonnoinputs
--linked-datasetsjsonnolinked_datasets
--linked-eventstringnolinked_event
--metadatajsonnometadata
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

delete

Delete a specific datapoint Permanently delete a datapoint by its unique identifier.

Usage

honeyhive datapoints delete [options]

Options

FlagTypeRequiredDescription
--datapoint-idstringyesDatapoint ID like 65c13dbbd65fb876b7886cdb
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.