POST
/
v1
/
retrievers
/
retrievers
/
{retriever_id}
/
execute
curl --request POST \
  --url https://api.mixpeek.com/v1/retrievers/retrievers/{retriever_id}/execute \
  --header 'Content-Type: application/json' \
  --data '{
  "inputs": {},
  "filters": {
    "AND": [
      {
        "field": "name",
        "operator": "eq",
        "value": "John"
      },
      {
        "field": "age",
        "operator": "gte",
        "value": 30
      }
    ],
    "OR": [
      {
        "field": "status",
        "operator": "eq",
        "value": "active"
      },
      {
        "field": "role",
        "operator": "eq",
        "value": "admin"
      }
    ],
    "NOT": [
      {
        "field": "department",
        "operator": "eq",
        "value": "HR"
      },
      {
        "field": "location",
        "operator": "eq",
        "value": "remote"
      }
    ],
    "case_sensitive": true
  },
  "sorts": [
    {
      "field": "created_at",
      "direction": "desc"
    }
  ],
  "limit": 10,
  "offset": 0,
  "select": [
    "<string>"
  ],
  "session_id": "<string>",
  "return_urls": false
}'
{
  "execution_time": 123,
  "stage_results": [
    {
      "results": [
        {}
      ],
      "execution_time": 123,
      "total_results": 123
    }
  ]
}

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.

Path Parameters

​
retriever_id
string
required

Body

application/json

Query parameters for executing a retriever pipeline.

This model defines all the parameters that can be provided when running a search using a predefined retriever pipeline. It allows for customizing the query inputs, filtering, sorting, pagination, and result formatting.

Response

200
application/json
Successful Response

Response from a retriever execution