curl --request POST \
--url https://api.mixpeek.com/v1/quickstart/docs-search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"site_url": "https://docs.example.com",
"site_name": "Example Docs",
"include_patterns": [
"/docs/.*",
"/api/.*"
],
"exclude_patterns": [
"*/changelog/*",
"*/blog/*"
],
"namespace_id": "<string>",
"options": {
"enable_image_search": false,
"enable_code_search": true,
"max_pages": 200,
"max_depth": 3,
"chunk_strategy": "paragraphs",
"chunk_size": 500,
"render_strategy": "auto"
}
}
'import requests
url = "https://api.mixpeek.com/v1/quickstart/docs-search"
payload = {
"site_url": "https://docs.example.com",
"site_name": "Example Docs",
"include_patterns": ["/docs/.*", "/api/.*"],
"exclude_patterns": ["*/changelog/*", "*/blog/*"],
"namespace_id": "<string>",
"options": {
"enable_image_search": False,
"enable_code_search": True,
"max_pages": 200,
"max_depth": 3,
"chunk_strategy": "paragraphs",
"chunk_size": 500,
"render_strategy": "auto"
}
}
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({
site_url: 'https://docs.example.com',
site_name: 'Example Docs',
include_patterns: ['/docs/.*', '/api/.*'],
exclude_patterns: ['*/changelog/*', '*/blog/*'],
namespace_id: '<string>',
options: {
enable_image_search: false,
enable_code_search: true,
max_pages: 200,
max_depth: 3,
chunk_strategy: 'paragraphs',
chunk_size: 500,
render_strategy: 'auto'
}
})
};
fetch('https://api.mixpeek.com/v1/quickstart/docs-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/quickstart/docs-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([
'site_url' => 'https://docs.example.com',
'site_name' => 'Example Docs',
'include_patterns' => [
'/docs/.*',
'/api/.*'
],
'exclude_patterns' => [
'*/changelog/*',
'*/blog/*'
],
'namespace_id' => '<string>',
'options' => [
'enable_image_search' => false,
'enable_code_search' => true,
'max_pages' => 200,
'max_depth' => 3,
'chunk_strategy' => 'paragraphs',
'chunk_size' => 500,
'render_strategy' => 'auto'
]
]),
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/quickstart/docs-search"
payload := strings.NewReader("{\n \"site_url\": \"https://docs.example.com\",\n \"site_name\": \"Example Docs\",\n \"include_patterns\": [\n \"/docs/.*\",\n \"/api/.*\"\n ],\n \"exclude_patterns\": [\n \"*/changelog/*\",\n \"*/blog/*\"\n ],\n \"namespace_id\": \"<string>\",\n \"options\": {\n \"enable_image_search\": false,\n \"enable_code_search\": true,\n \"max_pages\": 200,\n \"max_depth\": 3,\n \"chunk_strategy\": \"paragraphs\",\n \"chunk_size\": 500,\n \"render_strategy\": \"auto\"\n }\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/quickstart/docs-search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"site_url\": \"https://docs.example.com\",\n \"site_name\": \"Example Docs\",\n \"include_patterns\": [\n \"/docs/.*\",\n \"/api/.*\"\n ],\n \"exclude_patterns\": [\n \"*/changelog/*\",\n \"*/blog/*\"\n ],\n \"namespace_id\": \"<string>\",\n \"options\": {\n \"enable_image_search\": false,\n \"enable_code_search\": true,\n \"max_pages\": 200,\n \"max_depth\": 3,\n \"chunk_strategy\": \"paragraphs\",\n \"chunk_size\": 500,\n \"render_strategy\": \"auto\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/quickstart/docs-search")
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 \"site_url\": \"https://docs.example.com\",\n \"site_name\": \"Example Docs\",\n \"include_patterns\": [\n \"/docs/.*\",\n \"/api/.*\"\n ],\n \"exclude_patterns\": [\n \"*/changelog/*\",\n \"*/blog/*\"\n ],\n \"namespace_id\": \"<string>\",\n \"options\": {\n \"enable_image_search\": false,\n \"enable_code_search\": true,\n \"max_pages\": 200,\n \"max_depth\": 3,\n \"chunk_strategy\": \"paragraphs\",\n \"chunk_size\": 500,\n \"render_strategy\": \"auto\"\n }\n}"
response = http.request(request)
puts response.read_body{
"project_key": "<string>",
"public_name": "<string>",
"retriever_id": "<string>",
"collection_id": "<string>",
"namespace_id": "<string>",
"bucket_id": "<string>",
"embed_snippet": "<string>",
"react_snippet": "<string>",
"batch_id": "<string>"
}{
"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
}{
"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
}Provision Docs Search
One-call provisioning of a complete documentation search pipeline. Creates a namespace, bucket, web crawl collection, retriever with semantic + code search, publishes it, and generates a scoped API key. Returns everything needed to embed the search widget.
curl --request POST \
--url https://api.mixpeek.com/v1/quickstart/docs-search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"site_url": "https://docs.example.com",
"site_name": "Example Docs",
"include_patterns": [
"/docs/.*",
"/api/.*"
],
"exclude_patterns": [
"*/changelog/*",
"*/blog/*"
],
"namespace_id": "<string>",
"options": {
"enable_image_search": false,
"enable_code_search": true,
"max_pages": 200,
"max_depth": 3,
"chunk_strategy": "paragraphs",
"chunk_size": 500,
"render_strategy": "auto"
}
}
'import requests
url = "https://api.mixpeek.com/v1/quickstart/docs-search"
payload = {
"site_url": "https://docs.example.com",
"site_name": "Example Docs",
"include_patterns": ["/docs/.*", "/api/.*"],
"exclude_patterns": ["*/changelog/*", "*/blog/*"],
"namespace_id": "<string>",
"options": {
"enable_image_search": False,
"enable_code_search": True,
"max_pages": 200,
"max_depth": 3,
"chunk_strategy": "paragraphs",
"chunk_size": 500,
"render_strategy": "auto"
}
}
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({
site_url: 'https://docs.example.com',
site_name: 'Example Docs',
include_patterns: ['/docs/.*', '/api/.*'],
exclude_patterns: ['*/changelog/*', '*/blog/*'],
namespace_id: '<string>',
options: {
enable_image_search: false,
enable_code_search: true,
max_pages: 200,
max_depth: 3,
chunk_strategy: 'paragraphs',
chunk_size: 500,
render_strategy: 'auto'
}
})
};
fetch('https://api.mixpeek.com/v1/quickstart/docs-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/quickstart/docs-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([
'site_url' => 'https://docs.example.com',
'site_name' => 'Example Docs',
'include_patterns' => [
'/docs/.*',
'/api/.*'
],
'exclude_patterns' => [
'*/changelog/*',
'*/blog/*'
],
'namespace_id' => '<string>',
'options' => [
'enable_image_search' => false,
'enable_code_search' => true,
'max_pages' => 200,
'max_depth' => 3,
'chunk_strategy' => 'paragraphs',
'chunk_size' => 500,
'render_strategy' => 'auto'
]
]),
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/quickstart/docs-search"
payload := strings.NewReader("{\n \"site_url\": \"https://docs.example.com\",\n \"site_name\": \"Example Docs\",\n \"include_patterns\": [\n \"/docs/.*\",\n \"/api/.*\"\n ],\n \"exclude_patterns\": [\n \"*/changelog/*\",\n \"*/blog/*\"\n ],\n \"namespace_id\": \"<string>\",\n \"options\": {\n \"enable_image_search\": false,\n \"enable_code_search\": true,\n \"max_pages\": 200,\n \"max_depth\": 3,\n \"chunk_strategy\": \"paragraphs\",\n \"chunk_size\": 500,\n \"render_strategy\": \"auto\"\n }\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/quickstart/docs-search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"site_url\": \"https://docs.example.com\",\n \"site_name\": \"Example Docs\",\n \"include_patterns\": [\n \"/docs/.*\",\n \"/api/.*\"\n ],\n \"exclude_patterns\": [\n \"*/changelog/*\",\n \"*/blog/*\"\n ],\n \"namespace_id\": \"<string>\",\n \"options\": {\n \"enable_image_search\": false,\n \"enable_code_search\": true,\n \"max_pages\": 200,\n \"max_depth\": 3,\n \"chunk_strategy\": \"paragraphs\",\n \"chunk_size\": 500,\n \"render_strategy\": \"auto\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/quickstart/docs-search")
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 \"site_url\": \"https://docs.example.com\",\n \"site_name\": \"Example Docs\",\n \"include_patterns\": [\n \"/docs/.*\",\n \"/api/.*\"\n ],\n \"exclude_patterns\": [\n \"*/changelog/*\",\n \"*/blog/*\"\n ],\n \"namespace_id\": \"<string>\",\n \"options\": {\n \"enable_image_search\": false,\n \"enable_code_search\": true,\n \"max_pages\": 200,\n \"max_depth\": 3,\n \"chunk_strategy\": \"paragraphs\",\n \"chunk_size\": 500,\n \"render_strategy\": \"auto\"\n }\n}"
response = http.request(request)
puts response.read_body{
"project_key": "<string>",
"public_name": "<string>",
"retriever_id": "<string>",
"collection_id": "<string>",
"namespace_id": "<string>",
"bucket_id": "<string>",
"embed_snippet": "<string>",
"react_snippet": "<string>",
"batch_id": "<string>"
}{
"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
}{
"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
}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, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.
Body
Keys this body does not declare are refused with 422 extra_forbidden naming the accepted keys (since 2026-11-02).
Request to provision a docs search pipeline.
Response
Successful Response
Response after provisioning a docs search pipeline.
Was this page helpful?

