Generate presigned URL for model upload
curl --request POST \
--url https://api.mixpeek.com/v1/models/uploads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "custom_embedder",
"version": "1.0.0",
"model_format": "safetensors",
"description": "<string>",
"file_size_bytes": 2684354560,
"presigned_url_expiration": 3600,
"resource_requirements": {
"num_cpus": 1,
"num_gpus": 0,
"memory": 4294967296
},
"framework": "<string>",
"task_type": "<string>",
"source": "customer"
}
'import requests
url = "https://api.mixpeek.com/v1/models/uploads"
payload = {
"name": "custom_embedder",
"version": "1.0.0",
"model_format": "safetensors",
"description": "<string>",
"file_size_bytes": 2684354560,
"presigned_url_expiration": 3600,
"resource_requirements": {
"num_cpus": 1,
"num_gpus": 0,
"memory": 4294967296
},
"framework": "<string>",
"task_type": "<string>",
"source": "customer"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'custom_embedder',
version: '1.0.0',
model_format: 'safetensors',
description: '<string>',
file_size_bytes: 2684354560,
presigned_url_expiration: 3600,
resource_requirements: {num_cpus: 1, num_gpus: 0, memory: 4294967296},
framework: '<string>',
task_type: '<string>',
source: 'customer'
})
};
fetch('https://api.mixpeek.com/v1/models/uploads', 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/models/uploads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'custom_embedder',
'version' => '1.0.0',
'model_format' => 'safetensors',
'description' => '<string>',
'file_size_bytes' => 2684354560,
'presigned_url_expiration' => 3600,
'resource_requirements' => [
'num_cpus' => 1,
'num_gpus' => 0,
'memory' => 4294967296
],
'framework' => '<string>',
'task_type' => '<string>',
'source' => 'customer'
]),
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/models/uploads"
payload := strings.NewReader("{\n \"name\": \"custom_embedder\",\n \"version\": \"1.0.0\",\n \"model_format\": \"safetensors\",\n \"description\": \"<string>\",\n \"file_size_bytes\": 2684354560,\n \"presigned_url_expiration\": 3600,\n \"resource_requirements\": {\n \"num_cpus\": 1,\n \"num_gpus\": 0,\n \"memory\": 4294967296\n },\n \"framework\": \"<string>\",\n \"task_type\": \"<string>\",\n \"source\": \"customer\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.mixpeek.com/v1/models/uploads")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"custom_embedder\",\n \"version\": \"1.0.0\",\n \"model_format\": \"safetensors\",\n \"description\": \"<string>\",\n \"file_size_bytes\": 2684354560,\n \"presigned_url_expiration\": 3600,\n \"resource_requirements\": {\n \"num_cpus\": 1,\n \"num_gpus\": 0,\n \"memory\": 4294967296\n },\n \"framework\": \"<string>\",\n \"task_type\": \"<string>\",\n \"source\": \"customer\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/models/uploads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"custom_embedder\",\n \"version\": \"1.0.0\",\n \"model_format\": \"safetensors\",\n \"description\": \"<string>\",\n \"file_size_bytes\": 2684354560,\n \"presigned_url_expiration\": 3600,\n \"resource_requirements\": {\n \"num_cpus\": 1,\n \"num_gpus\": 0,\n \"memory\": 4294967296\n },\n \"framework\": \"<string>\",\n \"task_type\": \"<string>\",\n \"source\": \"customer\"\n}"
response = http.request(request)
puts response.read_body{
"upload_id": "<string>",
"presigned_url": "<string>",
"s3_key": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"organization_id": "<string>",
"name": "<string>",
"version": "<string>",
"model_format": "safetensors",
"required_content_type": "application/gzip"
}{
"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
}{
"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
}Models
Generate presigned URL for model upload
Generate a presigned URL for uploading a custom model archive.
This is step 1 of the presigned URL workflow:
- POST /models/uploads → Returns presigned_url + upload_id
- PUT presigned_url with model archive (client uploads directly to S3)
- POST /models/uploads//confirm → Validates and creates model
The model will be stored at the organization level and can be enabled in any namespace within the organization.
Availability: custom model upload is an enterprise-tier feature — requests from other account tiers receive a 403. Contact support or upgrade your plan to enable it (this gate was previously undocumented and only discoverable by hitting the 403).
POST
/
v1
/
models
/
uploads
Generate presigned URL for model upload
curl --request POST \
--url https://api.mixpeek.com/v1/models/uploads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "custom_embedder",
"version": "1.0.0",
"model_format": "safetensors",
"description": "<string>",
"file_size_bytes": 2684354560,
"presigned_url_expiration": 3600,
"resource_requirements": {
"num_cpus": 1,
"num_gpus": 0,
"memory": 4294967296
},
"framework": "<string>",
"task_type": "<string>",
"source": "customer"
}
'import requests
url = "https://api.mixpeek.com/v1/models/uploads"
payload = {
"name": "custom_embedder",
"version": "1.0.0",
"model_format": "safetensors",
"description": "<string>",
"file_size_bytes": 2684354560,
"presigned_url_expiration": 3600,
"resource_requirements": {
"num_cpus": 1,
"num_gpus": 0,
"memory": 4294967296
},
"framework": "<string>",
"task_type": "<string>",
"source": "customer"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'custom_embedder',
version: '1.0.0',
model_format: 'safetensors',
description: '<string>',
file_size_bytes: 2684354560,
presigned_url_expiration: 3600,
resource_requirements: {num_cpus: 1, num_gpus: 0, memory: 4294967296},
framework: '<string>',
task_type: '<string>',
source: 'customer'
})
};
fetch('https://api.mixpeek.com/v1/models/uploads', 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/models/uploads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'custom_embedder',
'version' => '1.0.0',
'model_format' => 'safetensors',
'description' => '<string>',
'file_size_bytes' => 2684354560,
'presigned_url_expiration' => 3600,
'resource_requirements' => [
'num_cpus' => 1,
'num_gpus' => 0,
'memory' => 4294967296
],
'framework' => '<string>',
'task_type' => '<string>',
'source' => 'customer'
]),
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/models/uploads"
payload := strings.NewReader("{\n \"name\": \"custom_embedder\",\n \"version\": \"1.0.0\",\n \"model_format\": \"safetensors\",\n \"description\": \"<string>\",\n \"file_size_bytes\": 2684354560,\n \"presigned_url_expiration\": 3600,\n \"resource_requirements\": {\n \"num_cpus\": 1,\n \"num_gpus\": 0,\n \"memory\": 4294967296\n },\n \"framework\": \"<string>\",\n \"task_type\": \"<string>\",\n \"source\": \"customer\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.mixpeek.com/v1/models/uploads")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"custom_embedder\",\n \"version\": \"1.0.0\",\n \"model_format\": \"safetensors\",\n \"description\": \"<string>\",\n \"file_size_bytes\": 2684354560,\n \"presigned_url_expiration\": 3600,\n \"resource_requirements\": {\n \"num_cpus\": 1,\n \"num_gpus\": 0,\n \"memory\": 4294967296\n },\n \"framework\": \"<string>\",\n \"task_type\": \"<string>\",\n \"source\": \"customer\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/models/uploads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"custom_embedder\",\n \"version\": \"1.0.0\",\n \"model_format\": \"safetensors\",\n \"description\": \"<string>\",\n \"file_size_bytes\": 2684354560,\n \"presigned_url_expiration\": 3600,\n \"resource_requirements\": {\n \"num_cpus\": 1,\n \"num_gpus\": 0,\n \"memory\": 4294967296\n },\n \"framework\": \"<string>\",\n \"task_type\": \"<string>\",\n \"source\": \"customer\"\n}"
response = http.request(request)
puts response.read_body{
"upload_id": "<string>",
"presigned_url": "<string>",
"s3_key": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"organization_id": "<string>",
"name": "<string>",
"version": "<string>",
"model_format": "safetensors",
"required_content_type": "application/gzip"
}{
"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
}{
"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
}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, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.
Body
application/json
Keys this body does not declare are refused with 422 extra_forbidden naming the accepted keys (since 2026-11-02).
Request to generate a presigned URL for model archive upload.
This is step 1 of the presigned URL workflow:
- POST /models/uploads → Returns presigned_url + upload_id
- PUT presigned_url with model archive (client uploads directly to S3)
- POST /models/uploads/{upload_id}/confirm → Validates and creates model
Requirements: - name: Model name (e.g., 'my_custom_embedder') - version: Semantic version (e.g., '1.0.0') - model_format: Format of the model weights - file_size_bytes: Expected archive size for quota validation
Model name: 3-64 chars, letters/numbers/underscores, starts with a letter (no hyphens or spaces)
Pattern:
^[a-zA-Z][a-zA-Z0-9_]{2,63}$Examples:
"custom_embedder"
"sentiment_model"
"image_classifier"
Semantic version string
Pattern:
^\d+\.\d+\.\d+$Examples:
"1.0.0"
"2.1.3"
"0.0.1"
Format of the model weights
Available options:
safetensors, onnx, pytorch, huggingface Examples:
"safetensors"
"onnx"
"pytorch"
"huggingface"
Optional description of the model
Maximum string length:
500Expected file size in bytes for quota validation
Required range:
0 < x <= 5368709120Presigned URL expiration time in seconds (1-24 hours)
Required range:
60 <= x <= 86400Resource requirements for model deployment
Show child attributes
Show child attributes
ML framework (e.g., sentence-transformers, transformers)
Task type (e.g., embedding, classification, generation)
Who is uploading: 'customer' (default) or 'mixpeek' (professional services). Mixpeek-sourced models are non-exportable by default.
Available options:
customer, mixpeek, system Response
Successful Response
Response containing presigned URL for model upload.
After receiving this response:
- PUT the model archive to
presigned_urlwith therequired_content_typeheader (the value the URL is signed with) - Call POST /models/uploads/{upload_id}/confirm to finalize
Upload ID to use when confirming
S3 presigned URL for PUT upload
S3 object key where file will be stored
When the presigned URL expires
Organization ID
Model name
Model version
Model format
Available options:
safetensors, onnx, pytorch, huggingface Content-Type the presigned PUT is signed with. Send this exact value as the Content-Type header on the upload PUT, or object storage rejects it with 403 SignatureDoesNotMatch. Parity with the extractor upload.
Was this page helpful?