Update published extractor
curl --request PATCH \
--url https://api.mixpeek.com/v1/extractors/{extractor_id}/publish \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"icon_base64": "<string>",
"readme_markdown": "<string>",
"tags": [
"<string>"
],
"category": "<string>",
"model_dependencies": [
{
"name": "<string>",
"source": "builtin",
"format": "<string>",
"required": true
}
],
"is_active": true
}
'import requests
url = "https://api.mixpeek.com/v1/extractors/{extractor_id}/publish"
payload = {
"description": "<string>",
"icon_base64": "<string>",
"readme_markdown": "<string>",
"tags": ["<string>"],
"category": "<string>",
"model_dependencies": [
{
"name": "<string>",
"source": "builtin",
"format": "<string>",
"required": True
}
],
"is_active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
icon_base64: '<string>',
readme_markdown: '<string>',
tags: ['<string>'],
category: '<string>',
model_dependencies: [{name: '<string>', source: 'builtin', format: '<string>', required: true}],
is_active: true
})
};
fetch('https://api.mixpeek.com/v1/extractors/{extractor_id}/publish', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mixpeek.com/v1/extractors/{extractor_id}/publish",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'icon_base64' => '<string>',
'readme_markdown' => '<string>',
'tags' => [
'<string>'
],
'category' => '<string>',
'model_dependencies' => [
[
'name' => '<string>',
'source' => 'builtin',
'format' => '<string>',
'required' => true
]
],
'is_active' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mixpeek.com/v1/extractors/{extractor_id}/publish"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"icon_base64\": \"<string>\",\n \"readme_markdown\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"model_dependencies\": [\n {\n \"name\": \"<string>\",\n \"source\": \"builtin\",\n \"format\": \"<string>\",\n \"required\": true\n }\n ],\n \"is_active\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.mixpeek.com/v1/extractors/{extractor_id}/publish")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"icon_base64\": \"<string>\",\n \"readme_markdown\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"model_dependencies\": [\n {\n \"name\": \"<string>\",\n \"source\": \"builtin\",\n \"format\": \"<string>\",\n \"required\": true\n }\n ],\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/extractors/{extractor_id}/publish")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"icon_base64\": \"<string>\",\n \"readme_markdown\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"model_dependencies\": [\n {\n \"name\": \"<string>\",\n \"source\": \"builtin\",\n \"format\": \"<string>\",\n \"required\": true\n }\n ],\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"extractor_id": "<string>",
"public_id": "<string>",
"public_name": "<string>",
"version": "<string>",
"trust_tier": "community",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"display_name": "<string>",
"description": "<string>",
"capabilities": [
"batch"
],
"tags": [
"<string>"
],
"category": "<string>",
"install_count": 0,
"is_active": true
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}Publishing
Update published extractor
PATCH
/
v1
/
extractors
/
{extractor_id}
/
publish
Update published extractor
curl --request PATCH \
--url https://api.mixpeek.com/v1/extractors/{extractor_id}/publish \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"icon_base64": "<string>",
"readme_markdown": "<string>",
"tags": [
"<string>"
],
"category": "<string>",
"model_dependencies": [
{
"name": "<string>",
"source": "builtin",
"format": "<string>",
"required": true
}
],
"is_active": true
}
'import requests
url = "https://api.mixpeek.com/v1/extractors/{extractor_id}/publish"
payload = {
"description": "<string>",
"icon_base64": "<string>",
"readme_markdown": "<string>",
"tags": ["<string>"],
"category": "<string>",
"model_dependencies": [
{
"name": "<string>",
"source": "builtin",
"format": "<string>",
"required": True
}
],
"is_active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
description: '<string>',
icon_base64: '<string>',
readme_markdown: '<string>',
tags: ['<string>'],
category: '<string>',
model_dependencies: [{name: '<string>', source: 'builtin', format: '<string>', required: true}],
is_active: true
})
};
fetch('https://api.mixpeek.com/v1/extractors/{extractor_id}/publish', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mixpeek.com/v1/extractors/{extractor_id}/publish",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '<string>',
'icon_base64' => '<string>',
'readme_markdown' => '<string>',
'tags' => [
'<string>'
],
'category' => '<string>',
'model_dependencies' => [
[
'name' => '<string>',
'source' => 'builtin',
'format' => '<string>',
'required' => true
]
],
'is_active' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mixpeek.com/v1/extractors/{extractor_id}/publish"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"icon_base64\": \"<string>\",\n \"readme_markdown\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"model_dependencies\": [\n {\n \"name\": \"<string>\",\n \"source\": \"builtin\",\n \"format\": \"<string>\",\n \"required\": true\n }\n ],\n \"is_active\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.mixpeek.com/v1/extractors/{extractor_id}/publish")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"icon_base64\": \"<string>\",\n \"readme_markdown\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"model_dependencies\": [\n {\n \"name\": \"<string>\",\n \"source\": \"builtin\",\n \"format\": \"<string>\",\n \"required\": true\n }\n ],\n \"is_active\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/extractors/{extractor_id}/publish")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"icon_base64\": \"<string>\",\n \"readme_markdown\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"category\": \"<string>\",\n \"model_dependencies\": [\n {\n \"name\": \"<string>\",\n \"source\": \"builtin\",\n \"format\": \"<string>\",\n \"required\": true\n }\n ],\n \"is_active\": true\n}"
response = http.request(request)
puts response.read_body{
"extractor_id": "<string>",
"public_id": "<string>",
"public_name": "<string>",
"version": "<string>",
"trust_tier": "community",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"display_name": "<string>",
"description": "<string>",
"capabilities": [
"batch"
],
"tags": [
"<string>"
],
"category": "<string>",
"install_count": 0,
"is_active": true
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}Authorizations
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 header returns 403; an invalid or revoked key returns 401.
Path Parameters
ID of the extractor
Body
application/json
Maximum string length:
1000Maximum string length:
300000Maximum string length:
50000Maximum string length:
50Show child attributes
Show child attributes
Response
Successful Response
Available options:
community, verified, official Available options:
batch, realtime Was this page helpful?

