Extractor Submissions

​

How It Works

1. Develop — Build your extractor following the Custom Extractors guide
2. Submit — Upload your extractor archive via POST /v1/extractors/submissions
3. Review — The Mixpeek team reviews the submission for quality, security, and compatibility
4. Merge — Approved extractors are merged into engine/extractors/ and become available as built-in extractors

​

Submitting an Extractor

# Package your extractor
zip -r my_text_extractor.zip my_text_extractor/

# Submit for review
curl -X POST "https://api.mixpeek.com/v1/extractors/submissions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: multipart/form-data" \
  -F "archive=@my_text_extractor.zip" \
  -F "display_name=My Text Extractor" \
  -F "description=Advanced text extraction with custom NLP models" \
  -F "category=text-processing"

​

Submission Requirements

• Extractor must pass validation and security scan (same rules as custom extractor uploads)
• Include a complete manifest.py with correct features definitions
• Include working pipeline.py and optionally realtime.py
• Archive must be under 500 MB

​

Review Process

1. The archive is validated and scanned automatically
2. The Mixpeek team reviews the extractor code for quality and security
3. If approved, the extractor code is merged into engine/extractors/
4. The submitting organization is notified and the extractor becomes available to all users

​

Trust Tiers

​

Using Approved Extractors

# Create a collection using the approved extractor
client.collections.create(
    namespace_id="ns_abc123",
    collection_name="my-collection",
    source={"type": "bucket", "bucket_ids": ["bkt_xyz"]},
    feature_extractor={
        "feature_extractor_name": "text_extractor",
        "version": "v1",
        "input_mappings": {"text": "description"},
    }
)