POST
/
v1
/
features
curl --request POST \
  --url https://api.mixpeek.com/v1/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

​
Authorization
string | null

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'

​
X-Namespace
string | null

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

​
offset_feature_id
string | null

The offset id to start returning results from. Used for pagination

​
page_size
integer
default:
10

Body

application/json
​
collections
string[]
required

Collection identifiers - can be either collection IDs or collection names

​
filters
object | null

Complex nested query filters

​
sort
object | null
    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.
​
select
any[] | null

List of fields to return in results, supports dot notation. Everything else is excluded.

​
return_urls
boolean
default:
false

When true, generates presigned URLs for assets

Response

200
application/json
Successful Response
​
results
object[]
required
​
pagination
object
required

Was this page helpful?

Suggest editsRaise issue
Delete FeatureIngest Text