Describe It: Generate a Pipeline

Describe what you want to retrieve in plain words, and get back a validated manifest with its models, extractors and retriever, plus a cost estimate.

POST /v1/manifest/generate takes a plain-words description of what you want to retrieve. It returns a manifest: the buckets, collections, extractors and retriever that do the job, written as YAML you can review and apply.

​

What the generator does

1. Reads the live catalogs

   The model that writes the manifest is given the current extractor and retriever-stage catalogs to choose from.

2. Validates its own answer

   The draft goes through the same checks as POST /v1/manifest/validate. When those checks find errors, the model sees them and repairs its answer, up to 2 times.

3. Prices and matches it

   The response prices the manifest at list rates and names the closest namespace templates and catalog models.

​

Generate a manifest

cURL

curl -X POST "https://api.mixpeek.com/v1/manifest/generate" \
  -H "Authorization: Bearer $MP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Search our product videos by what is shown and said, and find every scene with our logo",
    "manifest_name": "product-video-search"
  }'

​

Request fields

description · string · required

What the namespace should do, in plain words.

manifest_name · string · default: "generated-manifest"

Written to metadata.name in the manifest.

inventory · object

Files per bucket name the manifest will declare. With it, the response carries a quote for indexing those files.

queries_per_month · integer · default: "0"

Used for the monthly price in quote.

​

Response fields

manifest · string

The manifest, as YAML.

validation · object

valid, errors and warnings, from the same checks as validate. When valid is false after the repair rounds, the errors are still listed so you can fix them by hand.

repair_rounds · integer

How many times the model repaired its answer, 0 to 2.

cost_estimate · object

The manifest priced at list rates: per 1,000 items, and per month at the volume stated in its monthly_volume field.

suggested · object

templates and models: the namespace templates and catalog models the generator was offered as the closest matches to your description.

quote · object

Present when you send inventory. The indexing charge for those files, the monthly price and the unit prices, the same quote POST /v1/organizations/billing/estimate returns for this manifest. A bucket in inventory that the manifest does not declare is reported in quote.error.

​

Review and apply

1. Read the manifest

   Check the extractors and the retriever stages against what you described. Edit the YAML where it differs.

2. Dry run

   Call POST /v1/manifest/apply with dry_run=true. The response lists what would be created, in dependency order, and creates nothing.

3. Apply

   Call POST /v1/manifest/apply. It creates the resources and returns the result, or a task to poll.

Once the retriever runs, Auto-Tune adapts its fusion weights to how people use the results.

Manifests

The full manifest format and the authoring loop.

Auto-Tune

Fusion weights that adapt from interactions.