curl --request POST \
--url https://api.mixpeek.com/v1/retrievers/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"search": "<string>",
"filters": {},
"sorts": [
{}
],
"sort": {
"field": "created_at",
"direction": "desc"
},
"case_sensitive": false
}
'import requests
url = "https://api.mixpeek.com/v1/retrievers/list"
payload = {
"search": "<string>",
"filters": {},
"sorts": [{}],
"sort": {
"field": "created_at",
"direction": "desc"
},
"case_sensitive": 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({
search: '<string>',
filters: {},
sorts: [{}],
sort: {field: 'created_at', direction: 'desc'},
case_sensitive: false
})
};
fetch('https://api.mixpeek.com/v1/retrievers/list', 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/list",
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([
'search' => '<string>',
'filters' => [
],
'sorts' => [
[
]
],
'sort' => [
'field' => 'created_at',
'direction' => 'desc'
],
'case_sensitive' => 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/list"
payload := strings.NewReader("{\n \"search\": \"<string>\",\n \"filters\": {},\n \"sorts\": [\n {}\n ],\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"case_sensitive\": 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/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"search\": \"<string>\",\n \"filters\": {},\n \"sorts\": [\n {}\n ],\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"case_sensitive\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/retrievers/list")
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 \"search\": \"<string>\",\n \"filters\": {},\n \"sorts\": [\n {}\n ],\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"case_sensitive\": false\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"retriever_name": "<string>",
"stages": [
{
"stage_name": "<string>",
"config": {},
"batch_size": "<string>",
"description": "<string>",
"on_error": "<string>",
"output_alias": "<string>"
}
],
"fusion": "<string>",
"collection_identifiers": [
"<string>"
],
"retriever_id": "<string>",
"description": "<string>",
"collection_ids": [
"<string>"
],
"input_schema": {},
"budget_limits": {
"max_credits": 1,
"max_time_ms": 1
},
"feature_dependencies": [
{
"extractor": "<string>",
"version": "<string>",
"scheme": "mixpeek",
"output": "<string>"
}
],
"tags": [
"<string>"
],
"metadata": {},
"display_config": {},
"version": 1,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"updated_by": "<string>",
"is_published": false,
"marketplace_listing_id": "<string>"
}
],
"total": 0,
"pagination": {
"total": 123,
"page": 123,
"page_size": 123,
"total_pages": 123,
"next_page": "<string>",
"previous_page": "<string>",
"next_cursor": "<string>"
}
}{
"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>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}List Retrievers
List all retrievers in the namespace.
curl --request POST \
--url https://api.mixpeek.com/v1/retrievers/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"search": "<string>",
"filters": {},
"sorts": [
{}
],
"sort": {
"field": "created_at",
"direction": "desc"
},
"case_sensitive": false
}
'import requests
url = "https://api.mixpeek.com/v1/retrievers/list"
payload = {
"search": "<string>",
"filters": {},
"sorts": [{}],
"sort": {
"field": "created_at",
"direction": "desc"
},
"case_sensitive": 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({
search: '<string>',
filters: {},
sorts: [{}],
sort: {field: 'created_at', direction: 'desc'},
case_sensitive: false
})
};
fetch('https://api.mixpeek.com/v1/retrievers/list', 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/list",
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([
'search' => '<string>',
'filters' => [
],
'sorts' => [
[
]
],
'sort' => [
'field' => 'created_at',
'direction' => 'desc'
],
'case_sensitive' => 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/list"
payload := strings.NewReader("{\n \"search\": \"<string>\",\n \"filters\": {},\n \"sorts\": [\n {}\n ],\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"case_sensitive\": 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/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"search\": \"<string>\",\n \"filters\": {},\n \"sorts\": [\n {}\n ],\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"case_sensitive\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/retrievers/list")
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 \"search\": \"<string>\",\n \"filters\": {},\n \"sorts\": [\n {}\n ],\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"case_sensitive\": false\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"retriever_name": "<string>",
"stages": [
{
"stage_name": "<string>",
"config": {},
"batch_size": "<string>",
"description": "<string>",
"on_error": "<string>",
"output_alias": "<string>"
}
],
"fusion": "<string>",
"collection_identifiers": [
"<string>"
],
"retriever_id": "<string>",
"description": "<string>",
"collection_ids": [
"<string>"
],
"input_schema": {},
"budget_limits": {
"max_credits": 1,
"max_time_ms": 1
},
"feature_dependencies": [
{
"extractor": "<string>",
"version": "<string>",
"scheme": "mixpeek",
"output": "<string>"
}
],
"tags": [
"<string>"
],
"metadata": {},
"display_config": {},
"version": 1,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"updated_by": "<string>",
"is_published": false,
"marketplace_listing_id": "<string>"
}
],
"total": 0,
"pagination": {
"total": 123,
"page": 123,
"page_size": 123,
"total_pages": 123,
"next_page": "<string>",
"previous_page": "<string>",
"next_cursor": "<string>"
}
}{
"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>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
1 <= x <= 10001 <= x <= 10000 <= x <= 10000x >= 1Body
Request to list retrievers.
Search term for wildcard search across retriever_id, retriever_name, description, and other text fields
Filters applied directly to the query — any stored field works, e.g. {"collection_ids": {"$in": ["col_x"]}} to filter by collection, or {"retriever_name": "..."}.
Sort options for the retriever list
Single sort option (alias for the first entry of sorts). Every other list resource accepts this shape, so callers reach for it here too; without it, a sort on retrievers was silently dropped and DESC returned ASC order (BACKE-2792 class).
Show child attributes
Show child attributes
If True, filters and search will be case-sensitive
Response
Successful Response
Was this page helpful?

