Skip to main content
POST
Provision Docs Search

Authorizations

Authorization
string
header
required

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

application/json

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.

site_url
string
required

Root URL of the documentation site to crawl.

Minimum string length: 1
Examples:

"https://docs.example.com"

"https://example.com/docs"

site_name
string
required

Human-readable name for the docs site.

Required string length: 1 - 100
Examples:

"Example Docs"

"Acme API Reference"

include_patterns
string[]

URL patterns to include (regex). Empty means include all.

Example:
exclude_patterns
string[]

URL patterns to exclude (regex).

Example:
namespace_id
string | null

Existing namespace ID. If not provided, one will be created.

options
DocsSearchOptions · object

Optional configuration overrides.

Response

Successful Response

Response after provisioning a docs search pipeline.

project_key
string
required

Retriever-scoped API key (ret_sk_...) for widget authentication.

public_name
string
required

Public retriever name for API access.

retriever_id
string
required

ID of the created retriever.

collection_id
string
required

ID of the web crawl collection.

namespace_id
string
required

Namespace ID for all resources.

bucket_id
string
required

Bucket ID where seed URLs are stored.

embed_snippet
string
required

HTML snippet for drop-in integration.

react_snippet
string
required

React component snippet.

batch_id
string | null

ID of the crawl batch (if processing started).