Lint Manifest

curl --request POST \
  --url https://api.mixpeek.com/v1/manifest/lint \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form manifest_file='@example-file'

{
  "valid": true,
  "results": [
    {
      "code": "<string>",
      "message": "<string>",
      "location": "<string>",
      "suggestion": "<string>",
      "fix_example": "<string>"
    }
  ],
  "summary": {}
}

Manifest

Lint Manifest

Lint a YAML manifest for best practices and potential issues.

Goes beyond basic validation to provide actionable suggestions for improving your manifest configuration. This endpoint is designed for AI agents and developers who want to optimize their Mixpeek setup.

Lint Rules:

UNUSED_EXTRACTOR: Feature extractor defined but not used by any collection
UNUSED_COLLECTION: Collection not referenced by any retriever
MISSING_INPUT_SCHEMA: Retriever uses templates but has no input_schema
MISSING_CACHE_CONFIG: Retriever without caching (especially with LLM stages)
SUBOPTIMAL_STAGE_ORDER: Filter stages after expensive operations
DUPLICATE_FEATURE_URI: Same feature searched multiple times
MISSING_DESCRIPTION: Resources without descriptions
NO_SEARCH_STAGE: Retriever with no search stages
EXTRACTOR_NOT_IN_NAMESPACE: Collection uses extractor not in namespace
MISSING_SECRET: Secret reference not configured

Severity Levels:

error: Must be fixed before applying
warning: Best practice violation, should be fixed
info: Suggestion for improvement

Example:

curl -X POST /v1/manifest/lint \
  -H "Authorization: Bearer $API_KEY" \
  -F "manifest_file=@mixpeek.yaml"

Response includes actionable suggestions:

{
  "valid": true,
  "results": [
    {
      "code": "MISSING_CACHE_CONFIG",
      "severity": "warning",
      "message": "Retriever 'product_search' has no cache configuration",
      "location": "retrievers[0]",
      "suggestion": "Add cache_config to improve performance",
      "fix_example": "cache_config:\n  enabled: true\n  ttl_seconds: 3600"
    }
  ],
  "summary": {"error": 0, "warning": 1, "info": 0}
}

POST

manifest

lint

Lint Manifest

curl --request POST \
  --url https://api.mixpeek.com/v1/manifest/lint \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form manifest_file='@example-file'

{
  "valid": true,
  "results": [
    {
      "code": "<string>",
      "message": "<string>",
      "location": "<string>",
      "suggestion": "<string>",
      "fix_example": "<string>"
    }
  ],
  "summary": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

skip_rules

string[]

Rule codes to skip (e.g., MISSING_DESCRIPTION)

Body

multipart/form-data

manifest_file

file

required

YAML manifest file

Response

Successful Response

Response from the lint endpoint.

Example: { "valid": true, "results": [...], "summary": {"error": 0, "warning": 2, "info": 3} }

valid

boolean

required

Whether the manifest is valid (no errors, warnings OK)

results

LintResult · object[]

List of lint results

Show child attributes

summary

Summary · object

Count of results by severity

Show child attributes

Generate Manifest Get All Discovery Information