Get Dataset Image Keys

GET

/v1/datasets/{dataset_id}/image-keys

curl --request GET \
  --url https://example.com/v1/datasets/example/image-keys

Get available image keys from a HuggingFace dataset.

Returns the image keys that can be used as values in camera_mappings when creating a finetune job. The dataset_id should be a valid HuggingFace dataset identifier (e.g., ‘lerobot/pusht’).

Parameters

Path Parameters

dataset_id

required

Dataset Id

string

Header Parameters

x-api-key

Any of:

string

string

null

null

Responses

200

Image keys retrieved successfully

Media type application/json

DatasetImageKeysResponse

Response containing dataset image keys for camera mapping.

object

dataset_id

required

Dataset Id

HuggingFace dataset ID

string

image_keys

required

Image Keys

Available image keys in the dataset (use these as values in camera_mappings)

Array<string>

Example ^generated

{
  "dataset_id": "example",
  "image_keys": [
    "example"
  ]
}

400

Dataset has no valid image keys

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Detail

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

401

Invalid or missing API key

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Detail

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

404

Dataset not found

Media type application/json

ErrorResponse

Standard error response.

object

detail

required

Detail

Error message describing what went wrong

string

Example ^generated

{
  "detail": "example"
}

422

Validation error