> ## 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 Cost

> Quote the v2 cost of planned ingestion before submitting it.

Forgiving by design: unknown MIME types quote at the cheapest band;
wrong unit fields and inapplicable features return teaching errors.


## OpenAPI

````yaml post /v1/organizations/billing/estimate
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/organizations/billing/estimate:
    post:
      tags:
        - Organization Billing
      summary: Estimate Cost
      description: |-
        Quote the v2 cost of planned ingestion before submitting it.

        Forgiving by design: unknown MIME types quote at the cheapest band;
        wrong unit fields and inapplicable features return teaching errors.
      operationId: estimate_cost_v1_organizations_billing_estimate_post
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EstimateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EstimateResponse'
        '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: []
components:
  schemas:
    EstimateRequest:
      properties:
        items:
          items:
            $ref: '#/components/schemas/EstimateItem'
          type: array
          title: Items
          description: Planned content to ingest
        features:
          items:
            type: string
          type: array
          title: Features
          description: Feature keys to apply (see GET /v1/collections/features)
        full_res:
          type: boolean
          title: Full Res
          description: Opt out of mezzanine normalization (2x multiplier)
          default: false
      type: object
      required:
        - items
      title: EstimateRequest
    EstimateResponse:
      properties:
        pricing_model:
          type: string
          title: Pricing Model
          default: v2
        placeholder_rates:
          type: boolean
          title: Placeholder Rates
          description: True until the rate card locks — quote is provisional
        line_items:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Line Items
        total_usd:
          type: number
          title: Total Usd
        batch_minimum_applied:
          type: boolean
          title: Batch Minimum Applied
        allowance_pool_usd:
          anyOf:
            - type: number
            - type: 'null'
          title: Allowance Pool Usd
          description: The tier's monthly usage pool, if any
        allowance_covered_usd:
          type: number
          title: Allowance Covered Usd
          description: >-
            How much of this estimate falls inside the remaining pool
            (directional pre-cutover: the pool is not drawn down yet)
        estimated_overage_usd:
          type: number
          title: Estimated Overage Usd
          description: >-
            Overage beyond the pool, NET of any plan-level overage discount —
            matches what the invoice will charge
        overage_discount_pct:
          type: number
          title: Overage Discount Pct
          description: >-
            Plan-level overage discount applied (Scale 20%); 0 when the plan has
            none
          default: 0
        overage_discount_usd:
          type: number
          title: Overage Discount Usd
          description: Dollar amount the overage discount saved this estimate
          default: 0
      type: object
      required:
        - placeholder_rates
        - line_items
        - total_usd
        - batch_minimum_applied
        - allowance_covered_usd
        - estimated_overage_usd
      title: EstimateResponse
    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
    EstimateItem:
      properties:
        mime_type:
          type: string
          title: Mime Type
          description: MIME type (or registry input type) of the planned content
        count:
          anyOf:
            - type: number
            - type: 'null'
          title: Count
          description: Unit count (images, web pages)
        minutes:
          anyOf:
            - type: number
            - type: 'null'
          title: Minutes
          description: Duration (video/audio)
        pages:
          anyOf:
            - type: number
            - type: 'null'
          title: Pages
          description: Page count (documents)
        tokens:
          anyOf:
            - type: number
            - type: 'null'
          title: Tokens
          description: Token count (text)
        units:
          anyOf:
            - type: number
            - type: 'null'
          title: Units
          description: Generic unit count (accepted for any modality)
      type: object
      required:
        - mime_type
      title: EstimateItem
    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.

````