Authorizations
Path Parameters
Project ID
Query Parameters
Maximum number of results
Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
Keras model variant
int8
, float32
, akida
Impulse ID. If this is unset then the default impulse is used.
If true, only a slice of labels will be returned for samples with multiple labels.
Only include samples with a label within the given list of labels, given as a JSON string
"[\"idle\", \"snake\"]"
Only include samples whose filename includes the given filename
Only include samples shorter than the given length, in milliseconds
Only include samples longer than the given length, in milliseconds
Only include samples with higher frequency than given frequency, in hertz
Only include samples with lower frequency than given frequency, in hertz
Include samples with either valid or invalid signatures
both
, valid
, invalid
Only include samples with a label >= this value
Only include samples with a label < this value
Search query
"<id> <name>"
Include only samples with a particular data type
audio
, image
Include only samples with an ID >= this value
Include only samples with an ID < this value
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 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"
Only include samples that where added after the date given
"2023-01-01T00:00:00.000Z"
Only include samples that were added before the date given
"2024-12-31T00:00:00.000Z"
Response
OK
The response is of type object
.