OpenAI Spend alerts API

openapi: 3.2.0
info:
  title: OpenAI Spend alerts API
  description: The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
  version: 2.3.0
  termsOfService: https://openai.com/policies/terms-of-use
  contact:
    name: OpenAI Support
    url: https://help.openai.com/
  license:
    name: MIT
    identifier: MIT
servers:
- url: https://api.openai.com/v1
security:
- ApiKeyAuth: []
tags:
- name: Spend alerts
paths:
  /organization/projects/{project_id}/spend_alerts:
    get:
      security:
      - AdminApiKeyAuth: []
      summary: List project spend alerts
      description: Lists project spend alerts.
      operationId: list-project-spend-alerts
      tags:
      - Spend alerts
      parameters:
      - name: project_id
        in: path
        description: The ID of the project to inspect.
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: A limit on the number of spend alerts to return. Defaults to 20.
        required: false
        schema:
          type: integer
          minimum: 0
          maximum: 100
      - name: order
        in: query
        description: Sort order for the returned spend alerts.
        required: false
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      - name: after
        in: query
        description: Cursor for pagination. Provide the ID of the last spend alert from the previous response to fetch the next page.
        required: false
        schema:
          type: string
      - name: before
        in: query
        description: Cursor for pagination. Provide the ID of the first spend alert from the previous response to fetch the previous page.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Project spend alerts listed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectSpendAlertListResource'
      x-oaiMeta:
        group: administration
        examples:
          request:
            curl: "curl https://api.openai.com/v1/organization/projects/proj_abc/spend_alerts?limit=20&order=asc \\\n  -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n  -H \"Content-Type: application/json\"\n"
          response: "{\n    \"object\": \"list\",\n    \"data\": [\n        {\n            \"id\": \"alert_abc123\",\n            \"object\": \"project.spend_alert\",\n            \"threshold_amount\": 100000,\n            \"currency\": \"USD\",\n            \"interval\": \"month\",\n            \"notification_channel\": {\n                \"type\": \"email\",\n                \"recipients\": [\"finance@example.com\"],\n                \"subject_prefix\": \"OpenAI spend alert\"\n            }\n        }\n    ],\n    \"first_id\": \"alert_abc123\",\n    \"last_id\": \"alert_abc123\",\n    \"has_more\": false\n}\n"
    post:
      security:
      - AdminApiKeyAuth: []
      summary: Create project spend alert
      description: Creates a project spend alert.
      operationId: create-project-spend-alert
      tags:
      - Spend alerts
      parameters:
      - name: project_id
        in: path
        description: The ID of the project to update.
        required: true
        schema:
          type: string
      requestBody:
        description: Parameters for the project spend alert you want to create.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSpendAlertBody'
      responses:
        '200':
          description: Project spend alert created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectSpendAlert'
      x-oaiMeta:
        group: administration
        examples:
          request:
            curl: "curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/spend_alerts \\\n  -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n      \"threshold_amount\": 100000,\n      \"currency\": \"USD\",\n      \"interval\": \"month\",\n      \"notification_channel\": {\n          \"type\": \"email\",\n          \"recipients\": [\"finance@example.com\"],\n          \"subject_prefix\": \"OpenAI spend alert\"\n      }\n  }'\n"
          response: "{\n    \"id\": \"alert_abc123\",\n    \"object\": \"project.spend_alert\",\n    \"threshold_amount\": 100000,\n    \"currency\": \"USD\",\n    \"interval\": \"month\",\n    \"notification_channel\": {\n        \"type\": \"email\",\n        \"recipients\": [\"finance@example.com\"],\n        \"subject_prefix\": \"OpenAI spend alert\"\n    }\n}\n"
  /organization/projects/{project_id}/spend_alerts/{alert_id}:
    get:
      security:
      - AdminApiKeyAuth: []
      summary: Retrieve project spend alert
      description: Retrieves a project spend alert.
      operationId: retrieve-project-spend-alert
      tags:
      - Spend alerts
      parameters:
      - name: project_id
        in: path
        description: The ID of the project.
        required: true
        schema:
          type: string
      - name: alert_id
        in: path
        description: The ID of the spend alert to retrieve.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Project spend alert retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectSpendAlert'
      x-oaiMeta:
        group: administration
        examples:
          request:
            curl: "curl https://api.openai.com/v1/organization/projects/proj_abc/spend_alerts/alert_abc123 \\\n  -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n  -H \"Content-Type: application/json\"\n"
          response: "{\n    \"id\": \"alert_abc123\",\n    \"object\": \"project.spend_alert\",\n    \"threshold_amount\": 150000,\n    \"currency\": \"USD\",\n    \"interval\": \"month\",\n    \"notification_channel\": {\n        \"type\": \"email\",\n        \"recipients\": [\"finance@example.com\"],\n        \"subject_prefix\": \"OpenAI spend alert\"\n    }\n}\n"
    post:
      security:
      - AdminApiKeyAuth: []
      summary: Update project spend alert
      description: Updates a project spend alert.
      operationId: update-project-spend-alert
      tags:
      - Spend alerts
      parameters:
      - name: project_id
        in: path
        description: The ID of the project to update.
        required: true
        schema:
          type: string
      - name: alert_id
        in: path
        description: The ID of the spend alert to update.
        required: true
        schema:
          type: string
      requestBody:
        description: Fields to update on the project spend alert.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSpendAlertBody'
      responses:
        '200':
          description: Project spend alert updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectSpendAlert'
      x-oaiMeta:
        group: administration
        examples:
          request:
            curl: "curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/spend_alerts/alert_abc123 \\\n  -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n      \"threshold_amount\": 150000,\n      \"currency\": \"USD\",\n      \"interval\": \"month\",\n      \"notification_channel\": {\n          \"type\": \"email\",\n          \"recipients\": [\"finance@example.com\"],\n          \"subject_prefix\": \"OpenAI spend alert\"\n      }\n  }'\n"
          response: "{\n    \"id\": \"alert_abc123\",\n    \"object\": \"project.spend_alert\",\n    \"threshold_amount\": 150000,\n    \"currency\": \"USD\",\n    \"interval\": \"month\",\n    \"notification_channel\": {\n        \"type\": \"email\",\n        \"recipients\": [\"finance@example.com\"],\n        \"subject_prefix\": \"OpenAI spend alert\"\n    }\n}\n"
    delete:
      security:
      - AdminApiKeyAuth: []
      summary: Delete project spend alert
      description: Deletes a project spend alert.
      operationId: delete-project-spend-alert
      tags:
      - Spend alerts
      parameters:
      - name: project_id
        in: path
        description: The ID of the project to update.
        required: true
        schema:
          type: string
      - name: alert_id
        in: path
        description: The ID of the spend alert to delete.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Project spend alert deleted successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectSpendAlertDeletedResource'
      x-oaiMeta:
        group: administration
        examples:
          request:
            curl: "curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/spend_alerts/alert_abc123 \\\n  -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n  -H \"Content-Type: application/json\"\n"
          response: "{\n    \"id\": \"alert_abc123\",\n    \"object\": \"project.spend_alert.deleted\",\n    \"deleted\": true\n}\n"
  /organization/spend_alerts:
    get:
      security:
      - AdminApiKeyAuth: []
      summary: List organization spend alerts
      description: Lists organization spend alerts.
      operationId: list-organization-spend-alerts
      tags:
      - Spend alerts
      parameters:
      - name: limit
        in: query
        description: A limit on the number of spend alerts to return. Defaults to 20.
        required: false
        schema:
          type: integer
          minimum: 0
          maximum: 100
      - name: order
        in: query
        description: Sort order for the returned spend alerts.
        required: false
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      - name: after
        in: query
        description: Cursor for pagination. Provide the ID of the last spend alert from the previous response to fetch the next page.
        required: false
        schema:
          type: string
      - name: before
        in: query
        description: Cursor for pagination. Provide the ID of the first spend alert from the previous response to fetch the previous page.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Organization spend alerts listed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationSpendAlertListResource'
      x-oaiMeta:
        group: administration
        examples:
          request:
            curl: "curl https://api.openai.com/v1/organization/spend_alerts?limit=20&order=asc \\\n  -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n  -H \"Content-Type: application/json\"\n"
          response: "{\n    \"object\": \"list\",\n    \"data\": [\n        {\n            \"id\": \"alert_abc123\",\n            \"object\": \"organization.spend_alert\",\n            \"threshold_amount\": 100000,\n            \"currency\": \"USD\",\n            \"interval\": \"month\",\n            \"notification_channel\": {\n                \"type\": \"email\",\n                \"recipients\": [\"finance@example.com\"],\n                \"subject_prefix\": \"OpenAI spend alert\"\n            }\n        }\n    ],\n    \"first_id\": \"alert_abc123\",\n    \"last_id\": \"alert_abc123\",\n    \"has_more\": false\n}\n"
    post:
      security:
      - AdminApiKeyAuth: []
      summary: Create organization spend alert
      description: Creates an organization spend alert.
      operationId: create-organization-spend-alert
      tags:
      - Spend alerts
      requestBody:
        description: Parameters for the organization spend alert you want to create.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSpendAlertBody'
      responses:
        '200':
          description: Organization spend alert created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationSpendAlert'
      x-oaiMeta:
        group: administration
        examples:
          request:
            curl: "curl -X POST https://api.openai.com/v1/organization/spend_alerts \\\n  -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n      \"threshold_amount\": 100000,\n      \"currency\": \"USD\",\n      \"interval\": \"month\",\n      \"notification_channel\": {\n          \"type\": \"email\",\n          \"recipients\": [\"finance@example.com\"],\n          \"subject_prefix\": \"OpenAI spend alert\"\n      }\n  }'\n"
          response: "{\n    \"id\": \"alert_abc123\",\n    \"object\": \"organization.spend_alert\",\n    \"threshold_amount\": 100000,\n    \"currency\": \"USD\",\n    \"interval\": \"month\",\n    \"notification_channel\": {\n        \"type\": \"email\",\n        \"recipients\": [\"finance@example.com\"],\n        \"subject_prefix\": \"OpenAI spend alert\"\n    }\n}\n"
  /organization/spend_alerts/{alert_id}:
    get:
      security:
      - AdminApiKeyAuth: []
      summary: Retrieve organization spend alert
      description: Retrieves an organization spend alert.
      operationId: retrieve-organization-spend-alert
      tags:
      - Spend alerts
      parameters:
      - name: alert_id
        in: path
        description: The ID of the spend alert to retrieve.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Organization spend alert retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationSpendAlert'
      x-oaiMeta:
        group: administration
        examples:
          request:
            curl: "curl https://api.openai.com/v1/organization/spend_alerts/alert_abc123 \\\n  -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n  -H \"Content-Type: application/json\"\n"
          response: "{\n    \"id\": \"alert_abc123\",\n    \"object\": \"organization.spend_alert\",\n    \"threshold_amount\": 150000,\n    \"currency\": \"USD\",\n    \"interval\": \"month\",\n    \"notification_channel\": {\n        \"type\": \"email\",\n        \"recipients\": [\"finance@example.com\"],\n        \"subject_prefix\": \"OpenAI spend alert\"\n    }\n}\n"
    post:
      security:
      - AdminApiKeyAuth: []
      summary: Update organization spend alert
      description: Updates an organization spend alert.
      operationId: update-organization-spend-alert
      tags:
      - Spend alerts
      parameters:
      - name: alert_id
        in: path
        description: The ID of the spend alert to update.
        required: true
        schema:
          type: string
      requestBody:
        description: Fields to update on the organization spend alert.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSpendAlertBody'
      responses:
        '200':
          description: Organization spend alert updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationSpendAlert'
      x-oaiMeta:
        group: administration
        examples:
          request:
            curl: "curl -X POST https://api.openai.com/v1/organization/spend_alerts/alert_abc123 \\\n  -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n      \"threshold_amount\": 150000,\n      \"currency\": \"USD\",\n      \"interval\": \"month\",\n      \"notification_channel\": {\n          \"type\": \"email\",\n          \"recipients\": [\"finance@example.com\"],\n          \"subject_prefix\": \"OpenAI spend alert\"\n      }\n  }'\n"
          response: "{\n    \"id\": \"alert_abc123\",\n    \"object\": \"organization.spend_alert\",\n    \"threshold_amount\": 150000,\n    \"currency\": \"USD\",\n    \"interval\": \"month\",\n    \"notification_channel\": {\n        \"type\": \"email\",\n        \"recipients\": [\"finance@example.com\"],\n        \"subject_prefix\": \"OpenAI spend alert\"\n    }\n}\n"
    delete:
      security:
      - AdminApiKeyAuth: []
      summary: Delete organization spend alert
      description: Deletes an organization spend alert.
      operationId: delete-organization-spend-alert
      tags:
      - Spend alerts
      parameters:
      - name: alert_id
        in: path
        description: The ID of the spend alert to delete.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Organization spend alert deleted successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationSpendAlertDeletedResource'
      x-oaiMeta:
        group: administration
        examples:
          request:
            curl: "curl -X DELETE https://api.openai.com/v1/organization/spend_alerts/alert_abc123 \\\n  -H \"Authorization: Bearer $OPENAI_ADMIN_KEY\" \\\n  -H \"Content-Type: application/json\"\n"
          response: "{\n    \"id\": \"alert_abc123\",\n    \"object\": \"organization.spend_alert.deleted\",\n    \"deleted\": true\n}\n"
components:
  schemas:
    OrganizationSpendAlertDeletedResource:
      type: object
      description: Confirmation payload returned after deleting an organization spend alert.
      properties:
        id:
          type: string
          description: The deleted spend alert ID.
        object:
          type: string
          enum:
          - organization.spend_alert.deleted
          description: Always `organization.spend_alert.deleted`.
          x-stainless-const: true
        deleted:
          type: boolean
          description: Whether the spend alert was deleted.
      required:
      - id
      - object
      - deleted
    SpendAlertNotificationChannel:
      type: object
      description: Email notification settings for a spend alert.
      properties:
        type:
          type: string
          enum:
          - email
          description: The notification channel type. Currently only `email` is supported.
          x-stainless-const: true
        recipients:
          type: array
          description: Email addresses that receive the spend alert notification.
          items:
            type: string
        subject_prefix:
          anyOf:
          - type: string
          - type: 'null'
          description: Optional subject prefix for alert emails.
      required:
      - type
      - recipients
    CreateSpendAlertBody:
      type: object
      description: Parameters for creating or updating a spend alert.
      properties:
        threshold_amount:
          type: integer
          minimum: 0
          description: The alert threshold amount, in cents.
        currency:
          type: string
          enum:
          - USD
          description: The currency for the threshold amount.
        interval:
          type: string
          enum:
          - month
          description: The time interval for evaluating spend against the threshold.
        notification_channel:
          $ref: '#/components/schemas/SpendAlertNotificationChannel'
      required:
      - threshold_amount
      - currency
      - interval
      - notification_channel
    ProjectSpendAlert:
      type: object
      description: Represents a spend alert configured at the project level.
      properties:
        id:
          type: string
          description: The identifier, which can be referenced in API endpoints.
        object:
          type: string
          enum:
          - project.spend_alert
          description: The object type, which is always `project.spend_alert`.
          x-stainless-const: true
        threshold_amount:
          type: integer
          description: The alert threshold amount, in cents.
        currency:
          type: string
          enum:
          - USD
          description: The currency for the threshold amount.
        interval:
          type: string
          enum:
          - month
          description: The time interval for evaluating spend against the threshold.
        notification_channel:
          $ref: '#/components/schemas/SpendAlertNotificationChannel'
      required:
      - id
      - object
      - threshold_amount
      - currency
      - interval
      - notification_channel
      x-oaiMeta:
        name: The project spend alert object
        example: "{\n    \"id\": \"alert_abc123\",\n    \"object\": \"project.spend_alert\",\n    \"threshold_amount\": 100000,\n    \"currency\": \"USD\",\n    \"interval\": \"month\",\n    \"notification_channel\": {\n        \"type\": \"email\",\n        \"recipients\": [\"finance@example.com\"],\n        \"subject_prefix\": \"OpenAI spend alert\"\n    }\n}\n"
    OrganizationSpendAlert:
      type: object
      description: Represents a spend alert configured at the organization level.
      properties:
        id:
          type: string
          description: The identifier, which can be referenced in API endpoints.
        object:
          type: string
          enum:
          - organization.spend_alert
          description: The object type, which is always `organization.spend_alert`.
          x-stainless-const: true
        threshold_amount:
          type: integer
          description: The alert threshold amount, in cents.
        currency:
          type: string
          enum:
          - USD
          description: The currency for the threshold amount.
        interval:
          type: string
          enum:
          - month
          description: The time interval for evaluating spend against the threshold.
        notification_channel:
          $ref: '#/components/schemas/SpendAlertNotificationChannel'
      required:
      - id
      - object
      - threshold_amount
      - currency
      - interval
      - notification_channel
      x-oaiMeta:
        name: The organization spend alert object
        example: "{\n    \"id\": \"alert_abc123\",\n    \"object\": \"organization.spend_alert\",\n    \"threshold_amount\": 100000,\n    \"currency\": \"USD\",\n    \"interval\": \"month\",\n    \"notification_channel\": {\n        \"type\": \"email\",\n        \"recipients\": [\"finance@example.com\"],\n        \"subject_prefix\": \"OpenAI spend alert\"\n    }\n}\n"
    ProjectSpendAlertDeletedResource:
      type: object
      description: Confirmation payload returned after deleting a project spend alert.
      properties:
        id:
          type: string
          description: The deleted spend alert ID.
        object:
          type: string
          enum:
          - project.spend_alert.deleted
          description: Always `project.spend_alert.deleted`.
          x-stainless-const: true
        deleted:
          type: boolean
          description: Whether the spend alert was deleted.
      required:
      - id
      - object
      - deleted
    OrganizationSpendAlertListResource:
      type: object
      description: Paginated list of organization spend alerts.
      properties:
        object:
          type: string
          enum:
          - list
          description: Always `list`.
          x-stainless-const: true
        data:
          type: array
          description: Spend alerts returned in the current page.
          items:
            $ref: '#/components/schemas/OrganizationSpendAlert'
        first_id:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the first spend alert in this page.
        last_id:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the last spend alert in this page.
        has_more:
          type: boolean
          description: Whether more spend alerts are available when paginating.
      required:
      - object
      - data
      - first_id
      - last_id
      - has_more
    ProjectSpendAlertListResource:
      type: object
      description: Paginated list of project spend alerts.
      properties:
        object:
          type: string
          enum:
          - list
          description: Always `list`.
          x-stainless-const: true
        data:
          type: array
          description: Spend alerts returned in the current page.
          items:
            $ref: '#/components/schemas/ProjectSpendAlert'
        first_id:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the first spend alert in this page.
        last_id:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the last spend alert in this page.
        has_more:
          type: boolean
          description: Whether more spend alerts are available when paginating.
      required:
      - object
      - data
      - first_id
      - last_id
      - has_more
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
    AdminApiKeyAuth:
      type: http
      scheme: bearer
x-oaiMeta:
  navigationGroups:
  - id: responses
    title: Responses API
  - id: webhooks
    title: Webhooks
  - id: endpoints
    title: Platform APIs
  - id: vector_stores
    title: Vector stores
  - id: chatkit
    title: ChatKit
    beta: true
  - id: containers
    title: Containers
  - id: live
    title: Live (alpha)
  - id: realtime
    title: Realtime
  - id: chat
    title: Chat Completions
  - id: assistants
    title: Assistants
    deprecated: true
  - id: administration
    title: Administration
  - id: legacy
    title: Legacy
  groups:
  - id: responses-streaming
    title: Streaming events
    description: 'When you [create a Response](https://developers.openai.com/api/reference/resources/responses/methods/create) with

      `stream` set to `true`, the server will emit server-sent events to the

      client as the Response is generated. This section contains the events that

      are emitted by the server.


      When processing a `compaction_trigger`, `response.compaction.compacting`

      reports newly sampled summary output at most once every 30 seconds. It

      carries no summary content and does not modify the compaction output item.

      The existing `response.output_item.added` and `response.output_item.done`

      events mark that item''s lifecycle; `response.output_item.done` carries its

      final encrypted content. A short compaction may finish without emitting a

      progress event.


      [Learn more about streaming responses](https://developers.openai.com/api/docs/guides/streaming-responses).

      '
    navigationGroup: responses
    sections:
    - type: object
      key: ResponseCreatedEvent
      path: <auto>
    - type: object
      key: ResponseInProgressEvent
      path: <auto>
    - type: object
      key: ResponseCompletedEvent
      path: <auto>
    - type: object
      key: ResponseFailedEvent
      path: <auto>
    - type: object
      key: ResponseIncompleteEvent
      path: <auto>
    - type: object
      key: ResponseOutputItemAddedEvent
      path: <auto>
    - type: object
      key: ResponseOutputItemDoneEvent
      path: <auto>
    - type: object
      key: ResponseCompactionCompactingEvent
      path: <auto>
    - type: object
      key: ResponseContentPartAddedEvent
      path: <auto>
    - type: object
      key: ResponseContentPartDoneEvent
      path: <auto>
    - type: object
      key: ResponseTextDeltaEvent
      path: response/output_text/delta
    - type: object
      key: ResponseTextDoneEvent
      path: response/output_text/done
    - type: object
      key: ResponseRefusalDeltaEvent
      path: <auto>
    - type: object
      key: ResponseRefusalDoneEvent
      path: <auto>
    - type: object
      key: ResponseFunctionCallArgumentsDeltaEvent
      path: <auto>
    - type: object
      key: ResponseFunctionCallArgumentsDoneEvent
      path: <auto>
    - type: object
      key: ResponseFileSearchCallInProgressEvent
      path: <auto>
    - type: object
      key: ResponseFileSearchCallSearchingEvent
      path: <auto>
    - type: object
      key: ResponseFileSearchCallCompletedEvent
      path: <auto>
    - type: object
      key: ResponseWebSearchCallInProgressEvent
      path: <auto>
    - type: object
      key: ResponseWebSearchCallSearchingEvent
      path: <auto>
    - type: object
      key: ResponseWebSearchCallCompletedEvent
      path: <auto>
    - type: object
      key: ResponseReasoningSummaryPartAddedEvent
      path: <auto>
    - type: object
      key: ResponseReasoningSummaryPartDoneEvent
      path: <auto>
    - type: object
      key: ResponseReasoningSummaryTextDeltaEvent
      path: <auto>
    - type: object
      key: ResponseReasoningSummaryTextDoneEvent
      path: <auto>
    - type: object
      key: ResponseReasoningTextDeltaEvent
      path: <auto>
    - type: object
      key: ResponseReasoningTextDoneEvent
      path: <auto>
    - type: object
      key: ResponseImageGenCallCompletedEvent
      path: <auto>
    - type: object
      key: ResponseImageGenCallGeneratingEvent
      path: <auto>
    - type: object
      key: ResponseImageGenCallInProgressEvent
      path: <auto>
    - type: object
      key: ResponseImageGenCallPartialImageEvent
      path: <auto>
    - type: object
      key: ResponseMCPCallArgumentsDeltaEvent
      path: <auto>
    - type: object
      key: ResponseMCPCallArgumentsDoneEvent
      path: <auto>
    - type: object
      key: ResponseMCPCallCompletedEvent
      path: <auto>
    - type: object
      key: ResponseMCPCallFailedEvent
      path: <auto>
    - type: object
      key: ResponseMCPCallInProgressEvent
      path: <auto>
    - type: object
      key: ResponseMCPListToolsCompletedEvent
      path: <auto>
    - type: object
      key: ResponseMCPListToolsFailedEvent
      path: <auto>
    - type: object
      key: ResponseMCPListToolsInProgressEvent
      path: <auto>
    - type: object
      key: ResponseCodeInterpreterCallInProgressEvent
      path: <auto>
    - type: object
      key: ResponseCodeInterpreterCallInterpretingEvent
      path: <auto>
    - type: object
      key: ResponseCodeInterpreterCallCompletedEvent
      path: <auto>
    - type: object
      key: ResponseCodeInterpreterCallCodeDeltaEvent
      path: <auto>
    - type: object
      key: ResponseCodeInterpreterCallCodeDoneEvent
      path: <auto>
    - type: object
      key: ResponseOutputTextAnnotationAddedEvent
      path: <auto>
    - type: object
      key: ResponseQueuedEvent
      path: <auto>
    - type: object
      key: ResponseCustomToolCallInputDeltaEvent
      path: <auto>
    - type: object
      key: ResponseCustomToolCallInputDoneEvent
      path: <auto>
    - type: object
      key: ResponseErrorEvent
      path: <auto>
  - id: responses-websocket-client-events
    title: Client events
    description: 'Events sent by the client over a Responses API WebSocket connection.

      '
    navigationGroup: responses
    sections:
    - type: object
      key: ResponsesClientEventResponseCreate
      path: <auto>
    - type: object
      key: ResponseSteerEvent
      path: <auto>
  - id: responses-websocket-server-events
    title: Server events (WebSocket only)
    description: 'Events emitted only over a Responses API WebSocket connection.

      '
    navigationGroup: responses
    sections:
    - type: object
      key: ResponseSteerAcceptedEvent
      path: <auto>
    - type: object
      key: ResponseSteerPendingEvent
      path: <auto>
    - type: object
      key: ResponseSteerFailedEvent
      path: <auto>


# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openai/refs/heads/main/openapi/openai-spend-alerts-api-openapi.yml