Add metadata (multiple samples)

Add metadata (multiple samples)

Add specific metadata for multiple samples.

post

/api/{projectId}/raw-data/batch/add-metadata

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

labelsstring

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

Example: ["idle", "snake"]

filenamestring

Only include samples whose filename includes the given filename

maxLengthinteger

Only include samples shorter than the given length, in milliseconds

minLengthinteger

Only include samples longer than the given length, in milliseconds

minFrequencynumber

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

maxFrequencynumber

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

signatureValiditystring · enum

Include samples with either valid or invalid signatures

Options: both, valid, invalid

includeDisabledstring · enum

Include only enabled or disabled samples (or both)

Options: both, enabled, disabled

idsstring

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

Example: [1, 2, 3]

excludeIdsstring

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

Example: [4, 5, 6]

minLabelnumber

Only include samples with a label >= this value

maxLabelnumber

Only include samples with a label < this value

searchstring

Search query

Example: <id> <name>

Body

metadataKeystringrequired

metadataValuestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

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

OK