POST
/
api
/
{projectId}
/
raw-data
/
batch
/
edit-bounding-boxes
Edit bounding boxes for multiple samples
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/raw-data/batch/edit-bounding-boxes \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "oldLabels": [
    "<string>"
  ],
  "newLabel": "<string>"
}'
{
  "success": true,
  "error": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

projectId
integer
required

Project ID

Query Parameters

category
enum<string>
required

Which of the three acquisition categories to retrieve data from

Available options:
training,
testing,
post-processing
labels
string

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

Example:

"[\"idle\", \"snake\"]"

filename
string

Only include samples whose filename includes the given filename

maxLength
integer

Only include samples shorter than the given length, in milliseconds

minLength
integer

Only include samples longer than the given length, in milliseconds

minFrequency
number

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

maxFrequency
number

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

signatureValidity
enum<string>

Include samples with either valid or invalid signatures

Available options:
both,
valid,
invalid
includeDisabled
enum<string>

Include only enabled or disabled samples (or both)

Available options:
both,
enabled,
disabled
ids
string

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

Example:

"[1, 2, 3]"

excludeIds
string

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

Example:

"[4, 5, 6]"

minLabel
number

Only include samples with a label >= this value

maxLabel
number

Only include samples with a label < this value

Search query

Example:

"<id> <name>"

dataType
enum<string>

Include only samples with a particular data type

Available options:
audio,
image
minId
number

Include only samples with an ID >= this value

maxId
number

Include only samples with an ID < this value

metadata
string

Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties: - "key": Metadata key to filter on. - "op": Operator ("eq" for positive match, "neq" for negative match). - "values": (optional) Array of values to match/exclude. If omitted or empty, matches/excludes all values for the key. In addition to filter objects, the following option objects can be specified: - { "no_metadata": boolean } - If true, include samples without any metadata - { "filters_combinator": ("and" | "or") } - Specifies the combinator and matching mode: - "and": All filter items must match (logical AND). - "or": Any filter item may match (logical OR); samples with metadata keys not present in the filters are included.

Example:

"Example 1: returns samples where metadata key \"foo\" is 'bar' or 'baz' AND\nmetadata key \"k\" is \"v\".\n[\n { \"no_metadata\": true },\n { \"filters_combinator\": \"and\" },\n { \"key\": \"foo\", \"op\": \"eq\", \"values\": [\"bar\", \"baz\"] },\n { \"key\": \"k\", \"op\": \"eq\", \"values\": [\"v\"] }\n]\n\nExample 2: returns samples where metadata key \"foo\" is not 'bar'. Samples\nwithout any metadata are filtered out.\n[\n { \"no_metadata\": false },\n { \"filters_combinator\": \"or\" },\n { \"key\": \"foo\", \"op\": \"neq\", \"values\": [\"bar\"] }\n]\n"

minDate
string<date-time>

Only include samples that where added after the date given

Example:

"2023-01-01T00:00:00.000Z"

maxDate
string<date-time>

Only include samples that were added before the date given

Example:

"2024-12-31T00:00:00.000Z"

Body

application/json

Response

200 - application/json

OK

The response is of type object.