Clear metadata by key (multiple samples)

Clear metadata by key (multiple samples)

post

Clears a specific metadata field (by key) for multiple samples.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

Query parameters

categorystring · enumrequired

Which of the three acquisition categories to retrieve data from

Options: training, testing, anomaly

labelsstringoptional

Only include samples with a label within the given list of labels, given as a JSON string

Example: ["idle", "snake"]

filenamestringoptional

Only include samples whose filename includes the given filename

maxLengthintegeroptional

Only include samples shorter than the given length, in milliseconds

minLengthintegeroptional

Only include samples longer than the given length, in milliseconds

minFrequencynumberoptional

Only include samples with higher frequency than given frequency, in hertz

maxFrequencynumberoptional

Only include samples with lower frequency than given frequency, in hertz

signatureValiditystring · enumoptional

Include samples with either valid or invalid signatures

Options: both, valid, invalid

includeDisabledstring · enumoptional

Include only enabled or disabled samples (or both)

Options: both, enabled, disabled

idsstringoptional

Only include samples with an ID within the given list of IDs, given as a JSON string

Example: [1, 2, 3]

excludeIdsstringoptional

Exclude samples with an ID within the given list of IDs, given as a JSON string

Example: [4, 5, 6]

minLabelnumberoptional

Only include samples with a label >= this value

maxLabelnumberoptional

Only include samples with a label < this value

searchstringoptional

Search query

Example: <id> <name>

Body

metadataKeystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/clear-metadata-by-key?category=training' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "metadataKey": "text"
  }'

200

200

{
  "success": true,
  "error": "text"
}

OK