curl --request POST \
--url https://api.mixpeek.com/v1/features/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"query": {
"input_mode": "text",
"text": "<string>",
"url": "<string>",
"image": "<string>",
"vector": [
123
]
},
"collection_identifiers": [
"<string>"
],
"feature_uri": "mixpeek://text_extractor@v1/embedding",
"top_k": 25,
"filters": {}
}
'import requests
url = "https://api.mixpeek.com/v1/features/search"
payload = {
"query": {
"input_mode": "text",
"text": "<string>",
"url": "<string>",
"image": "<string>",
"vector": [123]
},
"collection_identifiers": ["<string>"],
"feature_uri": "mixpeek://text_extractor@v1/embedding",
"top_k": 25,
"filters": {}
}
headers = {
"Authorization": "Bearer <token>",
"X-Namespace": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Namespace': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
query: {
input_mode: 'text',
text: '<string>',
url: '<string>',
image: '<string>',
vector: [123]
},
collection_identifiers: ['<string>'],
feature_uri: 'mixpeek://text_extractor@v1/embedding',
top_k: 25,
filters: {}
})
};
fetch('https://api.mixpeek.com/v1/features/search', 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/features/search",
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([
'query' => [
'input_mode' => 'text',
'text' => '<string>',
'url' => '<string>',
'image' => '<string>',
'vector' => [
123
]
],
'collection_identifiers' => [
'<string>'
],
'feature_uri' => 'mixpeek://text_extractor@v1/embedding',
'top_k' => 25,
'filters' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Namespace: <api-key>"
],
]);
$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/features/search"
payload := strings.NewReader("{\n \"query\": {\n \"input_mode\": \"text\",\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"image\": \"<string>\",\n \"vector\": [\n 123\n ]\n },\n \"collection_identifiers\": [\n \"<string>\"\n ],\n \"feature_uri\": \"mixpeek://text_extractor@v1/embedding\",\n \"top_k\": 25,\n \"filters\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Namespace", "<api-key>")
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/features/search")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": {\n \"input_mode\": \"text\",\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"image\": \"<string>\",\n \"vector\": [\n 123\n ]\n },\n \"collection_identifiers\": [\n \"<string>\"\n ],\n \"feature_uri\": \"mixpeek://text_extractor@v1/embedding\",\n \"top_k\": 25,\n \"filters\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/features/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": {\n \"input_mode\": \"text\",\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"image\": \"<string>\",\n \"vector\": [\n 123\n ]\n },\n \"collection_identifiers\": [\n \"<string>\"\n ],\n \"feature_uri\": \"mixpeek://text_extractor@v1/embedding\",\n \"top_k\": 25,\n \"filters\": {}\n}"
response = http.request(request)
puts response.read_body{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}Feature Search
Search documents by vector similarity across collections. A convenience wrapper that builds an ad-hoc retriever with a single feature_search stage.
curl --request POST \
--url https://api.mixpeek.com/v1/features/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"query": {
"input_mode": "text",
"text": "<string>",
"url": "<string>",
"image": "<string>",
"vector": [
123
]
},
"collection_identifiers": [
"<string>"
],
"feature_uri": "mixpeek://text_extractor@v1/embedding",
"top_k": 25,
"filters": {}
}
'import requests
url = "https://api.mixpeek.com/v1/features/search"
payload = {
"query": {
"input_mode": "text",
"text": "<string>",
"url": "<string>",
"image": "<string>",
"vector": [123]
},
"collection_identifiers": ["<string>"],
"feature_uri": "mixpeek://text_extractor@v1/embedding",
"top_k": 25,
"filters": {}
}
headers = {
"Authorization": "Bearer <token>",
"X-Namespace": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Namespace': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
query: {
input_mode: 'text',
text: '<string>',
url: '<string>',
image: '<string>',
vector: [123]
},
collection_identifiers: ['<string>'],
feature_uri: 'mixpeek://text_extractor@v1/embedding',
top_k: 25,
filters: {}
})
};
fetch('https://api.mixpeek.com/v1/features/search', 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/features/search",
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([
'query' => [
'input_mode' => 'text',
'text' => '<string>',
'url' => '<string>',
'image' => '<string>',
'vector' => [
123
]
],
'collection_identifiers' => [
'<string>'
],
'feature_uri' => 'mixpeek://text_extractor@v1/embedding',
'top_k' => 25,
'filters' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Namespace: <api-key>"
],
]);
$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/features/search"
payload := strings.NewReader("{\n \"query\": {\n \"input_mode\": \"text\",\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"image\": \"<string>\",\n \"vector\": [\n 123\n ]\n },\n \"collection_identifiers\": [\n \"<string>\"\n ],\n \"feature_uri\": \"mixpeek://text_extractor@v1/embedding\",\n \"top_k\": 25,\n \"filters\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Namespace", "<api-key>")
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/features/search")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": {\n \"input_mode\": \"text\",\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"image\": \"<string>\",\n \"vector\": [\n 123\n ]\n },\n \"collection_identifiers\": [\n \"<string>\"\n ],\n \"feature_uri\": \"mixpeek://text_extractor@v1/embedding\",\n \"top_k\": 25,\n \"filters\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/features/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": {\n \"input_mode\": \"text\",\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"image\": \"<string>\",\n \"vector\": [\n 123\n ]\n },\n \"collection_identifiers\": [\n \"<string>\"\n ],\n \"feature_uri\": \"mixpeek://text_extractor@v1/embedding\",\n \"top_k\": 25,\n \"filters\": {}\n}"
response = http.request(request)
puts response.read_body{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}Authorizations
Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.
Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.
Body
Search query.
Show child attributes
Show child attributes
Collection IDs or names to search. OPTIONAL: omit (or pass []) on standalone/BYOV namespaces to search the namespace's direct-upsert documents without naming a collection.
Feature URI to search against.
Number of results to return.
1 <= x <= 1000Pre-filters to apply before search.
Response
Successful Response
Was this page helpful?

