---
title: "Clean Preview"
method: POST
path: "/datasets/{dataset_id}/versions/{version}/clean/preview"
tags: ["datasets"]
---

# Clean Preview

`POST /datasets/{dataset_id}/versions/{version}/clean/preview`

## Request

- Base URL: `https://api.os3robotics.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.os3robotics.com/datasets/{dataset_id}/versions/{version}/clean/preview`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

What `body` (os3.cleaning_recipe.v1; no body: the workspace's default rules for the
version's kind, which the answer then gives with their defaults version) would make of
sealed `version`: its rows (episodes or examples) and frames or estimated tokens before and
after, each operation's drops and the first drops with why. Creates nothing.

## Path parameters

- `dataset_id` string, uuid, required
- `version` integer, required

## Request body

- Recipe: os3.cleaning_recipe.v1: the operations, in the order they apply.
  - `operations` union[], required
    - union
      - Length
        - `op` 'length', required
        - `min` integer, nullable
        - `max` integer, nullable
      - Dedupe
        - `op` 'dedupe', required
        - `key` 'example' | 'prompt'
      - DropWhere
        - `op` 'drop_where', required
        - `field` 'task' | 'operator' | 'site' | 'robot' | 'success' | 'prompt' | 'target', required
        - `values` string[], required
        - `match` 'equals' | 'contains'
      - DropRows
        - `op` 'drop', required
        - `rows` integer[], required
        - `reason` string, required
      - Curation
        - `op` 'curation', required
      - Format
        - `op` 'format', required

## Response `200`

Successful Response

- object

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/os3robotics/apis/os3-api.md) - [All operations](https://skmtc.dev/os3robotics/apis/os3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/os3robotics/apis/os3-api/revisions/af32cd4f14bb?raw)