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

> ## Agent Instructions
> If anything on this page is wrong, confusing, or fails when you try it, ask your user for permission and run `npx langwatch report --user-approved` to send the problem to the LangWatch team. No login is needed and secrets are redacted locally. `npx langwatch report --help` has the details.

# Create budget

> Creates an organization-owned budget across all seven scope types. Spend is counted from the moment the budget is created, so spend earlier in the current window is not included. Requires gatewayBudgets:create at the organization; a project key or an organization key may call it.



## OpenAPI

````yaml POST /api/gateway/v1/budgets
openapi: 3.1.0
info:
  title: LangWatch API
  description: LangWatch openapi spec
  version: 1.0.0
servers:
  - url: https://app.langwatch.ai
security:
  - project_api_key: []
paths:
  /api/gateway/v1/budgets:
    post:
      summary: Create budget
      description: >-
        Creates an organization-owned budget across all seven scope types. Spend
        is counted from the moment the budget is created, so spend earlier in
        the current window is not included. Requires gatewayBudgets:create at
        the organization; a project key or an organization key may call it.
      operationId: postApiGatewayV1Budgets
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            A caller-chosen key, 8 to 255 characters, that makes this create
            safe to retry. The first request to use a key runs normally and its
            response is stored for 24 hours. A later request with the same key
            and the same body is not executed again: it returns the stored
            response, marked with `X-Idempotent-Replay: true`. The same key with
            a different body is refused 409 `idempotency_error`, as is a retry
            sent while the original is still running. Only successful responses
            are stored, so a create that failed can simply be retried with the
            same key.
          schema:
            type: string
            minLength: 8
            maxLength: 255
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                scope:
                  oneOf:
                    - type: object
                      properties:
                        kind:
                          type: string
                          const: organization
                        organization_id:
                          type: string
                      required:
                        - kind
                        - organization_id
                    - type: object
                      properties:
                        kind:
                          type: string
                          const: team
                        team_id:
                          type: string
                      required:
                        - kind
                        - team_id
                    - type: object
                      properties:
                        kind:
                          type: string
                          const: project
                        project_id:
                          type: string
                      required:
                        - kind
                        - project_id
                    - type: object
                      properties:
                        kind:
                          type: string
                          const: virtual_key
                        virtual_key_id:
                          type: string
                      required:
                        - kind
                        - virtual_key_id
                    - type: object
                      properties:
                        kind:
                          type: string
                          const: principal
                        principal_user_id:
                          type: string
                      required:
                        - kind
                        - principal_user_id
                    - type: object
                      properties:
                        kind:
                          type: string
                          const: group
                        group_id:
                          type: string
                      required:
                        - kind
                        - group_id
                    - type: object
                      properties:
                        kind:
                          type: string
                          const: attributed_user
                        anchor_virtual_key_id:
                          type: string
                        anchor_project_id:
                          type: string
                      required:
                        - kind
                name:
                  type: string
                  minLength: 1
                  maxLength: 128
                description:
                  type: string
                window:
                  type: string
                  enum:
                    - minute
                    - hour
                    - day
                    - week
                    - month
                    - total
                    - manual
                limit_usd:
                  anyOf:
                    - type: number
                      exclusiveMinimum: 0
                    - type: string
                      pattern: ^\d+(\.\d+)?$
                on_breach:
                  type: string
                  enum:
                    - block
                    - warn
                timezone:
                  type:
                    - string
                    - 'null'
                provider_key:
                  type:
                    - string
                    - 'null'
                external_id:
                  anyOf:
                    - type: string
                      minLength: 1
                      maxLength: 128
                    - type: 'null'
                metadata:
                  type: object
                  propertyNames:
                    type: string
                    minLength: 1
                    maxLength: 64
                  additionalProperties:
                    type: string
                    maxLength: 500
                cycle_anchor_at:
                  type: string
                  format: date-time
                  pattern: >-
                    ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                allow_unreachable:
                  type: boolean
              required:
                - scope
                - name
                - window
                - limit_usd
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  budget:
                    type: object
                    properties:
                      id:
                        type: string
                      organization_id:
                        type: string
                      scope_type:
                        type: string
                        enum:
                          - organization
                          - team
                          - project
                          - virtual_key
                          - principal
                          - group
                          - attributed_user
                      scope_id:
                        type: string
                      name:
                        type: string
                      description:
                        type:
                          - string
                          - 'null'
                      window:
                        type: string
                        enum:
                          - minute
                          - hour
                          - day
                          - week
                          - month
                          - total
                          - manual
                      on_breach:
                        type: string
                        enum:
                          - block
                          - warn
                      limit_usd:
                        type: string
                        description: >-
                          Display value. Decimal string, up to 9 fractional
                          digits, trailing zeros trimmed, never exponent
                          notation. Use limit_nano_usd for arithmetic.
                      limit_nano_usd:
                        anyOf:
                          - type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          - type: 'null'
                      spent_usd:
                        type:
                          - string
                          - 'null'
                      spent_nano_usd:
                        anyOf:
                          - type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          - type: 'null'
                      timezone:
                        type:
                          - string
                          - 'null'
                      provider_key:
                        type:
                          - string
                          - 'null'
                      external_id:
                        type:
                          - string
                          - 'null'
                      metadata:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties:
                          type: string
                      current_period_started_at:
                        type: string
                      resets_at:
                        type: string
                      cycle_anchor_at:
                        type:
                          - string
                          - 'null'
                      last_reset_at:
                        type:
                          - string
                          - 'null'
                      archived_at:
                        type:
                          - string
                          - 'null'
                      created_at:
                        type: string
                      member_count:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      end_users_seen:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      end_users_over:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      scope_reach:
                        type: string
                        enum:
                          - reachable
                          - unreachable
                    required:
                      - id
                      - organization_id
                      - scope_type
                      - scope_id
                      - name
                      - description
                      - window
                      - on_breach
                      - limit_usd
                      - limit_nano_usd
                      - spent_usd
                      - spent_nano_usd
                      - timezone
                      - provider_key
                      - external_id
                      - metadata
                      - current_period_started_at
                      - resets_at
                      - cycle_anchor_at
                      - last_reset_at
                      - archived_at
                      - created_at
                    additionalProperties: false
                required:
                  - budget
                additionalProperties: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  code:
                    type: string
                  message:
                    type: string
                  retryable:
                    type: boolean
                  meta:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
                  trace_id:
                    type: string
                  span_id:
                    type: string
                  trace:
                    type: object
                    properties:
                      traceId:
                        type: string
                      spanId:
                        type: string
                      traceUrl:
                        type: string
                      logsUrl:
                        type: string
                  tips:
                    type: array
                    items:
                      type: string
                  docs_url:
                    type: string
                  fault:
                    type: string
                    enum:
                      - customer
                      - platform
                      - provider
                      - presumed_platform
                  reasons:
                    type: array
                    items: {}
                required:
                  - type
                  - code
                  - message
                  - retryable
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  code:
                    type: string
                  message:
                    type: string
                  retryable:
                    type: boolean
                  meta:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
                  trace_id:
                    type: string
                  span_id:
                    type: string
                  trace:
                    type: object
                    properties:
                      traceId:
                        type: string
                      spanId:
                        type: string
                      traceUrl:
                        type: string
                      logsUrl:
                        type: string
                  tips:
                    type: array
                    items:
                      type: string
                  docs_url:
                    type: string
                  fault:
                    type: string
                    enum:
                      - customer
                      - platform
                      - provider
                      - presumed_platform
                  reasons:
                    type: array
                    items: {}
                required:
                  - type
                  - code
                  - message
                  - retryable
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  code:
                    type: string
                  message:
                    type: string
                  retryable:
                    type: boolean
                  meta:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
                  trace_id:
                    type: string
                  span_id:
                    type: string
                  trace:
                    type: object
                    properties:
                      traceId:
                        type: string
                      spanId:
                        type: string
                      traceUrl:
                        type: string
                      logsUrl:
                        type: string
                  tips:
                    type: array
                    items:
                      type: string
                  docs_url:
                    type: string
                  fault:
                    type: string
                    enum:
                      - customer
                      - platform
                      - provider
                      - presumed_platform
                  reasons:
                    type: array
                    items: {}
                required:
                  - type
                  - code
                  - message
                  - retryable
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  code:
                    type: string
                  message:
                    type: string
                  retryable:
                    type: boolean
                  meta:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
                  trace_id:
                    type: string
                  span_id:
                    type: string
                  trace:
                    type: object
                    properties:
                      traceId:
                        type: string
                      spanId:
                        type: string
                      traceUrl:
                        type: string
                      logsUrl:
                        type: string
                  tips:
                    type: array
                    items:
                      type: string
                  docs_url:
                    type: string
                  fault:
                    type: string
                    enum:
                      - customer
                      - platform
                      - provider
                      - presumed_platform
                  reasons:
                    type: array
                    items: {}
                required:
                  - type
                  - code
                  - message
                  - retryable
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  type:
                    type: string
                  code:
                    type: string
                  message:
                    type: string
                  retryable:
                    type: boolean
                  meta:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties: {}
                  trace_id:
                    type: string
                  span_id:
                    type: string
                  trace:
                    type: object
                    properties:
                      traceId:
                        type: string
                      spanId:
                        type: string
                      traceUrl:
                        type: string
                      logsUrl:
                        type: string
                  tips:
                    type: array
                    items:
                      type: string
                  docs_url:
                    type: string
                  fault:
                    type: string
                    enum:
                      - customer
                      - platform
                      - provider
                      - presumed_platform
                  reasons:
                    type: array
                    items: {}
                required:
                  - type
                  - code
                  - message
                  - retryable
      security:
        - project_api_key: []
components:
  securitySchemes:
    project_api_key:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: >-
        Project API key for sending traces and accessing project-scoped
        resources. Format: sk-lw-... (no underscore). Obtain one by creating a
        project via the Admin API or the LangWatch UI.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.