Skip to main content
PATCH
Update published extractor

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

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.

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[] | null
category
string | null
Maximum string length: 50
model_dependencies
ModelDependency · object[] | null
is_active
boolean | null

Response

Successful Response

extractor_id
string
required
public_id
string
required
public_name
string
required
version
string
required
trust_tier
enum<string>
required
Available options:
community,
verified,
official
created_at
string<date-time>
required
updated_at
string<date-time>
required
display_name
string | null
description
string | null
capabilities
enum<string>[]
Available options:
batch,
realtime
tags
string[]
category
string | null
install_count
integer
default:0
is_active
boolean
default:true