Health
Namespaces
Assets
Collections
Feature Extractors
List Features
Retrieves a list of features based on the provided filters and sorting criteria. If you provide a sort, then pagination isn’t supported.
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'
Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.
The offset id to start returning results from. Used for pagination
Collection identifiers - can be either collection IDs or collection names
Complex nested query filters
Whether to perform case-sensitive matching
Logical AND operation
Logical OR operation
Logical NOR operation
List of fields to sort by, with direction (asc or desc).
NOTE: fields will require a specialty index to use this, consult with the team.
Field to sort by, supports dot notation for nested fields
Sort direction
List of fields to return in results, supports dot notation. Everything else is excluded.
When true, generates presigned URLs for assets
curl --request POST \
--url https://api.mixpeek.com/features \
--header 'Content-Type: application/json' \
--data '{
"collections": [
"collection_123",
"my_collection_name"
],
"filters": {
"case_sensitive": true,
"AND": [
{
"key": "name",
"operator": "eq",
"value": "John"
},
{
"key": "age",
"operator": "gte",
"value": 30
}
],
"OR": [
{
"key": "status",
"operator": "eq",
"value": "active"
},
{
"key": "role",
"operator": "eq",
"value": "admin"
}
],
"NOR": [
{
"key": "department",
"operator": "eq",
"value": "HR"
},
{
"key": "location",
"operator": "eq",
"value": "remote"
}
]
},
"sort": {
"field": "score",
"direction": "desc"
},
"select": [
"metadata.tags"
],
"return_urls": false
}'
{
"results": [
{
"url": "<string>",
"preview_url": "<string>",
"duplicate_of": "<string>"
}
],
"pagination": {
"total": 123,
"page_size": 123,
"total_pages": 123,
"current_page": 123,
"next_page": "<string>",
"previous_page": "<string>"
}
}
Headers
Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'
Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.
Query Parameters
The offset id to start returning results from. Used for pagination
Body
Collection identifiers - can be either collection IDs or collection names
Complex nested query filters
Whether to perform case-sensitive matching
Logical AND operation
Whether to perform case-sensitive matching
Logical AND operation
Whether to perform case-sensitive matching
Logical AND operation
Logical NOR operation
Logical OR operation
Whether to perform case-sensitive matching
Logical AND operation
Logical NOR operation
Logical NOR operation
Whether to perform case-sensitive matching
Logical AND operation
Logical NOR operation
Logical OR operation
Whether to perform case-sensitive matching
Logical AND operation
Whether to perform case-sensitive matching
Logical AND operation
Logical NOR operation
Logical OR operation
Whether to perform case-sensitive matching
Logical NOR operation
Whether to perform case-sensitive matching
Logical AND operation
Logical NOR operation
Logical NOR operation
Whether to perform case-sensitive matching
Logical AND operation
Whether to perform case-sensitive matching
Logical AND operation
Logical NOR operation
Logical OR operation
Whether to perform case-sensitive matching
Logical AND operation
Logical NOR operation
Logical NOR operation
Whether to perform case-sensitive matching
Logical AND operation
Logical NOR operation
List of fields to return in results, supports dot notation. Everything else is excluded.
When true, generates presigned URLs for assets
Response
Was this page helpful?
curl --request POST \
--url https://api.mixpeek.com/features \
--header 'Content-Type: application/json' \
--data '{
"collections": [
"collection_123",
"my_collection_name"
],
"filters": {
"case_sensitive": true,
"AND": [
{
"key": "name",
"operator": "eq",
"value": "John"
},
{
"key": "age",
"operator": "gte",
"value": 30
}
],
"OR": [
{
"key": "status",
"operator": "eq",
"value": "active"
},
{
"key": "role",
"operator": "eq",
"value": "admin"
}
],
"NOR": [
{
"key": "department",
"operator": "eq",
"value": "HR"
},
{
"key": "location",
"operator": "eq",
"value": "remote"
}
]
},
"sort": {
"field": "score",
"direction": "desc"
},
"select": [
"metadata.tags"
],
"return_urls": false
}'
{
"results": [
{
"url": "<string>",
"preview_url": "<string>",
"duplicate_of": "<string>"
}
],
"pagination": {
"total": 123,
"page_size": 123,
"total_pages": 123,
"current_page": 123,
"next_page": "<string>",
"previous_page": "<string>"
}
}