> ## 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.

# Infer onboarding configuration

> Given a free-text use-case description, uses an LLM to recommend the best scaffold template, extractors, retriever stages, and sample queries for the user's project.



## OpenAPI

````yaml post /v1/onboarding/infer-config
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/onboarding/infer-config:
    post:
      tags:
        - Onboarding
      summary: Infer onboarding configuration
      description: >-
        Given a free-text use-case description, uses an LLM to recommend the
        best scaffold template, extractors, retriever stages, and sample queries
        for the user's project.
      operationId: infer_config_v1_onboarding_infer_config_post
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InferConfigRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InferConfigResponse'
        '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: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    InferConfigRequest:
      properties:
        use_case_description:
          type: string
          maxLength: 2000
          minLength: 5
          title: Use Case Description
          description: Free-text description of what the user wants to build.
          examples:
            - I want to search my product catalog by image
            - I need to moderate user-generated content on my platform
        content_types:
          items:
            type: string
          type: array
          title: Content Types
          description: >-
            Optional hint about data types the user has (e.g. 'video', 'pdf',
            'image').
          examples:
            - - video
              - image
            - - pdf
              - text
      type: object
      required:
        - use_case_description
      title: InferConfigRequest
    InferConfigResponse:
      properties:
        recommended_scaffold_id:
          type: string
          title: Recommended Scaffold Id
          description: >-
            Template ID from the scaffold catalog (e.g.
            'tmpl_scaffold_video_understanding').
        scaffold_name:
          type: string
          title: Scaffold Name
          description: Human-readable template name.
        confidence:
          type: number
          maximum: 1
          minimum: 0
          title: Confidence
          description: Model confidence in this recommendation.
        reasoning:
          type: string
          title: Reasoning
          description: 2-3 sentence explanation of why this scaffold was chosen.
        extractors:
          items:
            $ref: '#/components/schemas/SuggestedExtractor'
          type: array
          title: Extractors
          description: Recommended feature extractors.
        retriever_stages:
          items:
            $ref: '#/components/schemas/SuggestedStage'
          type: array
          title: Retriever Stages
          description: Recommended retriever pipeline stages.
        sample_queries:
          items:
            $ref: '#/components/schemas/SampleQuery'
          type: array
          title: Sample Queries
          description: Example search queries the user could run.
        alternate_scaffold_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Alternate Scaffold Id
          description: Second-best template if the primary isn't a great fit.
        alternate_scaffold_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Alternate Scaffold Name
      type: object
      required:
        - recommended_scaffold_id
        - scaffold_name
        - confidence
        - reasoning
        - extractors
        - retriever_stages
        - sample_queries
      title: InferConfigResponse
    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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SuggestedExtractor:
      properties:
        name:
          type: string
          title: Name
          description: Feature extractor name (e.g. 'image_extractor').
        version:
          type: string
          title: Version
          default: v1
        reason:
          type: string
          title: Reason
          description: One-sentence explanation of why this extractor fits.
      type: object
      required:
        - name
        - reason
      title: SuggestedExtractor
    SuggestedStage:
      properties:
        stage_name:
          type: string
          title: Stage Name
        stage_type:
          type: string
          title: Stage Type
          default: filter
        description:
          type: string
          title: Description
      type: object
      required:
        - stage_name
        - description
      title: SuggestedStage
    SampleQuery:
      properties:
        query:
          type: string
          title: Query
        description:
          type: string
          title: Description
      type: object
      required:
        - query
        - description
      title: SampleQuery
    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.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  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 header returns
        403; an invalid or revoked key returns 401.

````