> ## Documentation Index > Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml post /v1/quickstart/docs-search openapi: 3.1.0 info: title: Mixpeek API description: >- This is the Mixpeek API, providing access to various endpoints for data processing and retrieval. termsOfService: https://mixpeek.com/terms contact: name: Mixpeek Support url: https://mixpeek.com/contact email: info@mixpeek.com version: '0.82' servers: - url: https://api.mixpeek.com description: Production security: - BearerAuth: [] paths: /v1/quickstart/docs-search: post: tags: - Quickstart summary: Provision Docs Search description: >- 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. operationId: provision_docs_search_v1_quickstart_docs_search_post parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DocsSearchRequest' description: >- Keys this body does not declare are refused with 422 extra_forbidden naming the accepted keys (since 2026-11-02). x-unknown-keys: until: '2026-11-02' then: 422 extra_forbidden responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DocsSearchResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: [] components: schemas: DocsSearchRequest: properties: site_url: type: string minLength: 1 title: Site Url description: Root URL of the documentation site to crawl. examples: - https://docs.example.com - https://example.com/docs site_name: type: string maxLength: 100 minLength: 1 title: Site Name description: Human-readable name for the docs site. examples: - Example Docs - Acme API Reference include_patterns: items: type: string type: array title: Include Patterns description: URL patterns to include (regex). Empty means include all. examples: - - /docs/.* - /api/.* exclude_patterns: items: type: string type: array title: Exclude Patterns description: URL patterns to exclude (regex). examples: - - '*/changelog/*' - '*/blog/*' namespace_id: anyOf: - type: string - type: 'null' title: Namespace Id description: Existing namespace ID. If not provided, one will be created. options: $ref: '#/components/schemas/DocsSearchOptions' description: Optional configuration overrides. type: object required: - site_url - site_name title: DocsSearchRequest description: Request to provision a docs search pipeline. DocsSearchResponse: properties: project_key: type: string title: Project Key description: Retriever-scoped API key (ret_sk_...) for widget authentication. public_name: type: string title: Public Name description: Public retriever name for API access. retriever_id: type: string title: Retriever Id description: ID of the created retriever. collection_id: type: string title: Collection Id description: ID of the web crawl collection. batch_id: anyOf: - type: string - type: 'null' title: Batch Id description: ID of the crawl batch (if processing started). namespace_id: type: string title: Namespace Id description: Namespace ID for all resources. bucket_id: type: string title: Bucket Id description: Bucket ID where seed URLs are stored. embed_snippet: type: string title: Embed Snippet description: HTML snippet for drop-in integration. react_snippet: type: string title: React Snippet description: React component snippet. type: object required: - project_key - public_name - retriever_id - collection_id - namespace_id - bucket_id - embed_snippet - react_snippet title: DocsSearchResponse description: Response after provisioning a docs search pipeline. ErrorResponse: properties: success: type: boolean title: Success description: Always false for error responses default: false status: type: integer title: Status description: HTTP status code for this error error: $ref: '#/components/schemas/ErrorDetail' description: Error details payload type: object required: - status - error title: ErrorResponse description: Error response model. examples: - error: details: id: ns_123 resource: namespace message: Namespace not found type: NotFoundError status: 404 success: false DocsSearchOptions: properties: enable_image_search: type: boolean title: Enable Image Search description: Enable SigLIP image embeddings for diagram/screenshot search. default: false enable_code_search: type: boolean title: Enable Code Search description: Enable Jina Code embeddings for code-aware search. default: true max_pages: type: integer maximum: 5000 minimum: 1 title: Max Pages description: Maximum pages to crawl. default: 200 max_depth: type: integer maximum: 10 minimum: 1 title: Max Depth description: Maximum crawl depth from seed URL. default: 3 chunk_strategy: type: string title: Chunk Strategy description: Text chunking strategy. default: paragraphs chunk_size: type: integer maximum: 2000 minimum: 100 title: Chunk Size description: Chunk size in units of chunk_strategy. default: 500 render_strategy: type: string title: Render Strategy description: 'Page rendering strategy: static, javascript, or auto.' default: auto type: object title: DocsSearchOptions description: Optional configuration for docs search setup. ErrorDetail: properties: message: type: string title: Message description: Human-readable error message type: type: string title: Type description: Stable error type identifier (machine-readable) code: anyOf: - type: string - type: 'null' title: Code description: >- Fine-grained error code for programmatic handling (e.g., namespace_name_taken, feature_extractor_not_found). Present only when consumers may need to branch on a specific error condition. details: anyOf: - additionalProperties: true type: object - type: 'null' title: Details description: >- Optional structured details to help debugging (validation errors, IDs, etc.) type: object required: - message - type title: ErrorDetail description: Error detail model. securitySchemes: BearerAuth: type: http scheme: bearer description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.