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

​
list

Get datasets Retrieve datasets, optionally filtered by dataset ID or name.

​
Usage

honeyhive datasets list [options]

​
Options

FlagTypeRequiredDescription
--dataset-idstringnoUnique dataset ID for filtering specific dataset
--namestringnoDataset name to filter by
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

​
create

Create a dataset Create a new dataset with an optional name, description, and initial set of datapoint IDs.

​
Usage

honeyhive datasets create [options]

​
Options

FlagTypeRequiredDescription
--datapointsjsonnoInitial datapoint IDs to include
--descriptionstringnoDescription of the dataset
--namestringnoName of the dataset
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

​
update

Update a dataset Update a dataset’s name, description, or list of datapoint IDs.

​
Usage

honeyhive datasets update [options]

​
Options

FlagTypeRequiredDescription
--dataset-idstringyesThe unique identifier of the dataset to update like 663876ec4611c47f4970f0c3
--datapointsjsonnoUpdated list of datapoint IDs
--descriptionstringnoNew dataset description
--namestringnoNew dataset name
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

​
delete

Delete a dataset Permanently delete a dataset by its unique identifier.

​
Usage

honeyhive datasets delete [options]

​
Options

FlagTypeRequiredDescription
--dataset-idstringyesThe unique identifier of the dataset to be deleted like 663876ec4611c47f4970f0c3
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

​
add-datapoints

Add datapoints to a dataset Add new datapoints to an existing dataset. Provide raw data objects and a field mapping that specifies which fields map to inputs, ground truth, and history.

​
Usage

honeyhive datasets add-datapoints [options]

​
Options

FlagTypeRequiredDescription
--datajsonyesArray of datapoint data objects to add
--dataset-idstringyesThe unique identifier of the dataset to add datapoints to like 663876ec4611c47f4970f0c3
--mappingjsonyesmapping
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

​
remove-datapoint

Remove a datapoint from a dataset Remove a specific datapoint from a dataset. The datapoint itself is not deleted, only dereferenced from the dataset.

​
Usage

honeyhive datasets remove-datapoint [options]

​
Options

FlagTypeRequiredDescription
--datapoint-idstringyesThe unique identifier of the datapoint to remove
--dataset-idstringyesThe unique identifier of the dataset
Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.