Onboarding

Infer onboarding configuration

Changed on

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.

post/v1/onboarding/infer-config

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/onboarding/infer-config
  • Auth: HTTP bearer

Request body

use_case_descriptionstring required

Free-text description of what the user wants to build.

content_typesstring[]

Optional hint about data types the user has (e.g. 'video', 'pdf', 'image').

Example request

{
  "use_case_description": "I want to search my product catalog by image",
  "content_types": [
    "video",
    "image"
  ]
}

Response

Successful Response

recommended_scaffold_idstring required

Template ID from the scaffold catalog (e.g. 'tmpl_scaffold_video_understanding').

scaffold_namestring required

Human-readable template name.

confidencenumber required

Model confidence in this recommendation.

reasoningstring required

2-3 sentence explanation of why this scaffold was chosen.

alternate_scaffold_idstring nullable

Second-best template if the primary isn't a great fit.

alternate_scaffold_namestring nullable

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