Quickstart

Provision Docs Search

Changed on

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.

post/v1/quickstart/docs-search

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/quickstart/docs-search
  • Auth: HTTP bearer

Request body

site_urlstring required

Root URL of the documentation site to crawl.

site_namestring required

Human-readable name for the docs site.

include_patternsstring[]

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

exclude_patternsstring[]

URL patterns to exclude (regex).

namespace_idstring nullable

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

Example request

{
  "site_url": "https://docs.example.com",
  "site_name": "Example Docs",
  "include_patterns": [
    "/docs/.*",
    "/api/.*"
  ],
  "exclude_patterns": [
    "*/changelog/*",
    "*/blog/*"
  ]
}

Response

Successful Response

project_keystring required

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

public_namestring required

Public retriever name for API access.

retriever_idstring required

ID of the created retriever.

collection_idstring required

ID of the web crawl collection.

batch_idstring nullable

ID of the crawl batch (if processing started).

namespace_idstring required

Namespace ID for all resources.

bucket_idstring required

Bucket ID where seed URLs are stored.

embed_snippetstring required

HTML snippet for drop-in integration.

react_snippetstring required

React component snippet.

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API