Skip to main content
POST
Estimate Batch Cost (pre-flight, dry-run)

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 header returns 403; an invalid or revoked key returns 401.

X-Namespace
string
header
required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

bucket_identifier
string
required

The unique identifier of the bucket.

batch_id
string
required

The unique identifier of the batch.

Response

Successful Response

Dry-run estimate of what submitting a DRAFT batch will cost + re-pay.

batch_id
string
required
collection_ids
string[]
dedup_strategy
string
default:skip

skip | replace | force — controls re-extraction

object_count
integer
default:0

Objects this batch will process

already_extracted_count
integer
default:0

Objects in this batch already extracted before (re-paid under force/replace)

estimated_credits
integer
default:0

Credits submitting this batch will consume (same calc as submit)

estimated_usd
number | null

Dollar cost of this batch under live v2 pricing (file type × amount × search-by features). Credits are milli-dollars of this value.

estimated_repay_credits
integer
default:0

~credits re-paying already-extracted objects (force/replace only; linear approx)

features
string[]

What this batch searches by (dimension 3 of pricing): feature keys billed per file type; custom plugins as 'custom:'.

extractors
string[]

Internal implementation of features — prefer rendering features; extractor names are the deeper disclosure layer.

content_summary
Content Summary · object | null

Dimensions 1+2 of pricing: file types and how much of each (counts, video minutes, pages, tokens…)

warnings
string[]