---
title: "Infer onboarding configuration"
method: POST
path: "/v1/onboarding/infer-config"
tags: ["Onboarding"]
---

# Infer onboarding configuration

`POST /v1/onboarding/infer-config`

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.

## Request body

- InferConfigRequest
  - `use_case_description` string, required — Free-text description of what the user wants to build.
  - `content_types` string[] — Optional hint about data types the user has (e.g. 'video', 'pdf', 'image').

## Response `200`

Successful Response

- InferConfigResponse
  - `recommended_scaffold_id` string, required — Template ID from the scaffold catalog (e.g. 'tmpl_scaffold_video_understanding').
  - `scaffold_name` string, required — Human-readable template name.
  - `confidence` number, required — Model confidence in this recommendation.
  - `reasoning` string, required — 2-3 sentence explanation of why this scaffold was chosen.
  - `extractors` SuggestedExtractor[], required — Recommended feature extractors.
    - `name` string, required — Feature extractor name (e.g. 'image_extractor').
    - `version` string
    - `reason` string, required — One-sentence explanation of why this extractor fits.
  - `retriever_stages` SuggestedStage[], required — Recommended retriever pipeline stages.
    - `stage_name` string, required
    - `stage_type` string
    - `description` string, required
  - `sample_queries` SampleQuery[], required — Example search queries the user could run.
    - `query` string, required
    - `description` string, required
  - `alternate_scaffold_id` string, nullable — Second-best template if the primary isn't a great fit.
  - `alternate_scaffold_name` string, nullable

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Validation Error
- `500` — Internal Server Error

---

[API](https://skmtc.net/mixpeek/apis/mixpeek-api.md) · [All operations](https://skmtc.net/mixpeek/apis/mixpeek-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mixpeek/mixpeek-api/revisions/04b379bdbb7c/schema)
