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 collectionUNUSED_COLLECTION: Collection not referenced by any retrieverMISSING_INPUT_SCHEMA: Retriever uses templates but has no input_schemaMISSING_CACHE_CONFIG: Retriever without caching (especially with LLM stages)SUBOPTIMAL_STAGE_ORDER: Filter stages after expensive operationsDUPLICATE_FEATURE_URI: Same feature searched multiple timesMISSING_DESCRIPTION: Resources without descriptionsNO_SEARCH_STAGE: Retriever with no search stagesEXTRACTOR_NOT_IN_NAMESPACE: Collection uses extractor not in namespaceMISSING_SECRET: Secret reference not configured
Severity Levels:
error: Must be fixed before applyingwarning: Best practice violation, should be fixedinfo: 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}
}
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.
Headers
REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.
"Bearer YOUR_API_KEY"
"Bearer YOUR_STRIPE_API_KEY"
Query Parameters
Rule codes to skip (e.g., MISSING_DESCRIPTION)
Body
YAML manifest file
Response
Successful Response
Response from the lint endpoint.
Example: { "valid": true, "results": [...], "summary": {"error": 0, "warning": 2, "info": 3} }