> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

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

> 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.



## OpenAPI

````yaml post /v1/buckets/{bucket_identifier}/batches/{batch_id}/estimate-cost
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security:
  - BearerAuth: []
paths:
  /v1/buckets/{bucket_identifier}/batches/{batch_id}/estimate-cost:
    post:
      tags:
        - Bucket Batches
      summary: Estimate Batch Cost (pre-flight, dry-run)
      description: >-
        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.
      operationId: >-
        estimate_batch_cost_endpoint_v1_buckets__bucket_identifier__batches__batch_id__estimate_cost_post
      parameters:
        - name: bucket_identifier
          in: path
          required: true
          schema:
            type: string
            description: The unique identifier of the bucket.
            title: Bucket Identifier
          description: The unique identifier of the bucket.
        - name: batch_id
          in: path
          required: true
          schema:
            type: string
            description: The unique identifier of the batch.
            title: Batch Id
          description: The unique identifier of the batch.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchCostEstimate'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
          NamespaceHeader: []
components:
  schemas:
    BatchCostEstimate:
      properties:
        batch_id:
          type: string
          title: Batch Id
        collection_ids:
          items:
            type: string
          type: array
          title: Collection Ids
        dedup_strategy:
          type: string
          title: Dedup Strategy
          description: skip | replace | force — controls re-extraction
          default: skip
        object_count:
          type: integer
          title: Object Count
          description: Objects this batch will process
          default: 0
        already_extracted_count:
          type: integer
          title: Already Extracted Count
          description: >-
            Objects in this batch already extracted before (re-paid under
            force/replace)
          default: 0
        estimated_credits:
          type: integer
          title: Estimated Credits
          description: Credits submitting this batch will consume (same calc as submit)
          default: 0
        estimated_usd:
          anyOf:
            - type: number
            - type: 'null'
          title: Estimated Usd
          description: >-
            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:
          type: integer
          title: Estimated Repay Credits
          description: >-
            ~credits re-paying already-extracted objects (force/replace only;
            linear approx)
          default: 0
        features:
          items:
            type: string
          type: array
          title: Features
          description: >-
            What this batch searches by (dimension 3 of pricing): feature keys
            billed per file type; custom plugins as 'custom:<name>'.
        extractors:
          items:
            type: string
          type: array
          title: Extractors
          description: >-
            Internal implementation of `features` — prefer rendering `features`;
            extractor names are the deeper disclosure layer.
        content_summary:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Content Summary
          description: >-
            Dimensions 1+2 of pricing: file types and how much of each (counts,
            video minutes, pages, tokens…)
        warnings:
          items:
            type: string
          type: array
          title: Warnings
      type: object
      required:
        - batch_id
      title: BatchCostEstimate
      description: Dry-run estimate of what submitting a DRAFT batch will cost + re-pay.
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        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.
    NamespaceHeader:
      type: apiKey
      in: header
      name: X-Namespace
      description: >-
        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`.

````