Bucket Batches

Estimate Batch Cost (pre-flight, dry-run)

Changed on

Pre-flight estimate of the credits a DRAFT batch will consume on submit, plus how many of its objects were already extracted — so a force/replace re-run that re-pays GPU extraction surfaces its cost BEFORE submitting. Does not consume credits or change the batch's contents/status; it DOES refresh a DRAFT batch's activity timestamp so the draft-TTL reaper grants a fresh grace window while you confirm the cost.

post/v1/buckets/{bucket_identifier}/batches/{batch_id}/estimate-cost

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/buckets/{bucket_identifier}/batches/{batch_id}/estimate-cost
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

bucket_identifierstring required

The unique identifier of the bucket.

batch_idstring required

The unique identifier of the batch.

Response

Successful Response

batch_idstring required
collection_idsstring[]
dedup_strategystring

skip | replace | force — controls re-extraction

object_countinteger

Objects this batch will process

already_extracted_countinteger

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

estimated_creditsinteger

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

estimated_usdnumber nullable

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

estimated_repay_creditsinteger

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

featuresstring[]

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

extractorsstring[]

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

content_summaryobject nullable

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

documents_to_removeinteger nullable

OPTIONAL. For dedup_strategy replace: the documents the batch's objects have now in its collections. A replace removes each of these that its re-run does not overwrite in place, after the new documents are written, so this is the most it removes. Absent for skip and force.

warningsstring[]

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • b75474e978ffRevision changes
    • info

      added the optional property to the response with the status