Create a episode exclusion request
POST
/v1/dataset-versions/{versionId}/episode-exclusion-requestscurl -X POST 'https://api.embodiflow.io/v1/dataset-versions/{versionId}/episode-exclusion-requests' \
-H 'Authorization: Bearer $EMBODIFLOW_PAT' \
-H 'Content-Type: application/json' \
-d '{
"action": "exclude",
"datasetVersionItemIds": [
"00000000-0000-0000-0000-000000000000"
],
"sampleKeys": [
"string"
],
"episodeIndexes": [
0
],
"checkId": "string",
"note": "string"
}'Authorization
Send a personal access token with every request.
- Authorization: Bearer PAT
Path parameters
- versionIdstringrequired
Header parameters
- idempotency-keystringrequired
- Idempotency-Keystring
Optional idempotency key, at most 255 characters (UUIDv4 recommended). A repeated key returns the first response byte-for-byte, including a 5xx. The same key with a different body, or a second in-flight request, returns 409 IDEMPOTENCY_CONFLICT. Keys are unique per tenant and retained for 24 hours.
Request body
Content-Typeapplication/json
- actionstringrequiredAllowed valuesexcluderestore
- datasetVersionItemIdsarray<string (uuid)>
dataset_version_item ids (one selector required; validated in the service).
- sampleKeysarray<string>
Alternative selector: version-unique sampleKeys.
- episodeIndexesarray<number>
Alternative selector: episode indexes within the version.
- checkIdstring
Exclusion attributed to a catalog checkId (validated in the service).
- notestring
Optional free-form note recorded in the audit entry.
Responses
Success
- dataobjectrequired
- datasetVersionIdstringrequired
- actionstringrequiredAllowed valuesexcluderestore
- requestedCountnumberrequired
- changedCountnumberrequired
- reasonstringrequired
- itemsarray<EpisodeExclusionResultItemDto>required
- idempotentReuseone of
Response example
{
"data": {
"datasetVersionId": "string",
"action": "exclude",
"requestedCount": 0,
"changedCount": 0,
"reason": "string",
"items": [
{
"datasetVersionItemId": "string",
"sampleKey": "string",
"episodeIndex": 0,
"excludedFromTraining": false,
"excludedReason": "string",
"changed": false
}
],
"idempotentReuse": false
}
}Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1