Estimate Cost

curl --request POST \
  --url https://api.mixpeek.com/v1/organizations/billing/estimate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "mime_type": "<string>",
      "count": 123,
      "minutes": 123,
      "pages": 123,
      "tokens": 123,
      "units": 123
    }
  ],
  "features": [
    "<string>"
  ],
  "full_res": false,
  "manifest": "<string>",
  "inventory": {
    "footage": {
      "minutes": 1900,
      "objects": 400
    }
  },
  "queries_per_month": 0
}
'

import requests

url = "https://api.mixpeek.com/v1/organizations/billing/estimate"

payload = {
    "items": [
        {
            "mime_type": "<string>",
            "count": 123,
            "minutes": 123,
            "pages": 123,
            "tokens": 123,
            "units": 123
        }
    ],
    "features": ["<string>"],
    "full_res": False,
    "manifest": "<string>",
    "inventory": { "footage": {
            "minutes": 1900,
            "objects": 400
        } },
    "queries_per_month": 0
}
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({
    items: [
      {
        mime_type: '<string>',
        count: 123,
        minutes: 123,
        pages: 123,
        tokens: 123,
        units: 123
      }
    ],
    features: ['<string>'],
    full_res: false,
    manifest: '<string>',
    inventory: {footage: {minutes: 1900, objects: 400}},
    queries_per_month: 0
  })
};

fetch('https://api.mixpeek.com/v1/organizations/billing/estimate', 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/organizations/billing/estimate",
  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([
    'items' => [
        [
                'mime_type' => '<string>',
                'count' => 123,
                'minutes' => 123,
                'pages' => 123,
                'tokens' => 123,
                'units' => 123
        ]
    ],
    'features' => [
        '<string>'
    ],
    'full_res' => false,
    'manifest' => '<string>',
    'inventory' => [
        'footage' => [
                'minutes' => 1900,
                'objects' => 400
        ]
    ],
    'queries_per_month' => 0
  ]),
  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/organizations/billing/estimate"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"mime_type\": \"<string>\",\n      \"count\": 123,\n      \"minutes\": 123,\n      \"pages\": 123,\n      \"tokens\": 123,\n      \"units\": 123\n    }\n  ],\n  \"features\": [\n    \"<string>\"\n  ],\n  \"full_res\": false,\n  \"manifest\": \"<string>\",\n  \"inventory\": {\n    \"footage\": {\n      \"minutes\": 1900,\n      \"objects\": 400\n    }\n  },\n  \"queries_per_month\": 0\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/organizations/billing/estimate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"mime_type\": \"<string>\",\n      \"count\": 123,\n      \"minutes\": 123,\n      \"pages\": 123,\n      \"tokens\": 123,\n      \"units\": 123\n    }\n  ],\n  \"features\": [\n    \"<string>\"\n  ],\n  \"full_res\": false,\n  \"manifest\": \"<string>\",\n  \"inventory\": {\n    \"footage\": {\n      \"minutes\": 1900,\n      \"objects\": 400\n    }\n  },\n  \"queries_per_month\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/organizations/billing/estimate")

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  \"items\": [\n    {\n      \"mime_type\": \"<string>\",\n      \"count\": 123,\n      \"minutes\": 123,\n      \"pages\": 123,\n      \"tokens\": 123,\n      \"units\": 123\n    }\n  ],\n  \"features\": [\n    \"<string>\"\n  ],\n  \"full_res\": false,\n  \"manifest\": \"<string>\",\n  \"inventory\": {\n    \"footage\": {\n      \"minutes\": 1900,\n      \"objects\": 400\n    }\n  },\n  \"queries_per_month\": 0\n}"

response = http.request(request)
puts response.read_body

{
  "placeholder_rates": true,
  "line_items": [
    {}
  ],
  "total_usd": 123,
  "batch_minimum_applied": true,
  "allowance_covered_usd": 123,
  "estimated_overage_usd": 123,
  "pricing_model": "v2",
  "allowance_pool_usd": 123,
  "overage_discount_pct": 0,
  "overage_discount_usd": 0,
  "manifest_quote": {
    "index_usd": 123,
    "monthly_usd": 123,
    "storage_usd": 123,
    "queries_usd": 123,
    "unit_prices": [
      {}
    ],
    "collections": [
      {}
    ],
    "unpriced_collections": [
      "<string>"
    ],
    "assumptions": [
      "<string>"
    ]
  }
}

{
  "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
}

POST

organizations

billing

estimate

Estimate Cost

curl --request POST \
  --url https://api.mixpeek.com/v1/organizations/billing/estimate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "mime_type": "<string>",
      "count": 123,
      "minutes": 123,
      "pages": 123,
      "tokens": 123,
      "units": 123
    }
  ],
  "features": [
    "<string>"
  ],
  "full_res": false,
  "manifest": "<string>",
  "inventory": {
    "footage": {
      "minutes": 1900,
      "objects": 400
    }
  },
  "queries_per_month": 0
}
'

import requests

url = "https://api.mixpeek.com/v1/organizations/billing/estimate"

payload = {
    "items": [
        {
            "mime_type": "<string>",
            "count": 123,
            "minutes": 123,
            "pages": 123,
            "tokens": 123,
            "units": 123
        }
    ],
    "features": ["<string>"],
    "full_res": False,
    "manifest": "<string>",
    "inventory": { "footage": {
            "minutes": 1900,
            "objects": 400
        } },
    "queries_per_month": 0
}
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({
    items: [
      {
        mime_type: '<string>',
        count: 123,
        minutes: 123,
        pages: 123,
        tokens: 123,
        units: 123
      }
    ],
    features: ['<string>'],
    full_res: false,
    manifest: '<string>',
    inventory: {footage: {minutes: 1900, objects: 400}},
    queries_per_month: 0
  })
};

fetch('https://api.mixpeek.com/v1/organizations/billing/estimate', 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/organizations/billing/estimate",
  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([
    'items' => [
        [
                'mime_type' => '<string>',
                'count' => 123,
                'minutes' => 123,
                'pages' => 123,
                'tokens' => 123,
                'units' => 123
        ]
    ],
    'features' => [
        '<string>'
    ],
    'full_res' => false,
    'manifest' => '<string>',
    'inventory' => [
        'footage' => [
                'minutes' => 1900,
                'objects' => 400
        ]
    ],
    'queries_per_month' => 0
  ]),
  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/organizations/billing/estimate"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"mime_type\": \"<string>\",\n      \"count\": 123,\n      \"minutes\": 123,\n      \"pages\": 123,\n      \"tokens\": 123,\n      \"units\": 123\n    }\n  ],\n  \"features\": [\n    \"<string>\"\n  ],\n  \"full_res\": false,\n  \"manifest\": \"<string>\",\n  \"inventory\": {\n    \"footage\": {\n      \"minutes\": 1900,\n      \"objects\": 400\n    }\n  },\n  \"queries_per_month\": 0\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/organizations/billing/estimate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"mime_type\": \"<string>\",\n      \"count\": 123,\n      \"minutes\": 123,\n      \"pages\": 123,\n      \"tokens\": 123,\n      \"units\": 123\n    }\n  ],\n  \"features\": [\n    \"<string>\"\n  ],\n  \"full_res\": false,\n  \"manifest\": \"<string>\",\n  \"inventory\": {\n    \"footage\": {\n      \"minutes\": 1900,\n      \"objects\": 400\n    }\n  },\n  \"queries_per_month\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/organizations/billing/estimate")

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  \"items\": [\n    {\n      \"mime_type\": \"<string>\",\n      \"count\": 123,\n      \"minutes\": 123,\n      \"pages\": 123,\n      \"tokens\": 123,\n      \"units\": 123\n    }\n  ],\n  \"features\": [\n    \"<string>\"\n  ],\n  \"full_res\": false,\n  \"manifest\": \"<string>\",\n  \"inventory\": {\n    \"footage\": {\n      \"minutes\": 1900,\n      \"objects\": 400\n    }\n  },\n  \"queries_per_month\": 0\n}"

response = http.request(request)
puts response.read_body

{
  "placeholder_rates": true,
  "line_items": [
    {}
  ],
  "total_usd": 123,
  "batch_minimum_applied": true,
  "allowance_covered_usd": 123,
  "estimated_overage_usd": 123,
  "pricing_model": "v2",
  "allowance_pool_usd": 123,
  "overage_discount_pct": 0,
  "overage_discount_usd": 0,
  "manifest_quote": {
    "index_usd": 123,
    "monthly_usd": 123,
    "storage_usd": 123,
    "queries_usd": 123,
    "unit_prices": [
      {}
    ],
    "collections": [
      {}
    ],
    "unpriced_collections": [
      "<string>"
    ],
    "assumptions": [
      "<string>"
    ]
  }
}

{
  "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

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.

Body

application/json

Keys this body does not declare are refused with 422 extra_forbidden naming the accepted keys (since 2026-11-02).

items

EstimateItem · object[]

Planned content to ingest, priced per modality. Send this or manifest

Show child attributes

features

string[]

Feature keys to apply (see GET /v1/collections/features)

full_res

boolean

default:false

Opt out of mezzanine normalization (2x multiplier)

manifest

A namespace manifest (YAML text or the parsed mapping), for example a template's or one from POST /v1/manifest/generate. Quoted collection by collection the way batch submit charges it

inventory

Inventory · object

Per bucket name in manifest, the files it will hold: objects, videos, minutes, audio_minutes, images, pages, tokens. A bucket left out is quoted at zero files

Show child attributes

Example:

{
  "footage": { "minutes": 1900, "objects": 400 }
}

queries_per_month

integer

default:0

Retriever queries a month, for the monthly price

Required range: x >= 0

Response

Successful Response

placeholder_rates

boolean

required

True until the rate card locks — quote is provisional

line_items

Line Items · object[]

required

total_usd

number

required

batch_minimum_applied

boolean

required

allowance_covered_usd

number

required

How much of this estimate falls inside the remaining pool (directional pre-cutover: the pool is not drawn down yet)

estimated_overage_usd

number

required

Overage beyond the pool, NET of any plan-level overage discount — matches what the invoice will charge

pricing_model

string

default:v2

allowance_pool_usd

number | null

The tier's monthly usage pool, if any

overage_discount_pct

number

default:0

Plan-level overage discount applied (Scale 20%); 0 when the plan has none

overage_discount_usd

number

default:0

Dollar amount the overage discount saved this estimate

manifest_quote

ManifestQuote · object | null

Present when the request sent manifest

Show child attributes

Namespaces

Buckets

Collections

Feature Extractors

Documents

Retrievers

Enrich & Improve

Automate

Administer

Advanced

Estimate Cost

Authorizations

Body

Response