Skip to main content
POST
/
v1
/
retrievers
/
{retriever_id}
/
execute
/
batch
Batch Execute Retriever
curl --request POST \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "queries": [
    {
      "inputs": {},
      "filters": {}
    }
  ],
  "settings": {},
  "concurrency": 5,
  "return_presigned_urls": false,
  "return_vectors": false,
  "stream": false
}
'
import requests

url = "https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch"

payload = {
"queries": [
{
"inputs": {},
"filters": {}
}
],
"settings": {},
"concurrency": 5,
"return_presigned_urls": False,
"return_vectors": False,
"stream": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
queries: [{inputs: {}, filters: {}}],
settings: {},
concurrency: 5,
return_presigned_urls: false,
return_vectors: false,
stream: false
})
};

fetch('https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'queries' => [
[
'inputs' => [

],
'filters' => [

]
]
],
'settings' => [

],
'concurrency' => 5,
'return_presigned_urls' => false,
'return_vectors' => false,
'stream' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch"

payload := strings.NewReader("{\n \"queries\": [\n {\n \"inputs\": {},\n \"filters\": {}\n }\n ],\n \"settings\": {},\n \"concurrency\": 5,\n \"return_presigned_urls\": false,\n \"return_vectors\": false,\n \"stream\": false\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"queries\": [\n {\n \"inputs\": {},\n \"filters\": {}\n }\n ],\n \"settings\": {},\n \"concurrency\": 5,\n \"return_presigned_urls\": false,\n \"return_vectors\": false,\n \"stream\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"queries\": [\n {\n \"inputs\": {},\n \"filters\": {}\n }\n ],\n \"settings\": {},\n \"concurrency\": 5,\n \"return_presigned_urls\": false,\n \"return_vectors\": false,\n \"stream\": false\n}"

response = http.request(request)
puts response.read_body
{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}
{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

retriever_id
string
required

Retriever ID or name.

Query Parameters

return_presigned_urls
boolean
default:false

Generate presigned URLs for S3-backed blobs and url-shaped fields. Also accepted as a body field — if either source is true, presigning is enabled.

return_vectors
boolean
default:false

Include vector embeddings in result documents. Also accepted as a body field — if either source is true, vectors are returned.

Body

application/json

Batch of queries to execute.

queries
BatchQueryItem · object[]
required

List of queries to execute (1-50). Each gets the same retriever pipeline.

Required array length: 1 - 50 elements
settings
Settings · object | null

Shared settings applied to every query. Supports 'limit' (max results per query, default 10) and 'max_chunks' (for content-mode preprocessing).

concurrency
integer
default:5

Max concurrent executions (1-20). Higher = faster but more resource usage.

Required range: 1 <= x <= 20
return_presigned_urls
boolean
default:false

Generate presigned URLs for S3-backed blobs and url-shaped fields. Also accepted as a query param — if either source is true, presigning is enabled.

return_vectors
boolean
default:false

Include vector embeddings in result documents. Also accepted as a query param — if either source is true, vectors are returned.

stream
boolean
default:false

Stream results via Server-Sent Events. Each query result is emitted as it completes, with keepalive pings every 15s to prevent proxy timeouts.

Response

Successful Response