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

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

​
Usage

Accepted keys: Data plane fine-grained API key with --project-id; Project API key without --project-id (deprecated)

​
Options

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. The linked_datasets array accepts at most one dataset ID. Requests with more than one entry return 400. A request with a non-empty linked_datasets also requires the project.dataset.post permission.

​
Usage

Accepted keys: Data plane fine-grained API key with --project-id; Project API key without --project-id (deprecated)

​
Options

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. A data plane API key needs both project.datapoint.post and project.event.get for the project, and also project.dataset.post when the body names a dataset_id.

​
Usage

Accepted keys: Data plane fine-grained API key with --project-id; Project API key without --project-id (deprecated)

​
Options

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

Accepted keys: Data plane fine-grained API key with --project-id; Project API key without --project-id (deprecated)

​
Options

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. A request that includes linked_datasets also requires the project.dataset.post and project.dataset.delete permissions.

​
Usage

Accepted keys: Data plane fine-grained API key with --project-id; Project API key without --project-id (deprecated)

​
Options

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, and remove it from every dataset that holds it. Answers 404 when the project holds no such datapoint. Requires only the project.datapoint.delete permission.

​
Usage

Accepted keys: Data plane fine-grained API key with --project-id; Project API key without --project-id (deprecated)

​
Options

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