Skip to main content
POST
Publish an extractor to the marketplace

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

Path Parameters

extractor_id
string
required

ID of the extractor to publish

Body

application/json

Keys this body does not declare are ignored, and the response's warnings name them, until 2026-11-02; from 2026-11-02 they are refused with 422 extra_forbidden naming the accepted keys.

public_name
string | null

URL-safe slug. Auto-generated from display_name if not provided.

Required string length: 3 - 50
Pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
display_name
string | null
Maximum string length: 100
description
string | null
Maximum string length: 1000
icon_base64
string | null
Maximum string length: 300000
readme_markdown
string | null
Maximum string length: 50000
tags
string[]
category
string | null
Maximum string length: 50
model_dependencies
ModelDependency · object[]

Response

Successful Response

public_id
string
required
extractor_id
string
required
public_name
string
required
public_url
string
required