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

# Get Creation Allowance

> 2026 custom-processor CREATION allowance preview for the current team (§5).

The frontend reads this BEFORE creating a NEW processor to show the at-cap block
(Free / developer hard cap) or the one-time $5 confirmation (Team).

NOTE: the path is registered BEFORE /custom_pipelines/{lookup_key} so the literal
"creation-allowance" segment is matched by this route, not captured as a lookup_key.



## OpenAPI

````yaml https://www.datalab.to/openapi.json get /api/v1/custom_pipelines/creation-allowance
openapi: 3.1.0
info:
  title: Datalab API
  version: 0.0.1
servers:
  - url: https://www.datalab.to
    description: Datalab API
security: []
paths:
  /api/v1/custom_pipelines/creation-allowance:
    get:
      tags:
        - Custom Pipelines (Deprecated)
      summary: Get Creation Allowance
      description: >-
        2026 custom-processor CREATION allowance preview for the current team
        (§5).


        The frontend reads this BEFORE creating a NEW processor to show the
        at-cap block

        (Free / developer hard cap) or the one-time $5 confirmation (Team).


        NOTE: the path is registered BEFORE /custom_pipelines/{lookup_key} so
        the literal

        "creation-allowance" segment is matched by this route, not captured as a
        lookup_key.
      operationId: get_creation_allowance_api_v1_custom_pipelines_creation_allowance_get
      parameters:
        - name: wos-session
          in: cookie
          required: false
          schema:
            type: string
            title: Wos-Session
        - name: datalab_active_team
          in: cookie
          required: false
          schema:
            type: string
            title: Datalab Active Team
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomProcessorCreationAllowanceResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    CustomProcessorCreationAllowanceResponse:
      properties:
        creations_this_cycle:
          type: integer
          title: Creations This Cycle
          description: Successful NEW-processor creations counted this billing month
        limit:
          type: integer
          title: Limit
          description: >-
            Included creations per month for the team's plan (or per-team
            override)
        at_cap:
          type: boolean
          title: At Cap
          description: >-
            True when a hard-cap plan has used all its included creations (next
            creation is blocked with 402)
        will_incur_fee:
          type: boolean
          title: Will Incur Fee
          description: >-
            True when the next creation would incur the one-time overage fee
            (Team)
        fee_cents:
          type: integer
          title: Fee Cents
          description: >-
            The one-time fee in cents the next creation would incur (0 when
            within the allowance or hard-capped)
        overage_unit_fee_cents:
          type: integer
          title: Overage Unit Fee Cents
          description: >-
            The plan's per-extra-creation fee in cents regardless of current
            count (0 for hard-cap plans) — lets the UI state the overage policy
            up front
          default: 0
        plan:
          anyOf:
            - type: string
            - type: 'null'
          title: Plan
          description: >-
            The plan whose limits apply (the team's active API plan, else
            'free')
        cycle_resets_at:
          type: string
          title: Cycle Resets At
          description: ISO timestamp when the monthly creation count resets
      type: object
      required:
        - creations_this_cycle
        - limit
        - at_cap
        - will_incur_fee
        - fee_cents
        - cycle_resets_at
      title: CustomProcessorCreationAllowanceResponse
      description: >-
        2026 custom-processor CREATION allowance preview for the current team
        (§5).


        The frontend uses this BEFORE creating a NEW processor to show the
        at-cap block (Free

        / developer hard cap) or the one-time $5 confirmation (Team).
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````