anyllm-proxy/docs/openai-spec-condensed.yaml

# OpenAI API - Condensed Spec
# Source: openai/openai-openapi (manual_spec branch)
# Version: 2.3.0
# Generated: 2026-03-22T00:33:23Z
# Endpoints: 148 total, 148 included
# Schemas: 477 total, 477 included
endpoints:
- method: GET
  path: /assistants
  operation_id: listAssistants
  summary: Returns a list of assistants.
  tags:
  - Assistants
  parameters:
  - name: limit
    in: query
    type: integer
  - name: order
    in: query
    type: string
  - name: after
    in: query
    type: string
  - name: before
    in: query
    type: string
  responses:
    '200': $ListAssistantsResponse
- method: POST
  path: /assistants
  operation_id: createAssistant
  summary: Create an assistant with a model and instructions.
  tags:
  - Assistants
  request_body: $CreateAssistantRequest
  responses:
    '200': $AssistantObject
- method: GET
  path: /assistants/{assistant_id}
  operation_id: getAssistant
  summary: Retrieves an assistant.
  tags:
  - Assistants
  parameters:
  - name: assistant_id
    in: path
    type: string
    required: true
  responses:
    '200': $AssistantObject
- method: POST
  path: /assistants/{assistant_id}
  operation_id: modifyAssistant
  summary: Modifies an assistant.
  tags:
  - Assistants
  parameters:
  - name: assistant_id
    in: path
    type: string
    required: true
  request_body: $ModifyAssistantRequest
  responses:
    '200': $AssistantObject
- method: DELETE
  path: /assistants/{assistant_id}
  operation_id: deleteAssistant
  summary: Delete an assistant.
  tags:
  - Assistants
  parameters:
  - name: assistant_id
    in: path
    type: string
    required: true
  responses:
    '200': $DeleteAssistantResponse
- method: POST
  path: /audio/speech
  operation_id: createSpeech
  summary: Generates audio from the input text.
  tags:
  - Audio
  request_body: $CreateSpeechRequest
- method: POST
  path: /audio/transcriptions
  operation_id: createTranscription
  summary: Transcribes audio into the input language.
  tags:
  - Audio
  request_body: $CreateTranscriptionRequest
- method: POST
  path: /audio/translations
  operation_id: createTranslation
  summary: Translates audio into English.
  tags:
  - Audio
  request_body: $CreateTranslationRequest
- method: GET
  path: /batches
  operation_id: listBatches
  summary: List your organization's batches.
  tags:
  - Batch
  parameters:
  - name: after
    in: query
    type: string
  - name: limit
    in: query
    type: integer
  responses:
    '200': $ListBatchesResponse
- method: POST
  path: /batches
  operation_id: createBatch
  summary: Creates and executes a batch from an uploaded file of requests
  tags:
  - Batch
  responses:
    '200': $Batch
- method: GET
  path: /batches/{batch_id}
  operation_id: retrieveBatch
  summary: Retrieves a batch.
  tags:
  - Batch
  parameters:
  - name: batch_id
    in: path
    type: string
    required: true
  responses:
    '200': $Batch
- method: POST
  path: /batches/{batch_id}/cancel
  operation_id: cancelBatch
  summary: Cancels an in-progress batch.
  tags:
  - Batch
  parameters:
  - name: batch_id
    in: path
    type: string
    required: true
  responses:
    '200': $Batch
- method: GET
  path: /chat/completions
  operation_id: listChatCompletions
  summary: List stored Chat Completions.
  tags:
  - Chat
  parameters:
  - name: model
    in: query
    type: string
  - name: metadata
    in: query
  - name: after
    in: query
    type: string
  - name: limit
    in: query
    type: integer
  - name: order
    in: query
    type: string
  responses:
    '200': $ChatCompletionList
- method: POST
  path: /chat/completions
  operation_id: createChatCompletion
  summary: "**Starting a new project?** We recommend trying [Responses](/docs/api-reference/responses) \nto take advantage\
    \ of the ..."
  tags:
  - Chat
  request_body: $CreateChatCompletionRequest
  responses:
    '200': $CreateChatCompletionResponse
- method: GET
  path: /chat/completions/{completion_id}
  operation_id: getChatCompletion
  summary: Get a stored chat completion.
  tags:
  - Chat
  parameters:
  - name: completion_id
    in: path
    type: string
    required: true
  responses:
    '200': $CreateChatCompletionResponse
- method: POST
  path: /chat/completions/{completion_id}
  operation_id: updateChatCompletion
  summary: Modify a stored chat completion.
  tags:
  - Chat
  parameters:
  - name: completion_id
    in: path
    type: string
    required: true
  responses:
    '200': $CreateChatCompletionResponse
- method: DELETE
  path: /chat/completions/{completion_id}
  operation_id: deleteChatCompletion
  summary: Delete a stored chat completion.
  tags:
  - Chat
  parameters:
  - name: completion_id
    in: path
    type: string
    required: true
  responses:
    '200': $ChatCompletionDeleted
- method: GET
  path: /chat/completions/{completion_id}/messages
  operation_id: getChatCompletionMessages
  summary: Get the messages in a stored chat completion.
  tags:
  - Chat
  parameters:
  - name: completion_id
    in: path
    type: string
    required: true
  - name: after
    in: query
    type: string
  - name: limit
    in: query
    type: integer
  - name: order
    in: query
    type: string
  responses:
    '200': $ChatCompletionMessageList
- method: POST
  path: /completions
  operation_id: createCompletion
  summary: Creates a completion for the provided prompt and parameters.
  tags:
  - Completions
  request_body: $CreateCompletionRequest
  responses:
    '200': $CreateCompletionResponse
- method: POST
  path: /embeddings
  operation_id: createEmbedding
  summary: Creates an embedding vector representing the input text.
  tags:
  - Embeddings
  request_body: $CreateEmbeddingRequest
  responses:
    '200': $CreateEmbeddingResponse
- method: GET
  path: /evals
  operation_id: listEvals
  summary: List evaluations for a project.
  tags:
  - Evals
  parameters:
  - name: after
    in: query
    type: string
  - name: limit
    in: query
    type: integer
  - name: order
    in: query
    type: string
  - name: order_by
    in: query
    type: string
  responses:
    '200': $EvalList
- method: POST
  path: /evals
  operation_id: createEval
  summary: |-
    Create the structure of an evaluation that can be used to test a model's performance.
    An evaluation is a set of testi...
  tags:
  - Evals
  request_body: $CreateEvalRequest
  responses:
    '201': $Eval
- method: GET
  path: /evals/{eval_id}
  operation_id: getEval
  summary: Get an evaluation by ID.
  tags:
  - Evals
  parameters:
  - name: eval_id
    in: path
    type: string
    required: true
  responses:
    '200': $Eval
- method: POST
  path: /evals/{eval_id}
  operation_id: updateEval
  summary: Update certain properties of an evaluation.
  tags:
  - Evals
  parameters:
  - name: eval_id
    in: path
    type: string
    required: true
  responses:
    '200': $Eval
- method: DELETE
  path: /evals/{eval_id}
  operation_id: deleteEval
  summary: Delete an evaluation.
  tags:
  - Evals
  parameters:
  - name: eval_id
    in: path
    type: string
    required: true
  responses:
    '404': $Error
- method: GET
  path: /evals/{eval_id}/runs
  operation_id: getEvalRuns
  summary: Get a list of runs for an evaluation.
  tags:
  - Evals
  parameters:
  - name: eval_id
    in: path
    type: string
    required: true
  - name: after
    in: query
    type: string
  - name: limit
    in: query
    type: integer
  - name: order
    in: query
    type: string
  - name: status
    in: query
    type: string
  responses:
    '200': $EvalRunList
- method: POST
  path: /evals/{eval_id}/runs
  operation_id: createEvalRun
  summary: Create a new evaluation run.
  tags:
  - Evals
  parameters:
  - name: eval_id
    in: path
    type: string
    required: true
  request_body: $CreateEvalRunRequest
  responses:
    '201': $EvalRun
    '400': $Error
- method: GET
  path: /evals/{eval_id}/runs/{run_id}
  operation_id: getEvalRun
  summary: Get an evaluation run by ID.
  tags:
  - Evals
  parameters:
  - name: eval_id
    in: path
    type: string
    required: true
  - name: run_id
    in: path
    type: string
    required: true
  responses:
    '200': $EvalRun
- method: POST
  path: /evals/{eval_id}/runs/{run_id}
  operation_id: cancelEvalRun
  summary: Cancel an ongoing evaluation run.
  tags:
  - Evals
  parameters:
  - name: eval_id
    in: path
    type: string
    required: true
  - name: run_id
    in: path
    type: string
    required: true
  responses:
    '200': $EvalRun
- method: DELETE
  path: /evals/{eval_id}/runs/{run_id}
  operation_id: deleteEvalRun
  summary: Delete an eval run.
  tags:
  - Evals
  parameters:
  - name: eval_id
    in: path
    type: string
    required: true
  - name: run_id
    in: path
    type: string
    required: true
  responses:
    '404': $Error
- method: GET
  path: /evals/{eval_id}/runs/{run_id}/output_items
  operation_id: getEvalRunOutputItems
  summary: Get a list of output items for an evaluation run.
  tags:
  - Evals
  parameters:
  - name: eval_id
    in: path
    type: string
    required: true
  - name: run_id
    in: path
    type: string
    required: true
  - name: after
    in: query
    type: string
  - name: limit
    in: query
    type: integer
  - name: status
    in: query
    type: string
  - name: order
    in: query
    type: string
  responses:
    '200': $EvalRunOutputItemList
- method: GET
  path: /evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}
  operation_id: getEvalRunOutputItem
  summary: Get an evaluation run output item by ID.
  tags:
  - Evals
  parameters:
  - name: eval_id
    in: path
    type: string
    required: true
  - name: run_id
    in: path
    type: string
    required: true
  - name: output_item_id
    in: path
    type: string
    required: true
  responses:
    '200': $EvalRunOutputItem
- method: GET
  path: /files
  operation_id: listFiles
  summary: Returns a list of files.
  tags:
  - Files
  parameters:
  - name: purpose
    in: query
    type: string
  - name: limit
    in: query
    type: integer
  - name: order
    in: query
    type: string
  - name: after
    in: query
    type: string
  responses:
    '200': $ListFilesResponse
- method: POST
  path: /files
  operation_id: createFile
  summary: Upload a file that can be used across various endpoints.
  tags:
  - Files
  request_body: $CreateFileRequest
  responses:
    '200': $OpenAIFile
- method: GET
  path: /files/{file_id}
  operation_id: retrieveFile
  summary: Returns information about a specific file.
  tags:
  - Files
  parameters:
  - name: file_id
    in: path
    type: string
    required: true
  responses:
    '200': $OpenAIFile
- method: DELETE
  path: /files/{file_id}
  operation_id: deleteFile
  summary: Delete a file.
  tags:
  - Files
  parameters:
  - name: file_id
    in: path
    type: string
    required: true
  responses:
    '200': $DeleteFileResponse
- method: GET
  path: /files/{file_id}/content
  operation_id: downloadFile
  summary: Returns the contents of the specified file.
  tags:
  - Files
  parameters:
  - name: file_id
    in: path
    type: string
    required: true
- method: GET
  path: /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions
  operation_id: listFineTuningCheckpointPermissions
  summary: '**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).'
  tags:
  - Fine-tuning
  parameters:
  - name: fine_tuned_model_checkpoint
    in: path
    type: string
    required: true
  - name: project_id
    in: query
    type: string
  - name: after
    in: query
    type: string
  - name: limit
    in: query
    type: integer
  - name: order
    in: query
    type: string
  responses:
    '200': $ListFineTuningCheckpointPermissionResponse
- method: POST
  path: /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions
  operation_id: createFineTuningCheckpointPermission
  summary: '**NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys).'
  tags:
  - Fine-tuning
  parameters:
  - name: fine_tuned_model_checkpoint
    in: path
    type: string
    required: true
  request_body: $CreateFineTuningCheckpointPermissionRequest
  responses:
    '200': $ListFineTuningCheckpointPermissionResponse
- method: DELETE
  path: /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}
  operation_id: deleteFineTuningCheckpointPermission
  summary: '**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).'
  tags:
  - Fine-tuning
  parameters:
  - name: fine_tuned_model_checkpoint
    in: path
    type: string
    required: true
  - name: permission_id
    in: path
    type: string
    required: true
  responses:
    '200': $DeleteFineTuningCheckpointPermissionResponse
- method: GET
  path: /fine_tuning/jobs
  operation_id: listPaginatedFineTuningJobs
  summary: List your organization's fine-tuning jobs
  tags:
  - Fine-tuning
  parameters:
  - name: after
    in: query
    type: string
  - name: limit
    in: query
    type: integer
  - name: metadata
    in: query
    type: object
  responses:
    '200': $ListPaginatedFineTuningJobsResponse
- method: POST
  path: /fine_tuning/jobs
  operation_id: createFineTuningJob
  summary: Creates a fine-tuning job which begins the process of creating a new model from a given dataset.
  tags:
  - Fine-tuning
  request_body: $CreateFineTuningJobRequest
  responses:
    '200': $FineTuningJob
- method: GET
  path: /fine_tuning/jobs/{fine_tuning_job_id}
  operation_id: retrieveFineTuningJob
  summary: Get info about a fine-tuning job.
  tags:
  - Fine-tuning
  parameters:
  - name: fine_tuning_job_id
    in: path
    type: string
    required: true
  responses:
    '200': $FineTuningJob
- method: POST
  path: /fine_tuning/jobs/{fine_tuning_job_id}/cancel
  operation_id: cancelFineTuningJob
  summary: Immediately cancel a fine-tune job.
  tags:
  - Fine-tuning
  parameters:
  - name: fine_tuning_job_id
    in: path
    type: string
    required: true
  responses:
    '200': $FineTuningJob
- method: GET
  path: /fine_tuning/jobs/{fine_tuning_job_id}/checkpoints
  operation_id: listFineTuningJobCheckpoints
  summary: List checkpoints for a fine-tuning job.
  tags:
  - Fine-tuning
  parameters:
  - name: fine_tuning_job_id
    in: path
    type: string
    required: true
  - name: after
    in: query
    type: string
  - name: limit
    in: query
    type: integer
  responses:
    '200': $ListFineTuningJobCheckpointsResponse
- method: GET
  path: /fine_tuning/jobs/{fine_tuning_job_id}/events
  operation_id: listFineTuningEvents
  summary: Get status updates for a fine-tuning job.
  tags:
  - Fine-tuning
  parameters:
  - name: fine_tuning_job_id
    in: path
    type: string
    required: true
  - name: after
    in: query
    type: string
  - name: limit
    in: query
    type: integer
  responses:
    '200': $ListFineTuningJobEventsResponse
- method: POST
  path: /images/edits
  operation_id: createImageEdit
  summary: Creates an edited or extended image given one or more source images and a prompt.
  tags:
  - Images
  request_body: $CreateImageEditRequest
  responses:
    '200': $ImagesResponse
- method: POST
  path: /images/generations
  operation_id: createImage
  summary: Creates an image given a prompt.
  tags:
  - Images
  request_body: $CreateImageRequest
  responses:
    '200': $ImagesResponse
- method: POST
  path: /images/variations
  operation_id: createImageVariation
  summary: Creates a variation of a given image.
  tags:
  - Images
  request_body: $CreateImageVariationRequest
  responses:
    '200': $ImagesResponse
- method: GET
  path: /models
  operation_id: listModels
  summary: Lists the currently available models, and provides basic information about each one such as the owner and availability.
  tags:
  - Models
  responses:
    '200': $ListModelsResponse
- method: GET
  path: /models/{model}
  operation_id: retrieveModel
  summary: Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
  tags:
  - Models
  parameters:
  - name: model
    in: path
    type: string
    required: true
  responses:
    '200': $Model
- method: DELETE
  path: /models/{model}
  operation_id: deleteModel
  summary: Delete a fine-tuned model.
  tags:
  - Models
  parameters:
  - name: model
    in: path
    type: string
    required: true
  responses:
    '200': $DeleteModelResponse
- method: POST
  path: /moderations
  operation_id: createModeration
  summary: Classifies if text and/or image inputs are potentially harmful.
  tags:
  - Moderations
  request_body: $CreateModerationRequest
  responses:
    '200': $CreateModerationResponse
- method: GET
  path: /organization/admin_api_keys
  operation_id: admin-api-keys-list
  summary: List organization API keys
  parameters:
  - name: after
    in: query
    type: string
  - name: order
    in: query
    type: string
  - name: limit
    in: query
    type: integer
  responses:
    '200': $ApiKeyList
- method: POST
  path: /organization/admin_api_keys
  operation_id: admin-api-keys-create
  summary: Create an organization admin API key
  responses:
    '200': $AdminApiKey
- method: GET
  path: /organization/admin_api_keys/{key_id}
  operation_id: admin-api-keys-get
  summary: Retrieve a single organization API key
  parameters:
  - name: key_id
    in: path
    type: string
    required: true
  responses:
    '200': $AdminApiKey
- method: DELETE
  path: /organization/admin_api_keys/{key_id}
  operation_id: admin-api-keys-delete
  summary: Delete an organization admin API key
  parameters:
  - name: key_id
    in: path
    type: string
    required: true
- method: GET
  path: /organization/audit_logs
  operation_id: list-audit-logs
  summary: List user actions and configuration changes within this organization.
  tags:
  - Audit Logs
  parameters:
  - name: effective_at
    in: query
    type: object
  - name: project_ids[]
    in: query
    type: array
  - name: event_types[]
    in: query
    type: array
  - name: actor_ids[]
    in: query
    type: array
  - name: actor_emails[]
    in: query
    type: array
  - name: resource_ids[]
    in: query
    type: array
  - name: limit
    in: query
    type: integer
  - name: after
    in: query
    type: string
  - name: before
    in: query
    type: string
  responses:
    '200': $ListAuditLogsResponse
- method: GET
  path: /organization/certificates
  operation_id: listOrganizationCertificates
  summary: List uploaded certificates for this organization.
  tags:
  - Certificates
  parameters:
  - name: limit
    in: query
    type: integer
  - name: after
    in: query
    type: string
  - name: order
    in: query
    type: string
  responses:
    '200': $ListCertificatesResponse
- method: POST
  path: /organization/certificates
  operation_id: uploadCertificate
  summary: Upload a certificate to the organization.
  tags:
  - Certificates
  request_body: $UploadCertificateRequest
  responses:
    '200': $Certificate
- method: POST
  path: /organization/certificates/activate
  operation_id: activateOrganizationCertificates
  summary: Activate certificates at the organization level.
  tags:
  - Certificates
  request_body: $ToggleCertificatesRequest
  responses:
    '200': $ListCertificatesResponse
- method: POST
  path: /organization/certificates/deactivate
  operation_id: deactivateOrganizationCertificates
  summary: Deactivate certificates at the organization level.
  tags:
  - Certificates
  request_body: $ToggleCertificatesRequest
  responses:
    '200': $ListCertificatesResponse
- method: GET
  path: /organization/certificates/{certificate_id}
  operation_id: getCertificate
  summary: Get a certificate that has been uploaded to the organization.
  tags:
  - Certificates
  parameters:
  - name: cert_id
    in: path
    type: string
    required: true
  - name: include
    in: query
    type: array
  responses:
    '200': $Certificate
- method: POST
  path: /organization/certificates/{certificate_id}
  operation_id: modifyCertificate
  summary: Modify a certificate.
  tags:
  - Certificates
  request_body: $ModifyCertificateRequest
  responses:
    '200': $Certificate
- method: DELETE
  path: /organization/certificates/{certificate_id}
  operation_id: deleteCertificate
  summary: Delete a certificate from the organization.
  tags:
  - Certificates
  responses:
    '200': $DeleteCertificateResponse
- method: GET
  path: /organization/costs
  operation_id: usage-costs
  summary: Get costs details for the organization.
  tags:
  - Usage
  parameters:
  - name: start_time
    in: query
    type: integer
    required: true
  - name: end_time
    in: query
    type: integer
  - name: bucket_width
    in: query
    type: string
  - name: project_ids
    in: query
    type: array
  - name: group_by
    in: query
    type: array
  - name: limit
    in: query
    type: integer
  - name: page
    in: query
    type: string
  responses:
    '200': $UsageResponse
- method: GET
  path: /organization/invites
  operation_id: list-invites
  summary: Returns a list of invites in the organization.
  tags:
  - Invites
  parameters:
  - name: limit
    in: query
    type: integer
  - name: after
    in: query
    type: string
  responses:
    '200': $InviteListResponse
- method: POST
  path: /organization/invites
  operation_id: inviteUser
  summary: Create an invite for a user to the organization.
  tags:
  - Invites
  request_body: $InviteRequest
  responses:
    '200': $Invite
- method: GET
  path: /organization/invites/{invite_id}
  operation_id: retrieve-invite
  summary: Retrieves an invite.
  tags:
  - Invites
  parameters:
  - name: invite_id
    in: path
    type: string
    required: true
  responses:
    '200': $Invite
- method: DELETE
  path: /organization/invites/{invite_id}
  operation_id: delete-invite
  summary: Delete an invite.
  tags:
  - Invites
  parameters:
  - name: invite_id
    in: path
    type: string
    required: true
  responses:
    '200': $InviteDeleteResponse
- method: GET
  path: /organization/projects
  operation_id: list-projects
  summary: Returns a list of projects.
  tags:
  - Projects
  parameters:
  - name: limit
    in: query
    type: integer
  - name: after
    in: query
    type: string
  - name: include_archived
    in: query
    type: boolean
  responses:
    '200': $ProjectListResponse
- method: POST
  path: /organization/projects
  operation_id: create-project
  summary: Create a new project in the organization.
  tags:
  - Projects
  request_body: $ProjectCreateRequest
  responses:
    '200': $Project
- method: GET
  path: /organization/projects/{project_id}
  operation_id: retrieve-project
  summary: Retrieves a project.
  tags:
  - Projects
  parameters:
  - name: project_id
    in: path
    type: string
    required: true
  responses:
    '200': $Project
- method: POST
  path: /organization/projects/{project_id}
  operation_id: modify-project
  summary: Modifies a project in the organization.
  tags:
  - Projects
  parameters:
  - name: project_id
    in: path
    type: string
    required: true
  request_body: $ProjectUpdateRequest
  responses:
    '200': $Project
    '400': $ErrorResponse
- method: GET
  path: /organization/projects/{project_id}/api_keys
  operation_id: list-project-api-keys
  summary: Returns a list of API keys in the project.
  tags:
  - Projects
  parameters:
  - name: project_id
    in: path
    type: string
    required: true
  - name: limit
    in: query
    type: integer
  - name: after
    in: query
    type: string
  responses:
    '200': $ProjectApiKeyListResponse
- method: GET
  path: /organization/projects/{project_id}/api_keys/{key_id}
  operation_id: retrieve-project-api-key
  summary: Retrieves an API key in the project.
  tags:
  - Projects
  parameters:
  - name: project_id
    in: path
    type: string
    required: true
  - name: key_id
    in: path
    type: string
    required: true
  responses:
    '200': $ProjectApiKey
- method: DELETE
  path: /organization/projects/{project_id}/api_keys/{key_id}
  operation_id: delete-project-api-key
  summary: Deletes an API key from the project.
  tags:
  - Projects
  parameters:
  - name: project_id
    in: path
    type: string
    required: true
  - name: key_id
    in: path
    type: string
    required: true
  responses:
    '200': $ProjectApiKeyDeleteResponse
    '400': $ErrorResponse
- method: POST
  path: /organization/projects/{project_id}/archive
  operation_id: archive-project
  summary: Archives a project in the organization.
  tags:
  - Projects
  parameters:
  - name: project_id
    in: path
    type: string
    required: true
  responses:
    '200': $Project
- method: GET
  path: /organization/projects/{project_id}/certificates
  operation_id: listProjectCertificates
  summary: List certificates for this project.
  tags:
  - Certificates
  parameters:
  - name: limit
    in: query
    type: integer
  - name: after
    in: query
    type: string
  - name: order
    in: query
    type: string
  responses:
    '200': $ListCertificatesResponse
- method: POST
  path: /organization/projects/{project_id}/certificates/activate
  operation_id: activateProjectCertificates
  summary: Activate certificates at the project level.
  tags:
  - Certificates
  request_body: $ToggleCertificatesRequest
  responses:
    '200': $ListCertificatesResponse
- method: POST
  path: /organization/projects/{project_id}/certificates/deactivate
  operation_id: deactivateProjectCertificates
  summary: Deactivate certificates at the project level.
  tags:
  - Certificates
  request_body: $ToggleCertificatesRequest
  responses:
    '200': $ListCertificatesResponse
- method: GET
  path: /organization/projects/{project_id}/rate_limits
  operation_id: list-project-rate-limits
  summary: Returns the rate limits per model for a project.
  tags:
  - Projects
  parameters:
  - name: project_id
    in: path
    type: string
    required: true
  - name: limit
    in: query
    type: integer
  - name: after
    in: query
    type: string
  - name: before
    in: query
    type: string
  responses:
    '200': $ProjectRateLimitListResponse
- method: POST
  path: /organization/projects/{project_id}/rate_limits/{rate_limit_id}
  operation_id: update-project-rate-limits
  summary: Updates a project rate limit.
  tags:
  - Projects
  parameters:
  - name: project_id
    in: path
    type: string
    required: true
  - name: rate_limit_id
    in: path
    type: string
    required: true
  request_body: $ProjectRateLimitUpdateRequest
  responses:
    '200': $ProjectRateLimit
    '400': $ErrorResponse
- method: GET
  path: /organization/projects/{project_id}/service_accounts
  operation_id: list-project-service-accounts
  summary: Returns a list of service accounts in the project.
  tags:
  - Projects
  parameters:
  - name: project_id
    in: path
    type: string
    required: true
  - name: limit
    in: query
    type: integer
  - name: after
    in: query
    type: string
  responses:
    '200': $ProjectServiceAccountListResponse
    '400': $ErrorResponse
- method: POST
  path: /organization/projects/{project_id}/service_accounts
  operation_id: create-project-service-account
  summary: Creates a new service account in the project.
  tags:
  - Projects
  parameters:
  - name: project_id
    in: path
    type: string
    required: true
  request_body: $ProjectServiceAccountCreateRequest
  responses:
    '200': $ProjectServiceAccountCreateResponse
    '400': $ErrorResponse
- method: GET
  path: /organization/projects/{project_id}/service_accounts/{service_account_id}
  operation_id: retrieve-project-service-account
  summary: Retrieves a service account in the project.
  tags:
  - Projects
  parameters:
  - name: project_id
    in: path
    type: string
    required: true
  - name: service_account_id
    in: path
    type: string
    required: true
  responses:
    '200': $ProjectServiceAccount
- method: DELETE
  path: /organization/projects/{project_id}/service_accounts/{service_account_id}
  operation_id: delete-project-service-account
  summary: Deletes a service account from the project.
  tags:
  - Projects
  parameters:
  - name: project_id
    in: path
    type: string
    required: true
  - name: service_account_id
    in: path
    type: string
    required: true
  responses:
    '200': $ProjectServiceAccountDeleteResponse
- method: GET
  path: /organization/projects/{project_id}/users
  operation_id: list-project-users
  summary: Returns a list of users in the project.
  tags:
  - Projects
  parameters:
  - name: project_id
    in: path
    type: string
    required: true
  - name: limit
    in: query
    type: integer
  - name: after
    in: query
    type: string
  responses:
    '200': $ProjectUserListResponse
    '400': $ErrorResponse
- method: POST
  path: /organization/projects/{project_id}/users
  operation_id: create-project-user
  summary: Adds a user to the project.
  tags:
  - Projects
  parameters:
  - name: project_id
    in: path
    type: string
    required: true
  request_body: $ProjectUserCreateRequest
  responses:
    '200': $ProjectUser
    '400': $ErrorResponse
- method: GET
  path: /organization/projects/{project_id}/users/{user_id}
  operation_id: retrieve-project-user
  summary: Retrieves a user in the project.
  tags:
  - Projects
  parameters:
  - name: project_id
    in: path
    type: string
    required: true
  - name: user_id
    in: path
    type: string
    required: true
  responses:
    '200': $ProjectUser
- method: POST
  path: /organization/projects/{project_id}/users/{user_id}
  operation_id: modify-project-user
  summary: Modifies a user's role in the project.
  tags:
  - Projects
  parameters:
  - name: project_id
    in: path
    type: string
    required: true
  - name: user_id
    in: path
    type: string
    required: true
  request_body: $ProjectUserUpdateRequest
  responses:
    '200': $ProjectUser
    '400': $ErrorResponse
- method: DELETE
  path: /organization/projects/{project_id}/users/{user_id}
  operation_id: delete-project-user
  summary: Deletes a user from the project.
  tags:
  - Projects
  parameters:
  - name: project_id
    in: path
    type: string
    required: true
  - name: user_id
    in: path
    type: string
    required: true
  responses:
    '200': $ProjectUserDeleteResponse
    '400': $ErrorResponse
- method: GET
  path: /organization/usage/audio_speeches
  operation_id: usage-audio-speeches
  summary: Get audio speeches usage details for the organization.
  tags:
  - Usage
  parameters:
  - name: start_time
    in: query
    type: integer
    required: true
  - name: end_time
    in: query
    type: integer
  - name: bucket_width
    in: query
    type: string
  - name: project_ids
    in: query
    type: array
  - name: user_ids
    in: query
    type: array
  - name: api_key_ids
    in: query
    type: array
  - name: models
    in: query
    type: array
  - name: group_by
    in: query
    type: array
  - name: limit
    in: query
    type: integer
  - name: page
    in: query
    type: string
  responses:
    '200': $UsageResponse
- method: GET
  path: /organization/usage/audio_transcriptions
  operation_id: usage-audio-transcriptions
  summary: Get audio transcriptions usage details for the organization.
  tags:
  - Usage
  parameters:
  - name: start_time
    in: query
    type: integer
    required: true
  - name: end_time
    in: query
    type: integer
  - name: bucket_width
    in: query
    type: string
  - name: project_ids
    in: query
    type: array
  - name: user_ids
    in: query
    type: array
  - name: api_key_ids
    in: query
    type: array
  - name: models
    in: query
    type: array
  - name: group_by
    in: query
    type: array
  - name: limit
    in: query
    type: integer
  - name: page
    in: query
    type: string
  responses:
    '200': $UsageResponse
- method: GET
  path: /organization/usage/code_interpreter_sessions
  operation_id: usage-code-interpreter-sessions
  summary: Get code interpreter sessions usage details for the organization.
  tags:
  - Usage
  parameters:
  - name: start_time
    in: query
    type: integer
    required: true
  - name: end_time
    in: query
    type: integer
  - name: bucket_width
    in: query
    type: string
  - name: project_ids
    in: query
    type: array
  - name: group_by
    in: query
    type: array
  - name: limit
    in: query
    type: integer
  - name: page
    in: query
    type: string
  responses:
    '200': $UsageResponse
- method: GET
  path: /organization/usage/completions
  operation_id: usage-completions
  summary: Get completions usage details for the organization.
  tags:
  - Usage
  parameters:
  - name: start_time
    in: query
    type: integer
    required: true
  - name: end_time
    in: query
    type: integer
  - name: bucket_width
    in: query
    type: string
  - name: project_ids
    in: query
    type: array
  - name: user_ids
    in: query
    type: array
  - name: api_key_ids
    in: query
    type: array
  - name: models
    in: query
    type: array
  - name: batch
    in: query
    type: boolean
  - name: group_by
    in: query
    type: array
  - name: limit
    in: query
    type: integer
  - name: page
    in: query
    type: string
  responses:
    '200': $UsageResponse
- method: GET
  path: /organization/usage/embeddings
  operation_id: usage-embeddings
  summary: Get embeddings usage details for the organization.
  tags:
  - Usage
  parameters:
  - name: start_time
    in: query
    type: integer
    required: true
  - name: end_time
    in: query
    type: integer
  - name: bucket_width
    in: query
    type: string
  - name: project_ids
    in: query
    type: array
  - name: user_ids
    in: query
    type: array
  - name: api_key_ids
    in: query
    type: array
  - name: models
    in: query
    type: array
  - name: group_by
    in: query
    type: array
  - name: limit
    in: query
    type: integer
  - name: page
    in: query
    type: string
  responses:
    '200': $UsageResponse
- method: GET
  path: /organization/usage/images
  operation_id: usage-images
  summary: Get images usage details for the organization.
  tags:
  - Usage
  parameters:
  - name: start_time
    in: query
    type: integer
    required: true
  - name: end_time
    in: query
    type: integer
  - name: bucket_width
    in: query
    type: string
  - name: sources
    in: query
    type: array
  - name: sizes
    in: query
    type: array
  - name: project_ids
    in: query
    type: array
  - name: user_ids
    in: query
    type: array
  - name: api_key_ids
    in: query
    type: array
  - name: models
    in: query
    type: array
  - name: group_by
    in: query
    type: array
  - name: limit
    in: query
    type: integer
  - name: page
    in: query
    type: string
  responses:
    '200': $UsageResponse
- method: GET
  path: /organization/usage/moderations
  operation_id: usage-moderations
  summary: Get moderations usage details for the organization.
  tags:
  - Usage
  parameters:
  - name: start_time
    in: query
    type: integer
    required: true
  - name: end_time
    in: query
    type: integer
  - name: bucket_width
    in: query
    type: string
  - name: project_ids
    in: query
    type: array
  - name: user_ids
    in: query
    type: array
  - name: api_key_ids
    in: query
    type: array
  - name: models
    in: query
    type: array
  - name: group_by
    in: query
    type: array
  - name: limit
    in: query
    type: integer
  - name: page
    in: query
    type: string
  responses:
    '200': $UsageResponse
- method: GET
  path: /organization/usage/vector_stores
  operation_id: usage-vector-stores
  summary: Get vector stores usage details for the organization.
  tags:
  - Usage
  parameters:
  - name: start_time
    in: query
    type: integer
    required: true
  - name: end_time
    in: query
    type: integer
  - name: bucket_width
    in: query
    type: string
  - name: project_ids
    in: query
    type: array
  - name: group_by
    in: query
    type: array
  - name: limit
    in: query
    type: integer
  - name: page
    in: query
    type: string
  responses:
    '200': $UsageResponse
- method: GET
  path: /organization/users
  operation_id: list-users
  summary: Lists all of the users in the organization.
  tags:
  - Users
  parameters:
  - name: limit
    in: query
    type: integer
  - name: after
    in: query
    type: string
  - name: emails
    in: query
    type: array
  responses:
    '200': $UserListResponse
- method: GET
  path: /organization/users/{user_id}
  operation_id: retrieve-user
  summary: Retrieves a user by their identifier.
  tags:
  - Users
  parameters:
  - name: user_id
    in: path
    type: string
    required: true
  responses:
    '200': $User
- method: POST
  path: /organization/users/{user_id}
  operation_id: modify-user
  summary: Modifies a user's role in the organization.
  tags:
  - Users
  parameters:
  - name: user_id
    in: path
    type: string
    required: true
  request_body: $UserRoleUpdateRequest
  responses:
    '200': $User
- method: DELETE
  path: /organization/users/{user_id}
  operation_id: delete-user
  summary: Deletes a user from the organization.
  tags:
  - Users
  parameters:
  - name: user_id
    in: path
    type: string
    required: true
  responses:
    '200': $UserDeleteResponse
- method: POST
  path: /realtime/sessions
  operation_id: create-realtime-session
  summary: |-
    Create an ephemeral API token for use in client-side applications with the
    Realtime API.
  tags:
  - Realtime
  request_body: $RealtimeSessionCreateRequest
  responses:
    '200': $RealtimeSessionCreateResponse
- method: POST
  path: /realtime/transcription_sessions
  operation_id: create-realtime-transcription-session
  summary: |-
    Create an ephemeral API token for use in client-side applications with the
    Realtime API specifically for realtime tra...
  tags:
  - Realtime
  request_body: $RealtimeTranscriptionSessionCreateRequest
  responses:
    '200': $RealtimeTranscriptionSessionCreateResponse
- method: POST
  path: /responses
  operation_id: createResponse
  summary: Creates a model response.
  tags:
  - Responses
  request_body: $CreateResponse
  responses:
    '200': $Response
- method: GET
  path: /responses/{response_id}
  operation_id: getResponse
  summary: Retrieves a model response with the given ID.
  tags:
  - Responses
  parameters:
  - name: response_id
    in: path
    type: string
    required: true
  - name: include
    in: query
    type: array
  responses:
    '200': $Response
- method: DELETE
  path: /responses/{response_id}
  operation_id: deleteResponse
  summary: Deletes a model response with the given ID.
  tags:
  - Responses
  parameters:
  - name: response_id
    in: path
    type: string
    required: true
  responses:
    '404': $Error
- method: GET
  path: /responses/{response_id}/input_items
  operation_id: listInputItems
  summary: Returns a list of input items for a given response.
  tags:
  - Responses
  parameters:
  - name: response_id
    in: path
    type: string
    required: true
  - name: limit
    in: query
    type: integer
  - name: order
    in: query
    type: string
  - name: after
    in: query
    type: string
  - name: before
    in: query
    type: string
  - name: include
    in: query
    type: array
  responses:
    '200': $ResponseItemList
- method: POST
  path: /threads
  operation_id: createThread
  summary: Create a thread.
  tags:
  - Assistants
  request_body: $CreateThreadRequest
  responses:
    '200': $ThreadObject
- method: POST
  path: /threads/runs
  operation_id: createThreadAndRun
  summary: Create a thread and run it in one request.
  tags:
  - Assistants
  request_body: $CreateThreadAndRunRequest
  responses:
    '200': $RunObject
- method: GET
  path: /threads/{thread_id}
  operation_id: getThread
  summary: Retrieves a thread.
  tags:
  - Assistants
  parameters:
  - name: thread_id
    in: path
    type: string
    required: true
  responses:
    '200': $ThreadObject
- method: POST
  path: /threads/{thread_id}
  operation_id: modifyThread
  summary: Modifies a thread.
  tags:
  - Assistants
  parameters:
  - name: thread_id
    in: path
    type: string
    required: true
  request_body: $ModifyThreadRequest
  responses:
    '200': $ThreadObject
- method: DELETE
  path: /threads/{thread_id}
  operation_id: deleteThread
  summary: Delete a thread.
  tags:
  - Assistants
  parameters:
  - name: thread_id
    in: path
    type: string
    required: true
  responses:
    '200': $DeleteThreadResponse
- method: GET
  path: /threads/{thread_id}/messages
  operation_id: listMessages
  summary: Returns a list of messages for a given thread.
  tags:
  - Assistants
  parameters:
  - name: thread_id
    in: path
    type: string
    required: true
  - name: limit
    in: query
    type: integer
  - name: order
    in: query
    type: string
  - name: after
    in: query
    type: string
  - name: before
    in: query
    type: string
  - name: run_id
    in: query
    type: string
  responses:
    '200': $ListMessagesResponse
- method: POST
  path: /threads/{thread_id}/messages
  operation_id: createMessage
  summary: Create a message.
  tags:
  - Assistants
  parameters:
  - name: thread_id
    in: path
    type: string
    required: true
  request_body: $CreateMessageRequest
  responses:
    '200': $MessageObject
- method: GET
  path: /threads/{thread_id}/messages/{message_id}
  operation_id: getMessage
  summary: Retrieve a message.
  tags:
  - Assistants
  parameters:
  - name: thread_id
    in: path
    type: string
    required: true
  - name: message_id
    in: path
    type: string
    required: true
  responses:
    '200': $MessageObject
- method: POST
  path: /threads/{thread_id}/messages/{message_id}
  operation_id: modifyMessage
  summary: Modifies a message.
  tags:
  - Assistants
  parameters:
  - name: thread_id
    in: path
    type: string
    required: true
  - name: message_id
    in: path
    type: string
    required: true
  request_body: $ModifyMessageRequest
  responses:
    '200': $MessageObject
- method: DELETE
  path: /threads/{thread_id}/messages/{message_id}
  operation_id: deleteMessage
  summary: Deletes a message.
  tags:
  - Assistants
  parameters:
  - name: thread_id
    in: path
    type: string
    required: true
  - name: message_id
    in: path
    type: string
    required: true
  responses:
    '200': $DeleteMessageResponse
- method: GET
  path: /threads/{thread_id}/runs
  operation_id: listRuns
  summary: Returns a list of runs belonging to a thread.
  tags:
  - Assistants
  parameters:
  - name: thread_id
    in: path
    type: string
    required: true
  - name: limit
    in: query
    type: integer
  - name: order
    in: query
    type: string
  - name: after
    in: query
    type: string
  - name: before
    in: query
    type: string
  responses:
    '200': $ListRunsResponse
- method: POST
  path: /threads/{thread_id}/runs
  operation_id: createRun
  summary: Create a run.
  tags:
  - Assistants
  parameters:
  - name: thread_id
    in: path
    type: string
    required: true
  - name: include[]
    in: query
    type: array
  request_body: $CreateRunRequest
  responses:
    '200': $RunObject
- method: GET
  path: /threads/{thread_id}/runs/{run_id}
  operation_id: getRun
  summary: Retrieves a run.
  tags:
  - Assistants
  parameters:
  - name: thread_id
    in: path
    type: string
    required: true
  - name: run_id
    in: path
    type: string
    required: true
  responses:
    '200': $RunObject
- method: POST
  path: /threads/{thread_id}/runs/{run_id}
  operation_id: modifyRun
  summary: Modifies a run.
  tags:
  - Assistants
  parameters:
  - name: thread_id
    in: path
    type: string
    required: true
  - name: run_id
    in: path
    type: string
    required: true
  request_body: $ModifyRunRequest
  responses:
    '200': $RunObject
- method: POST
  path: /threads/{thread_id}/runs/{run_id}/cancel
  operation_id: cancelRun
  summary: Cancels a run that is `in_progress`.
  tags:
  - Assistants
  parameters:
  - name: thread_id
    in: path
    type: string
    required: true
  - name: run_id
    in: path
    type: string
    required: true
  responses:
    '200': $RunObject
- method: GET
  path: /threads/{thread_id}/runs/{run_id}/steps
  operation_id: listRunSteps
  summary: Returns a list of run steps belonging to a run.
  tags:
  - Assistants
  parameters:
  - name: thread_id
    in: path
    type: string
    required: true
  - name: run_id
    in: path
    type: string
    required: true
  - name: limit
    in: query
    type: integer
  - name: order
    in: query
    type: string
  - name: after
    in: query
    type: string
  - name: before
    in: query
    type: string
  - name: include[]
    in: query
    type: array
  responses:
    '200': $ListRunStepsResponse
- method: GET
  path: /threads/{thread_id}/runs/{run_id}/steps/{step_id}
  operation_id: getRunStep
  summary: Retrieves a run step.
  tags:
  - Assistants
  parameters:
  - name: thread_id
    in: path
    type: string
    required: true
  - name: run_id
    in: path
    type: string
    required: true
  - name: step_id
    in: path
    type: string
    required: true
  - name: include[]
    in: query
    type: array
  responses:
    '200': $RunStepObject
- method: POST
  path: /threads/{thread_id}/runs/{run_id}/submit_tool_outputs
  operation_id: submitToolOuputsToRun
  summary: 'When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint
    can...'
  tags:
  - Assistants
  parameters:
  - name: thread_id
    in: path
    type: string
    required: true
  - name: run_id
    in: path
    type: string
    required: true
  request_body: $SubmitToolOutputsRunRequest
  responses:
    '200': $RunObject
- method: POST
  path: /uploads
  operation_id: createUpload
  summary: |-
    Creates an intermediate [Upload](/docs/api-reference/uploads/object) object
    that you can add [Parts](/docs/api-refere...
  tags:
  - Uploads
  request_body: $CreateUploadRequest
  responses:
    '200': $Upload
- method: POST
  path: /uploads/{upload_id}/cancel
  operation_id: cancelUpload
  summary: Cancels the Upload.
  tags:
  - Uploads
  parameters:
  - name: upload_id
    in: path
    type: string
    required: true
  responses:
    '200': $Upload
- method: POST
  path: /uploads/{upload_id}/complete
  operation_id: completeUpload
  summary: Completes the [Upload](/docs/api-reference/uploads/object).
  tags:
  - Uploads
  parameters:
  - name: upload_id
    in: path
    type: string
    required: true
  request_body: $CompleteUploadRequest
  responses:
    '200': $Upload
- method: POST
  path: /uploads/{upload_id}/parts
  operation_id: addUploadPart
  summary: Adds a [Part](/docs/api-reference/uploads/part-object) to an [Upload](/docs/api-reference/uploads/object) object.
  tags:
  - Uploads
  parameters:
  - name: upload_id
    in: path
    type: string
    required: true
  request_body: $AddUploadPartRequest
  responses:
    '200': $UploadPart
- method: GET
  path: /vector_stores
  operation_id: listVectorStores
  summary: Returns a list of vector stores.
  tags:
  - Vector stores
  parameters:
  - name: limit
    in: query
    type: integer
  - name: order
    in: query
    type: string
  - name: after
    in: query
    type: string
  - name: before
    in: query
    type: string
  responses:
    '200': $ListVectorStoresResponse
- method: POST
  path: /vector_stores
  operation_id: createVectorStore
  summary: Create a vector store.
  tags:
  - Vector stores
  request_body: $CreateVectorStoreRequest
  responses:
    '200': $VectorStoreObject
- method: GET
  path: /vector_stores/{vector_store_id}
  operation_id: getVectorStore
  summary: Retrieves a vector store.
  tags:
  - Vector stores
  parameters:
  - name: vector_store_id
    in: path
    type: string
    required: true
  responses:
    '200': $VectorStoreObject
- method: POST
  path: /vector_stores/{vector_store_id}
  operation_id: modifyVectorStore
  summary: Modifies a vector store.
  tags:
  - Vector stores
  parameters:
  - name: vector_store_id
    in: path
    type: string
    required: true
  request_body: $UpdateVectorStoreRequest
  responses:
    '200': $VectorStoreObject
- method: DELETE
  path: /vector_stores/{vector_store_id}
  operation_id: deleteVectorStore
  summary: Delete a vector store.
  tags:
  - Vector stores
  parameters:
  - name: vector_store_id
    in: path
    type: string
    required: true
  responses:
    '200': $DeleteVectorStoreResponse
- method: POST
  path: /vector_stores/{vector_store_id}/file_batches
  operation_id: createVectorStoreFileBatch
  summary: Create a vector store file batch.
  tags:
  - Vector stores
  parameters:
  - name: vector_store_id
    in: path
    type: string
    required: true
  request_body: $CreateVectorStoreFileBatchRequest
  responses:
    '200': $VectorStoreFileBatchObject
- method: GET
  path: /vector_stores/{vector_store_id}/file_batches/{batch_id}
  operation_id: getVectorStoreFileBatch
  summary: Retrieves a vector store file batch.
  tags:
  - Vector stores
  parameters:
  - name: vector_store_id
    in: path
    type: string
    required: true
  - name: batch_id
    in: path
    type: string
    required: true
  responses:
    '200': $VectorStoreFileBatchObject
- method: POST
  path: /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel
  operation_id: cancelVectorStoreFileBatch
  summary: Cancel a vector store file batch.
  tags:
  - Vector stores
  parameters:
  - name: vector_store_id
    in: path
    type: string
    required: true
  - name: batch_id
    in: path
    type: string
    required: true
  responses:
    '200': $VectorStoreFileBatchObject
- method: GET
  path: /vector_stores/{vector_store_id}/file_batches/{batch_id}/files
  operation_id: listFilesInVectorStoreBatch
  summary: Returns a list of vector store files in a batch.
  tags:
  - Vector stores
  parameters:
  - name: vector_store_id
    in: path
    type: string
    required: true
  - name: batch_id
    in: path
    type: string
    required: true
  - name: limit
    in: query
    type: integer
  - name: order
    in: query
    type: string
  - name: after
    in: query
    type: string
  - name: before
    in: query
    type: string
  - name: filter
    in: query
    type: string
  responses:
    '200': $ListVectorStoreFilesResponse
- method: GET
  path: /vector_stores/{vector_store_id}/files
  operation_id: listVectorStoreFiles
  summary: Returns a list of vector store files.
  tags:
  - Vector stores
  parameters:
  - name: vector_store_id
    in: path
    type: string
    required: true
  - name: limit
    in: query
    type: integer
  - name: order
    in: query
    type: string
  - name: after
    in: query
    type: string
  - name: before
    in: query
    type: string
  - name: filter
    in: query
    type: string
  responses:
    '200': $ListVectorStoreFilesResponse
- method: POST
  path: /vector_stores/{vector_store_id}/files
  operation_id: createVectorStoreFile
  summary: Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/v...
  tags:
  - Vector stores
  parameters:
  - name: vector_store_id
    in: path
    type: string
    required: true
  request_body: $CreateVectorStoreFileRequest
  responses:
    '200': $VectorStoreFileObject
- method: GET
  path: /vector_stores/{vector_store_id}/files/{file_id}
  operation_id: getVectorStoreFile
  summary: Retrieves a vector store file.
  tags:
  - Vector stores
  parameters:
  - name: vector_store_id
    in: path
    type: string
    required: true
  - name: file_id
    in: path
    type: string
    required: true
  responses:
    '200': $VectorStoreFileObject
- method: POST
  path: /vector_stores/{vector_store_id}/files/{file_id}
  operation_id: updateVectorStoreFileAttributes
  summary: Update attributes on a vector store file.
  tags:
  - Vector stores
  parameters:
  - name: vector_store_id
    in: path
    type: string
    required: true
  - name: file_id
    in: path
    type: string
    required: true
  request_body: $UpdateVectorStoreFileAttributesRequest
  responses:
    '200': $VectorStoreFileObject
- method: DELETE
  path: /vector_stores/{vector_store_id}/files/{file_id}
  operation_id: deleteVectorStoreFile
  summary: Delete a vector store file.
  tags:
  - Vector stores
  parameters:
  - name: vector_store_id
    in: path
    type: string
    required: true
  - name: file_id
    in: path
    type: string
    required: true
  responses:
    '200': $DeleteVectorStoreFileResponse
- method: GET
  path: /vector_stores/{vector_store_id}/files/{file_id}/content
  operation_id: retrieveVectorStoreFileContent
  summary: Retrieve the parsed contents of a vector store file.
  tags:
  - Vector stores
  parameters:
  - name: vector_store_id
    in: path
    type: string
    required: true
  - name: file_id
    in: path
    type: string
    required: true
  responses:
    '200': $VectorStoreFileContentResponse
- method: POST
  path: /vector_stores/{vector_store_id}/search
  operation_id: searchVectorStore
  summary: Search a vector store for relevant chunks based on a query and file attributes filter.
  tags:
  - Vector stores
  parameters:
  - name: vector_store_id
    in: path
    type: string
    required: true
  request_body: $VectorStoreSearchRequest
  responses:
    '200': $VectorStoreSearchResultsPage
schemas:
  AddUploadPartRequest:
    type: object
    required:
    - data
    properties:
      data:
        type: string
  AdminApiKey:
    type: object
    description: Represents an individual Admin API key in an org.
    required:
    - object
    - redacted_value
    - name
    - created_at
    - last_used_at
    - id
    - owner
    properties:
      object:
        type: string
      id:
        type: string
      name:
        type: string
      redacted_value:
        type: string
      value:
        type: string
      created_at:
        type: integer
      last_used_at:
        type: integer
        nullable: true
      owner:
        type: object
  Annotation:
    oneOf:
    - $FileCitationBody
    - $UrlCitationBody
    - $FilePath
  ApiKeyList:
    type: object
    properties:
      object:
        type: string
      data:
        type: array
        items: $AdminApiKey
      has_more:
        type: boolean
      first_id:
        type: string
      last_id:
        type: string
  ApproximateLocation:
    type: object
    required: &id001
    - type
    properties:
      type:
        type: string
        enum:
        - approximate
        default: approximate
      country:
        anyOf:
        - string
        - 'null'
      region:
        anyOf:
        - string
        - 'null'
      city:
        anyOf:
        - string
        - 'null'
      timezone:
        anyOf:
        - string
        - 'null'
  AssistantObject:
    type: object
    description: Represents an `assistant` that can call the model and use tools.
    required:
    - id
    - object
    - created_at
    - name
    - description
    - model
    - instructions
    - tools
    - metadata
    properties:
      id:
        type: string
      object:
        type: string
        enum:
        - assistant
      created_at:
        type: integer
      name:
        type: string
        nullable: true
      description:
        type: string
        nullable: true
      model:
        type: string
      instructions:
        type: string
        nullable: true
      tools:
        type: array
        items:
          oneOf:
          - $AssistantToolsCode
          - $AssistantToolsFileSearch
          - $AssistantToolsFunction
      tool_resources:
        type: object
        nullable: true
      metadata:
        $ref: $Metadata
      temperature:
        type: number
        nullable: true
        default: 1
      top_p:
        type: number
        nullable: true
        default: 1
      response_format:
        $ref: $AssistantsApiResponseFormatOption
  AssistantStreamEvent:
    oneOf:
    - $ThreadStreamEvent
    - $RunStreamEvent
    - $RunStepStreamEvent
    - $MessageStreamEvent
    - $ErrorEvent
    - $DoneEvent
    description: |-
      Represents an event emitted when streaming a Run.

      Each event in a server-sent events stream has an `event` and `data...
  AssistantSupportedModels:
    type: string
    enum:
    - gpt-4.1
    - gpt-4.1-mini
    - gpt-4.1-nano
    - gpt-4.1-2025-04-14
    - gpt-4.1-mini-2025-04-14
    - gpt-4.1-nano-2025-04-14
    - o3-mini
    - o3-mini-2025-01-31
    - o1
    - o1-2024-12-17
    - gpt-4o
    - gpt-4o-2024-11-20
    - gpt-4o-2024-08-06
    - gpt-4o-2024-05-13
    - gpt-4o-mini
    - gpt-4o-mini-2024-07-18
    - gpt-4.5-preview
    - gpt-4.5-preview-2025-02-27
    - gpt-4-turbo
    - gpt-4-turbo-2024-04-09
    - gpt-4-0125-preview
    - gpt-4-turbo-preview
    - gpt-4-1106-preview
    - gpt-4-vision-preview
    - gpt-4
    - gpt-4-0314
    - gpt-4-0613
    - gpt-4-32k
    - gpt-4-32k-0314
    - gpt-4-32k-0613
    - gpt-3.5-turbo
    - gpt-3.5-turbo-16k
    - gpt-3.5-turbo-0613
    - gpt-3.5-turbo-1106
    - gpt-3.5-turbo-0125
    - gpt-3.5-turbo-16k-0613
  AssistantToolsCode:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - code_interpreter
  AssistantToolsFileSearch:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - file_search
      file_search:
        type: object
  AssistantToolsFileSearchTypeOnly:
    type: object
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - file_search
  AssistantToolsFunction:
    type: object
    required:
    - type
    - function
    properties:
      type:
        type: string
        enum:
        - function
      function:
        $ref: $FunctionObject
  AssistantsApiResponseFormatOption:
    oneOf:
    - string
    - $ResponseFormatText
    - $ResponseFormatJsonObject
    - $ResponseFormatJsonSchema
    description: Specifies the format that the model must output.
  AssistantsApiToolChoiceOption:
    oneOf:
    - string
    - $AssistantsNamedToolChoice
    description: Controls which (if any) tool is called by the model.
  AssistantsNamedToolChoice:
    type: object
    description: Specifies a tool the model should use.
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - function
        - code_interpreter
        - file_search
      function:
        type: object
  AudioResponseFormat:
    type: string
    description: 'The format of the output, in one of these options: `json`, `text`, `srt`, `verbose_json`, or `vtt`.'
    enum:
    - json
    - text
    - srt
    - verbose_json
    - vtt
  AuditLog:
    type: object
    description: A log of a user action or configuration change within this organization.
    required:
    - id
    - type
    - effective_at
    - actor
    properties:
      id:
        type: string
      type:
        $ref: $AuditLogEventType
      effective_at:
        type: integer
      project:
        type: object
      actor:
        $ref: $AuditLogActor
      api_key.created:
        type: object
      api_key.updated:
        type: object
      api_key.deleted:
        type: object
      checkpoint_permission.created:
        type: object
      checkpoint_permission.deleted:
        type: object
      invite.sent:
        type: object
      invite.accepted:
        type: object
      invite.deleted:
        type: object
      login.failed:
        type: object
      logout.failed:
        type: object
      organization.updated:
        type: object
      project.created:
        type: object
      project.updated:
        type: object
      project.archived:
        type: object
      rate_limit.updated:
        type: object
      rate_limit.deleted:
        type: object
      service_account.created:
        type: object
      service_account.updated:
        type: object
      service_account.deleted:
        type: object
      user.added:
        type: object
      user.updated:
        type: object
      user.deleted:
        type: object
      certificate.created:
        type: object
      certificate.updated:
        type: object
      certificate.deleted:
        type: object
      certificates.activated:
        type: object
      certificates.deactivated:
        type: object
  AuditLogActor:
    type: object
    description: The actor who performed the audit logged action.
    properties:
      type:
        type: string
        enum:
        - session
        - api_key
      session:
        $ref: $AuditLogActorSession
      api_key:
        $ref: $AuditLogActorApiKey
  AuditLogActorApiKey:
    type: object
    description: The API Key used to perform the audit logged action.
    properties:
      id:
        type: string
      type:
        type: string
        enum:
        - user
        - service_account
      user:
        $ref: $AuditLogActorUser
      service_account:
        $ref: $AuditLogActorServiceAccount
  AuditLogActorServiceAccount:
    type: object
    description: The service account that performed the audit logged action.
    properties:
      id:
        type: string
  AuditLogActorSession:
    type: object
    description: The session in which the audit logged action was performed.
    properties:
      user:
        $ref: $AuditLogActorUser
      ip_address:
        type: string
  AuditLogActorUser:
    type: object
    description: The user who performed the audit logged action.
    properties:
      id:
        type: string
      email:
        type: string
  AuditLogEventType:
    type: string
    description: The event type.
    enum:
    - api_key.created
    - api_key.updated
    - api_key.deleted
    - checkpoint_permission.created
    - checkpoint_permission.deleted
    - invite.sent
    - invite.accepted
    - invite.deleted
    - login.succeeded
    - login.failed
    - logout.succeeded
    - logout.failed
    - organization.updated
    - project.created
    - project.updated
    - project.archived
    - service_account.created
    - service_account.updated
    - service_account.deleted
    - rate_limit.updated
    - rate_limit.deleted
    - user.added
    - user.updated
    - user.deleted
  AutoChunkingStrategyRequestParam:
    type: object
    description: The default strategy.
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - auto
  Batch:
    type: object
    required:
    - id
    - object
    - endpoint
    - input_file_id
    - completion_window
    - status
    - created_at
    properties:
      id:
        type: string
      object:
        type: string
        enum:
        - batch
      endpoint:
        type: string
      errors:
        type: object
      input_file_id:
        type: string
      completion_window:
        type: string
      status:
        type: string
        enum:
        - validating
        - failed
        - in_progress
        - finalizing
        - completed
        - expired
        - cancelling
        - cancelled
      output_file_id:
        type: string
      error_file_id:
        type: string
      created_at:
        type: integer
      in_progress_at:
        type: integer
      expires_at:
        type: integer
      finalizing_at:
        type: integer
      completed_at:
        type: integer
      failed_at:
        type: integer
      expired_at:
        type: integer
      cancelling_at:
        type: integer
      cancelled_at:
        type: integer
      request_counts:
        type: object
      metadata:
        $ref: $Metadata
  BatchRequestInput:
    type: object
    description: The per-line object of the batch input file
    properties:
      custom_id:
        type: string
      method:
        type: string
        enum:
        - POST
      url:
        type: string
  BatchRequestOutput:
    type: object
    description: The per-line object of the batch output and error files
    properties:
      id:
        type: string
      custom_id:
        type: string
      response:
        type: object
        nullable: true
      error:
        type: object
        nullable: true
  Certificate:
    type: object
    description: Represents an individual `certificate` uploaded to the organization.
    required:
    - object
    - id
    - name
    - created_at
    - certificate_details
    properties:
      object:
        type: string
        enum:
        - certificate
        - organization.certificate
        - organization.project.certificate
      id:
        type: string
      name:
        type: string
      created_at:
        type: integer
      certificate_details:
        type: object
      active:
        type: boolean
  ChatCompletionDeleted:
    type: object
    required:
    - object
    - id
    - deleted
    properties:
      object:
        type: string
        enum:
        - chat.completion.deleted
      id:
        type: string
      deleted:
        type: boolean
  ChatCompletionFunctionCallOption:
    type: object
    description: 'Specifying a particular function via `{"name": "my_function"}` forces the model to call that function.'
    required:
    - name
    properties:
      name:
        type: string
  ChatCompletionFunctions:
    type: object
    required:
    - name
    properties:
      description:
        type: string
      name:
        type: string
      parameters:
        $ref: $FunctionParameters
  ChatCompletionList:
    type: object
    description: An object representing a list of Chat Completions.
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
        enum:
        - list
        default: list
      data:
        type: array
        items: $CreateChatCompletionResponse
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  ChatCompletionMessageList:
    type: object
    description: An object representing a list of chat completion messages.
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
        enum:
        - list
        default: list
      data:
        type: array
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  ChatCompletionMessageToolCall:
    type: object
    required:
    - id
    - type
    - function
    properties:
      id:
        type: string
      type:
        type: string
        enum:
        - function
      function:
        type: object
  ChatCompletionMessageToolCallChunk:
    type: object
    required:
    - index
    properties:
      index:
        type: integer
      id:
        type: string
      type:
        type: string
        enum:
        - function
      function:
        type: object
  ChatCompletionMessageToolCalls:
    type: array
    description: The tool calls generated by the model, such as function calls.
    items: $ChatCompletionMessageToolCall
  ChatCompletionModalities:
    type: array
    description: |-
      Output types that you would like the model to generate for this request.
      Most models are capable of generating text, ...
    items: string
  ChatCompletionNamedToolChoice:
    type: object
    description: Specifies a tool the model should use.
    required:
    - type
    - function
    properties:
      type:
        type: string
        enum:
        - function
      function:
        type: object
  ChatCompletionRequestAssistantMessage:
    type: object
    description: Messages sent by the model in response to user messages.
    required:
    - role
    properties:
      content:
        oneOf:
        - string
        - array
      refusal:
        type: string
        nullable: true
      role:
        type: string
        enum:
        - assistant
      name:
        type: string
      audio:
        type: object
        nullable: true
      tool_calls:
        $ref: $ChatCompletionMessageToolCalls
      function_call:
        type: object
        nullable: true
  ChatCompletionRequestAssistantMessageContentPart:
    oneOf:
    - $ChatCompletionRequestMessageContentPartText
    - $ChatCompletionRequestMessageContentPartRefusal
  ChatCompletionRequestDeveloperMessage:
    type: object
    description: |-
      Developer-provided instructions that the model should follow, regardless of
      messages sent by the user.
    required:
    - content
    - role
    properties:
      content:
        oneOf:
        - string
        - array
      role:
        type: string
        enum:
        - developer
      name:
        type: string
  ChatCompletionRequestFunctionMessage:
    type: object
    required:
    - role
    - content
    - name
    properties:
      role:
        type: string
        enum:
        - function
      content:
        type: string
        nullable: true
      name:
        type: string
  ChatCompletionRequestMessage:
    oneOf:
    - $ChatCompletionRequestDeveloperMessage
    - $ChatCompletionRequestSystemMessage
    - $ChatCompletionRequestUserMessage
    - $ChatCompletionRequestAssistantMessage
    - $ChatCompletionRequestToolMessage
    - $ChatCompletionRequestFunctionMessage
  ChatCompletionRequestMessageContentPartAudio:
    type: object
    description: Learn about [audio inputs](/docs/guides/audio).
    required:
    - type
    - input_audio
    properties:
      type:
        type: string
        enum:
        - input_audio
      input_audio:
        type: object
  ChatCompletionRequestMessageContentPartFile:
    type: object
    description: Learn about [file inputs](/docs/guides/text) for text generation.
    required:
    - type
    - file
    properties:
      type:
        type: string
        enum:
        - file
      file:
        type: object
  ChatCompletionRequestMessageContentPartImage:
    type: object
    description: Learn about [image inputs](/docs/guides/vision).
    required:
    - type
    - image_url
    properties:
      type:
        type: string
        enum:
        - image_url
      image_url:
        type: object
  ChatCompletionRequestMessageContentPartRefusal:
    type: object
    required:
    - type
    - refusal
    properties:
      type:
        type: string
        enum:
        - refusal
      refusal:
        type: string
  ChatCompletionRequestMessageContentPartText:
    type: object
    description: Learn about [text inputs](/docs/guides/text-generation).
    required:
    - type
    - text
    properties:
      type:
        type: string
        enum:
        - text
      text:
        type: string
  ChatCompletionRequestSystemMessage:
    type: object
    description: |-
      Developer-provided instructions that the model should follow, regardless of
      messages sent by the user.
    required:
    - content
    - role
    properties:
      content:
        oneOf:
        - string
        - array
      role:
        type: string
        enum:
        - system
      name:
        type: string
  ChatCompletionRequestSystemMessageContentPart:
    oneOf:
    - $ChatCompletionRequestMessageContentPartText
  ChatCompletionRequestToolMessage:
    type: object
    required:
    - role
    - content
    - tool_call_id
    properties:
      role:
        type: string
        enum:
        - tool
      content:
        oneOf:
        - string
        - array
      tool_call_id:
        type: string
  ChatCompletionRequestToolMessageContentPart:
    oneOf:
    - $ChatCompletionRequestMessageContentPartText
  ChatCompletionRequestUserMessage:
    type: object
    description: |-
      Messages sent by an end user, containing prompts or additional context
      information.
    required:
    - content
    - role
    properties:
      content:
        oneOf:
        - string
        - array
      role:
        type: string
        enum:
        - user
      name:
        type: string
  ChatCompletionRequestUserMessageContentPart:
    oneOf:
    - $ChatCompletionRequestMessageContentPartText
    - $ChatCompletionRequestMessageContentPartImage
    - $ChatCompletionRequestMessageContentPartAudio
    - $ChatCompletionRequestMessageContentPartFile
  ChatCompletionResponseMessage:
    type: object
    description: A chat completion message generated by the model.
    required:
    - role
    - content
    - refusal
    properties:
      content:
        type: string
        nullable: true
      refusal:
        type: string
        nullable: true
      tool_calls:
        $ref: $ChatCompletionMessageToolCalls
      annotations:
        type: array
        items: object
      role:
        type: string
        enum:
        - assistant
      function_call:
        type: object
      audio:
        type: object
        nullable: true
  ChatCompletionRole:
    type: string
    description: The role of the author of a message
    enum:
    - developer
    - system
    - user
    - assistant
    - tool
    - function
  ChatCompletionStreamOptions:
    type: object
    description: Options for streaming response.
    properties:
      include_usage:
        type: boolean
  ChatCompletionStreamResponseDelta:
    type: object
    description: A chat completion delta generated by streamed model responses.
    properties:
      content:
        type: string
        nullable: true
      function_call:
        type: object
      tool_calls:
        type: array
        items: $ChatCompletionMessageToolCallChunk
      role:
        type: string
        enum:
        - developer
        - system
        - user
        - assistant
        - tool
      refusal:
        type: string
        nullable: true
  ChatCompletionTokenLogprob:
    type: object
    required:
    - token
    - logprob
    - bytes
    - top_logprobs
    properties:
      token:
        type: string
      logprob:
        type: number
      bytes:
        type: array
        items: integer
        nullable: true
      top_logprobs:
        type: array
        items: object
  ChatCompletionTool:
    type: object
    required:
    - type
    - function
    properties:
      type:
        type: string
        enum:
        - function
      function:
        $ref: $FunctionObject
  ChatCompletionToolChoiceOption:
    oneOf:
    - string
    - $ChatCompletionNamedToolChoice
    description: |-
      Controls which (if any) tool is called by the model.
      `none` means the model will not call any tool and instead genera...
  ChunkingStrategyRequestParam:
    oneOf:
    - $AutoChunkingStrategyRequestParam
    - $StaticChunkingStrategyRequestParam
    type: object
    description: The chunking strategy used to chunk the file(s).
  Click:
    type: object
    description: A click action.
    required:
    - type
    - button
    - x
    - y
    properties:
      type:
        type: string
        enum:
        - click
        default: click
      button:
        type: string
        enum:
        - left
        - right
        - wheel
        - back
        - forward
      x:
        type: integer
      y:
        type: integer
  CodeInterpreterFileOutput:
    type: object
    description: The output of a code interpreter tool call that is a file.
    required:
    - type
    - files
    properties:
      type:
        type: string
        enum:
        - files
      files:
        type: array
        items: object
  CodeInterpreterTextOutput:
    type: object
    description: The output of a code interpreter tool call that is text.
    required:
    - type
    - logs
    properties:
      type:
        type: string
        enum:
        - logs
      logs:
        type: string
  CodeInterpreterToolCall:
    type: object
    description: A tool call to run code.
    required:
    - id
    - type
    - code
    - status
    - results
    properties:
      id:
        type: string
      type:
        type: string
        enum:
        - code_interpreter_call
      code:
        type: string
      status:
        type: string
        enum:
        - in_progress
        - interpreting
        - completed
      results:
        type: array
        items: $CodeInterpreterToolOutput
  CodeInterpreterToolOutput:
    oneOf:
    - $CodeInterpreterTextOutput
    - $CodeInterpreterFileOutput
  ComparisonFilter:
    type: object
    description: A filter used to compare a specified attribute key to a given value using a defined comparison operation.
    required:
    - type
    - key
    - value
    properties:
      type:
        type: string
        enum:
        - eq
        - ne
        - gt
        - gte
        - lt
        - lte
        default: eq
      key:
        type: string
      value:
        oneOf:
        - string
        - number
        - boolean
  CompleteUploadRequest:
    type: object
    required:
    - part_ids
    properties:
      part_ids:
        type: array
        items: string
      md5:
        type: string
  CompletionUsage:
    type: object
    description: Usage statistics for the completion request.
    required:
    - prompt_tokens
    - completion_tokens
    - total_tokens
    properties:
      completion_tokens:
        type: integer
        default: 0
      prompt_tokens:
        type: integer
        default: 0
      total_tokens:
        type: integer
        default: 0
      completion_tokens_details:
        type: object
      prompt_tokens_details:
        type: object
  CompoundFilter:
    type: object
    description: Combine multiple filters using `and` or `or`.
    required:
    - type
    - filters
    properties:
      type:
        type: string
        enum:
        - and
        - or
      filters:
        type: array
        items:
          oneOf:
          - $ComparisonFilter
          - '?'
  ComputerAction:
    oneOf:
    - $Click
    - $DoubleClick
    - $Drag
    - $KeyPress
    - $Move
    - $Screenshot
    - $Scroll
    - $Type
    - $Wait
  ComputerCallOutputItemParam:
    type: object
    description: The output of a computer tool call.
    required:
    - call_id
    - type
    - output
    properties:
      id:
        anyOf:
        - string
        - 'null'
      call_id:
        type: string
      type:
        type: string
        enum:
        - computer_call_output
        default: computer_call_output
      output:
        $ref: $ComputerScreenshotImage
      acknowledged_safety_checks:
        anyOf:
        - array
        - 'null'
      status:
        anyOf:
        - string
        - 'null'
  ComputerCallSafetyCheckParam:
    type: object
    description: A pending safety check for the computer call.
    required:
    - id
    properties:
      id:
        type: string
      code:
        anyOf:
        - string
        - 'null'
      message:
        anyOf:
        - string
        - 'null'
  ComputerScreenshotImage:
    type: object
    description: A computer screenshot image used with the computer use tool.
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - computer_screenshot
        default: computer_screenshot
      image_url:
        type: string
      file_id:
        type: string
  ComputerToolCall:
    type: object
    description: A tool call to a computer use tool.
    required:
    - type
    - id
    - action
    - call_id
    - pending_safety_checks
    - status
    properties:
      type:
        type: string
        enum:
        - computer_call
        default: computer_call
      id:
        type: string
      call_id:
        type: string
      action:
        $ref: $ComputerAction
      pending_safety_checks:
        type: array
        items: $ComputerToolCallSafetyCheck
      status:
        type: string
        enum:
        - in_progress
        - completed
        - incomplete
  ComputerToolCallOutput:
    type: object
    description: The output of a computer tool call.
    required:
    - type
    - call_id
    - output
    properties:
      type:
        type: string
        enum:
        - computer_call_output
        default: computer_call_output
      id:
        type: string
      call_id:
        type: string
      acknowledged_safety_checks:
        type: array
        items: $ComputerToolCallSafetyCheck
      output:
        $ref: $ComputerScreenshotImage
      status:
        type: string
        enum:
        - in_progress
        - completed
        - incomplete
  ComputerToolCallOutputResource:
    allOf:
    - $ComputerToolCallOutput
    - object
  ComputerToolCallSafetyCheck:
    type: object
    description: A pending safety check for the computer call.
    required:
    - id
    - code
    - message
    properties:
      id:
        type: string
      code:
        type: string
      message:
        type: string
  ComputerUsePreviewTool:
    type: object
    description: A tool that controls a virtual computer.
    required:
    - type
    - environment
    - display_width
    - display_height
    properties:
      type:
        type: string
        enum:
        - computer_use_preview
        default: computer_use_preview
      environment:
        type: string
        enum:
        - windows
        - mac
        - linux
        - ubuntu
        - browser
      display_width:
        type: integer
      display_height:
        type: integer
  Content:
    oneOf:
    - $InputContent
    - $OutputContent
    description: Multi-modal input and output contents.
  Coordinate:
    type: object
    description: An x/y coordinate pair, e.g.
    required:
    - x
    - y
    properties:
      x:
        type: integer
      y:
        type: integer
  CostsResult:
    type: object
    description: The aggregated costs details of the specific time bucket.
    required:
    - object
    properties:
      object:
        type: string
        enum:
        - organization.costs.result
      amount:
        type: object
      line_item:
        type: string
        nullable: true
      project_id:
        type: string
        nullable: true
  CreateAssistantRequest:
    type: object
    required:
    - model
    properties:
      model:
        anyOf:
        - string
        - $AssistantSupportedModels
      name:
        type: string
        nullable: true
      description:
        type: string
        nullable: true
      instructions:
        type: string
        nullable: true
      reasoning_effort:
        $ref: $ReasoningEffort
      tools:
        type: array
        items:
          oneOf:
          - $AssistantToolsCode
          - $AssistantToolsFileSearch
          - $AssistantToolsFunction
      tool_resources:
        type: object
        nullable: true
      metadata:
        $ref: $Metadata
      temperature:
        type: number
        nullable: true
        default: 1
      top_p:
        type: number
        nullable: true
        default: 1
      response_format:
        $ref: $AssistantsApiResponseFormatOption
  CreateChatCompletionRequest:
    allOf:
    - $CreateModelResponseProperties
    - object
  CreateChatCompletionResponse:
    type: object
    description: Represents a chat completion response returned by model, based on the provided input.
    required:
    - choices
    - created
    - id
    - model
    - object
    properties:
      id:
        type: string
      choices:
        type: array
        items: object
      created:
        type: integer
      model:
        type: string
      service_tier:
        $ref: $ServiceTier
      system_fingerprint:
        type: string
      object:
        type: string
        enum:
        - chat.completion
      usage:
        $ref: $CompletionUsage
  CreateChatCompletionStreamResponse:
    type: object
    description: |-
      Represents a streamed chunk of a chat completion response returned
      by the model, based on the provided input.
    required:
    - choices
    - created
    - id
    - model
    - object
    properties:
      id:
        type: string
      choices:
        type: array
        items: object
      created:
        type: integer
      model:
        type: string
      service_tier:
        $ref: $ServiceTier
      system_fingerprint:
        type: string
      object:
        type: string
        enum:
        - chat.completion.chunk
      usage:
        $ref: $CompletionUsage
  CreateCompletionRequest:
    type: object
    required:
    - model
    - prompt
    properties:
      model:
        anyOf:
        - string
        - string
      prompt:
        oneOf:
        - string
        - array
        - array
        - array
      best_of:
        type: integer
        nullable: true
        default: 1
      echo:
        type: boolean
        nullable: true
        default: false
      frequency_penalty:
        type: number
        nullable: true
        default: 0
      logit_bias:
        type: object
        nullable: true
      logprobs:
        type: integer
        nullable: true
      max_tokens:
        type: integer
        nullable: true
        default: 16
      n:
        type: integer
        nullable: true
        default: 1
      presence_penalty:
        type: number
        nullable: true
        default: 0
      seed:
        type: integer
        nullable: true
      stop:
        $ref: $StopConfiguration
      stream:
        type: boolean
        nullable: true
        default: false
      stream_options:
        $ref: $ChatCompletionStreamOptions
      suffix:
        type: string
        nullable: true
      temperature:
        type: number
        nullable: true
        default: 1
      top_p:
        type: number
        nullable: true
        default: 1
      user:
        type: string
  CreateCompletionResponse:
    type: object
    description: Represents a completion response from the API.
    required:
    - id
    - object
    - created
    - model
    - choices
    properties:
      id:
        type: string
      choices:
        type: array
        items: object
      created:
        type: integer
      model:
        type: string
      system_fingerprint:
        type: string
      object:
        type: string
        enum:
        - text_completion
      usage:
        $ref: $CompletionUsage
  CreateEmbeddingRequest:
    type: object
    required:
    - model
    - input
    properties:
      input:
        oneOf:
        - string
        - array
        - array
        - array
      model:
        anyOf:
        - string
        - string
      encoding_format:
        type: string
        enum:
        - float
        - base64
        default: float
      dimensions:
        type: integer
      user:
        type: string
  CreateEmbeddingResponse:
    type: object
    required:
    - object
    - model
    - data
    - usage
    properties:
      data:
        type: array
        items: $Embedding
      model:
        type: string
      object:
        type: string
        enum:
        - list
      usage:
        type: object
  CreateEvalCompletionsRunDataSource:
    type: object
    description: A CompletionsRunDataSource object describing a model sampling configuration.
    required:
    - type
    - source
    properties:
      type:
        type: string
        enum:
        - completions
        default: completions
      input_messages:
        oneOf:
        - object
        - object
      sampling_params:
        type: object
      model:
        type: string
      source:
        oneOf:
        - $EvalJsonlFileContentSource
        - $EvalJsonlFileIdSource
        - $EvalStoredCompletionsSource
  CreateEvalCustomDataSourceConfig:
    type: object
    description: A CustomDataSourceConfig object that defines the schema for the data source used for the evaluation runs.
    required:
    - item_schema
    - type
    properties:
      type:
        type: string
        enum:
        - custom
        default: custom
      item_schema:
        type: object
      include_sample_schema:
        type: boolean
        default: false
  CreateEvalItem:
    oneOf:
    - object
    - $EvalItem
    type: object
    description: A chat message that makes up the prompt or context.
  CreateEvalJsonlRunDataSource:
    type: object
    description: A JsonlRunDataSource object with that specifies a JSONL file that matches the eval
    required:
    - type
    - source
    properties:
      type:
        type: string
        enum:
        - jsonl
        default: jsonl
      source:
        oneOf:
        - $EvalJsonlFileContentSource
        - $EvalJsonlFileIdSource
  CreateEvalLabelModelGrader:
    type: object
    description: |-
      A LabelModelGrader object which uses a model to assign labels to each item
      in the evaluation.
    required:
    - type
    - model
    - input
    - passing_labels
    - labels
    - name
    properties:
      type:
        type: string
        enum:
        - label_model
      name:
        type: string
      model:
        type: string
      input:
        type: array
        items: $CreateEvalItem
      labels:
        type: array
        items: string
      passing_labels:
        type: array
        items: string
  CreateEvalLogsDataSourceConfig:
    type: object
    description: A data source config which specifies the metadata property of your stored completions query.
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - logs
        default: logs
      metadata:
        type: object
  CreateEvalRequest:
    type: object
    required:
    - data_source_config
    - testing_criteria
    properties:
      name:
        type: string
      metadata:
        $ref: $Metadata
      data_source_config:
        oneOf:
        - $CreateEvalCustomDataSourceConfig
        - $CreateEvalLogsDataSourceConfig
      testing_criteria:
        type: array
        items:
          oneOf:
          - $CreateEvalLabelModelGrader
          - $EvalStringCheckGrader
          - $EvalTextSimilarityGrader
          - $EvalPythonGrader
          - $EvalScoreModelGrader
  CreateEvalResponsesRunDataSource:
    type: object
    description: A ResponsesRunDataSource object describing a model sampling configuration.
    required:
    - type
    - source
    properties:
      type:
        type: string
        enum:
        - completions
        default: completions
      input_messages:
        oneOf:
        - object
        - object
      sampling_params:
        type: object
      model:
        type: string
      source:
        oneOf:
        - $EvalJsonlFileContentSource
        - $EvalJsonlFileIdSource
        - $EvalResponsesSource
  CreateEvalRunRequest:
    type: object
    required:
    - data_source
    properties:
      name:
        type: string
      metadata:
        $ref: $Metadata
      data_source:
        oneOf:
        - $CreateEvalJsonlRunDataSource
        - $CreateEvalCompletionsRunDataSource
        - $CreateEvalResponsesRunDataSource
  CreateFileRequest:
    type: object
    required:
    - file
    - purpose
    properties:
      file:
        type: string
      purpose:
        type: string
        enum:
        - assistants
        - batch
        - fine-tune
        - vision
        - user_data
        - evals
  CreateFineTuningCheckpointPermissionRequest:
    type: object
    required:
    - project_ids
    properties:
      project_ids:
        type: array
        items: string
  CreateFineTuningJobRequest:
    type: object
    required:
    - model
    - training_file
    properties:
      model:
        anyOf:
        - string
        - string
      training_file:
        type: string
      hyperparameters:
        type: object
      suffix:
        type: string
        nullable: true
      validation_file:
        type: string
        nullable: true
      integrations:
        type: array
        items: object
        nullable: true
      seed:
        type: integer
        nullable: true
      method:
        $ref: $FineTuneMethod
      metadata:
        $ref: $Metadata
  CreateImageEditRequest:
    type: object
    required:
    - prompt
    - image
    properties:
      image:
        anyOf:
        - string
        - array
      prompt:
        type: string
      mask:
        type: string
      model:
        anyOf:
        - string
        - string
      n:
        type: integer
        nullable: true
        default: 1
      size:
        type: string
        enum:
        - 256x256
        - 512x512
        - 1024x1024
        - 1536x1024
        - 1024x1536
        - auto
        nullable: true
        default: 1024x1024
      response_format:
        type: string
        enum:
        - url
        - b64_json
        nullable: true
        default: url
      user:
        type: string
      quality:
        type: string
        enum:
        - standard
        - low
        - medium
        - high
        - auto
        nullable: true
        default: auto
  CreateImageRequest:
    type: object
    required:
    - prompt
    properties:
      prompt:
        type: string
      model:
        anyOf:
        - string
        - string
      n:
        type: integer
        nullable: true
        default: 1
      quality:
        type: string
        enum:
        - standard
        - hd
        - low
        - medium
        - high
        - auto
        nullable: true
        default: auto
      response_format:
        type: string
        enum:
        - url
        - b64_json
        nullable: true
        default: url
      output_format:
        type: string
        enum:
        - png
        - jpeg
        - webp
        nullable: true
        default: png
      output_compression:
        type: integer
        nullable: true
        default: 100
      size:
        type: string
        enum:
        - auto
        - 1024x1024
        - 1536x1024
        - 1024x1536
        - 256x256
        - 512x512
        - 1792x1024
        - 1024x1792
        nullable: true
        default: auto
      moderation:
        type: string
        enum:
        - low
        - auto
        nullable: true
        default: auto
      background:
        type: string
        enum:
        - transparent
        - opaque
        - auto
        nullable: true
        default: auto
      style:
        type: string
        enum:
        - vivid
        - natural
        nullable: true
        default: vivid
      user:
        type: string
  CreateImageVariationRequest:
    type: object
    required:
    - image
    properties:
      image:
        type: string
      model:
        anyOf:
        - string
        - string
      n:
        type: integer
        nullable: true
        default: 1
      response_format:
        type: string
        enum:
        - url
        - b64_json
        nullable: true
        default: url
      size:
        type: string
        enum:
        - 256x256
        - 512x512
        - 1024x1024
        nullable: true
        default: 1024x1024
      user:
        type: string
  CreateMessageRequest:
    type: object
    required:
    - role
    - content
    properties:
      role:
        type: string
        enum:
        - user
        - assistant
      content:
        oneOf:
        - string
        - array
      attachments:
        type: array
        items: object
        nullable: true
      metadata:
        $ref: $Metadata
  CreateModelResponseProperties:
    allOf:
    - $ModelResponseProperties
  CreateModerationRequest:
    type: object
    required:
    - input
    properties:
      input:
        oneOf:
        - string
        - array
        - array
      model:
        anyOf:
        - string
        - string
  CreateModerationResponse:
    type: object
    description: Represents if a given text input is potentially harmful.
    required:
    - id
    - model
    - results
    properties:
      id:
        type: string
      model:
        type: string
      results:
        type: array
        items: object
  CreateResponse:
    allOf:
    - $CreateModelResponseProperties
    - $ResponseProperties
    - object
  CreateRunRequest:
    type: object
    required:
    - assistant_id
    properties:
      assistant_id:
        type: string
      model:
        anyOf:
        - string
        - $AssistantSupportedModels
      reasoning_effort:
        $ref: $ReasoningEffort
      instructions:
        type: string
        nullable: true
      additional_instructions:
        type: string
        nullable: true
      additional_messages:
        type: array
        items: $CreateMessageRequest
        nullable: true
      tools:
        type: array
        items:
          oneOf:
          - $AssistantToolsCode
          - $AssistantToolsFileSearch
          - $AssistantToolsFunction
        nullable: true
      metadata:
        $ref: $Metadata
      temperature:
        type: number
        nullable: true
        default: 1
      top_p:
        type: number
        nullable: true
        default: 1
      stream:
        type: boolean
        nullable: true
      max_prompt_tokens:
        type: integer
        nullable: true
      max_completion_tokens:
        type: integer
        nullable: true
      truncation_strategy:
        allOf:
        - $TruncationObject
        - '?'
      tool_choice:
        allOf:
        - $AssistantsApiToolChoiceOption
        - '?'
      parallel_tool_calls:
        $ref: $ParallelToolCalls
      response_format:
        $ref: $AssistantsApiResponseFormatOption
  CreateSpeechRequest:
    type: object
    required:
    - model
    - input
    - voice
    properties:
      model:
        anyOf:
        - string
        - string
      input:
        type: string
      instructions:
        type: string
      voice:
        $ref: $VoiceIdsShared
      response_format:
        type: string
        enum:
        - mp3
        - opus
        - aac
        - flac
        - wav
        - pcm
        default: mp3
      speed:
        type: number
        default: 1
  CreateThreadAndRunRequest:
    type: object
    required:
    - assistant_id
    properties:
      assistant_id:
        type: string
      thread:
        $ref: $CreateThreadRequest
      model:
        anyOf:
        - string
        - string
      instructions:
        type: string
        nullable: true
      tools:
        type: array
        items:
          oneOf:
          - $AssistantToolsCode
          - $AssistantToolsFileSearch
          - $AssistantToolsFunction
        nullable: true
      tool_resources:
        type: object
        nullable: true
      metadata:
        $ref: $Metadata
      temperature:
        type: number
        nullable: true
        default: 1
      top_p:
        type: number
        nullable: true
        default: 1
      stream:
        type: boolean
        nullable: true
      max_prompt_tokens:
        type: integer
        nullable: true
      max_completion_tokens:
        type: integer
        nullable: true
      truncation_strategy:
        allOf:
        - $TruncationObject
        - '?'
      tool_choice:
        allOf:
        - $AssistantsApiToolChoiceOption
        - '?'
      parallel_tool_calls:
        $ref: $ParallelToolCalls
      response_format:
        $ref: $AssistantsApiResponseFormatOption
  CreateThreadRequest:
    type: object
    description: Options to create a new thread.
    properties:
      messages:
        type: array
        items: $CreateMessageRequest
      tool_resources:
        type: object
        nullable: true
      metadata:
        $ref: $Metadata
  CreateTranscriptionRequest:
    type: object
    required:
    - file
    - model
    properties:
      file:
        type: string
      model:
        anyOf:
        - string
        - string
      language:
        type: string
      prompt:
        type: string
      response_format:
        $ref: $AudioResponseFormat
      temperature:
        type: number
        default: 0
      include[]:
        type: array
        items: $TranscriptionInclude
      timestamp_granularities[]:
        type: array
        items: string
      stream:
        type: boolean
        nullable: true
        default: false
  CreateTranscriptionResponseJson:
    type: object
    description: Represents a transcription response returned by model, based on the provided input.
    required:
    - text
    properties:
      text:
        type: string
      logprobs:
        type: array
        items: object
  CreateTranscriptionResponseStreamEvent:
    anyOf:
    - $TranscriptTextDeltaEvent
    - $TranscriptTextDoneEvent
  CreateTranscriptionResponseVerboseJson:
    type: object
    description: Represents a verbose json transcription response returned by model, based on the provided input.
    required:
    - language
    - duration
    - text
    properties:
      language:
        type: string
      duration:
        type: number
      text:
        type: string
      words:
        type: array
        items: $TranscriptionWord
      segments:
        type: array
        items: $TranscriptionSegment
  CreateTranslationRequest:
    type: object
    required:
    - file
    - model
    properties:
      file:
        type: string
      model:
        anyOf:
        - string
        - string
      prompt:
        type: string
      response_format:
        type: string
        enum:
        - json
        - text
        - srt
        - verbose_json
        - vtt
        default: json
      temperature:
        type: number
        default: 0
  CreateTranslationResponseJson:
    type: object
    required:
    - text
    properties:
      text:
        type: string
  CreateTranslationResponseVerboseJson:
    type: object
    required:
    - language
    - duration
    - text
    properties:
      language:
        type: string
      duration:
        type: number
      text:
        type: string
      segments:
        type: array
        items: $TranscriptionSegment
  CreateUploadRequest:
    type: object
    required:
    - filename
    - purpose
    - bytes
    - mime_type
    properties:
      filename:
        type: string
      purpose:
        type: string
        enum:
        - assistants
        - batch
        - fine-tune
        - vision
      bytes:
        type: integer
      mime_type:
        type: string
  CreateVectorStoreFileBatchRequest:
    type: object
    required:
    - file_ids
    properties:
      file_ids:
        type: array
        items: string
      chunking_strategy:
        $ref: $ChunkingStrategyRequestParam
      attributes:
        $ref: $VectorStoreFileAttributes
  CreateVectorStoreFileRequest:
    type: object
    required:
    - file_id
    properties:
      file_id:
        type: string
      chunking_strategy:
        $ref: $ChunkingStrategyRequestParam
      attributes:
        $ref: $VectorStoreFileAttributes
  CreateVectorStoreRequest:
    type: object
    properties:
      file_ids:
        type: array
        items: string
      name:
        type: string
      expires_after:
        $ref: $VectorStoreExpirationAfter
      chunking_strategy:
        oneOf:
        - $AutoChunkingStrategyRequestParam
        - $StaticChunkingStrategyRequestParam
      metadata:
        $ref: $Metadata
  DeleteAssistantResponse:
    type: object
    required:
    - id
    - object
    - deleted
    properties:
      id:
        type: string
      deleted:
        type: boolean
      object:
        type: string
        enum:
        - assistant.deleted
  DeleteCertificateResponse:
    type: object
    required:
    - object
    - id
    properties:
      object:
        type: string
        enum:
        - certificate.deleted
      id:
        type: string
  DeleteFileResponse:
    type: object
    required:
    - id
    - object
    - deleted
    properties:
      id:
        type: string
      object:
        type: string
        enum:
        - file
      deleted:
        type: boolean
  DeleteFineTuningCheckpointPermissionResponse:
    type: object
    required:
    - id
    - object
    - deleted
    properties:
      id:
        type: string
      object:
        type: string
        enum:
        - checkpoint.permission
      deleted:
        type: boolean
  DeleteMessageResponse:
    type: object
    required:
    - id
    - object
    - deleted
    properties:
      id:
        type: string
      deleted:
        type: boolean
      object:
        type: string
        enum:
        - thread.message.deleted
  DeleteModelResponse:
    type: object
    required:
    - id
    - object
    - deleted
    properties:
      id:
        type: string
      deleted:
        type: boolean
      object:
        type: string
  DeleteThreadResponse:
    type: object
    required:
    - id
    - object
    - deleted
    properties:
      id:
        type: string
      deleted:
        type: boolean
      object:
        type: string
        enum:
        - thread.deleted
  DeleteVectorStoreFileResponse:
    type: object
    required:
    - id
    - object
    - deleted
    properties:
      id:
        type: string
      deleted:
        type: boolean
      object:
        type: string
        enum:
        - vector_store.file.deleted
  DeleteVectorStoreResponse:
    type: object
    required:
    - id
    - object
    - deleted
    properties:
      id:
        type: string
      deleted:
        type: boolean
      object:
        type: string
        enum:
        - vector_store.deleted
  DoneEvent:
    type: object
    description: Occurs when a stream ends.
    required:
    - event
    - data
    properties:
      event:
        type: string
        enum:
        - done
      data:
        type: string
        enum:
        - '[DONE]'
  DoubleClick:
    type: object
    description: A double click action.
    required:
    - type
    - x
    - y
    properties:
      type:
        type: string
        enum:
        - double_click
        default: double_click
      x:
        type: integer
      y:
        type: integer
  Drag:
    type: object
    description: A drag action.
    required:
    - type
    - path
    properties:
      type:
        type: string
        enum:
        - drag
        default: drag
      path:
        type: array
        items: $Coordinate
  EasyInputMessage:
    type: object
    description: |-
      A message input to the model with a role indicating instruction following
      hierarchy.
    required:
    - role
    - content
    properties:
      role:
        type: string
        enum:
        - user
        - assistant
        - system
        - developer
      content:
        oneOf:
        - string
        - $InputMessageContentList
      type:
        type: string
        enum:
        - message
  Embedding:
    type: object
    description: Represents an embedding vector returned by embedding endpoint.
    required:
    - index
    - object
    - embedding
    properties:
      index:
        type: integer
      embedding:
        type: array
        items: number
      object:
        type: string
        enum:
        - embedding
  Error:
    type: object
    required:
    - type
    - message
    - param
    - code
    properties:
      code:
        type: string
        nullable: true
      message:
        type: string
      param:
        type: string
        nullable: true
      type:
        type: string
  ErrorEvent:
    type: object
    description: Occurs when an [error](/docs/guides/error-codes#api-errors) occurs.
    required:
    - event
    - data
    properties:
      event:
        type: string
        enum:
        - error
      data:
        $ref: $Error
  ErrorResponse:
    type: object
    required:
    - error
    properties:
      error:
        $ref: $Error
  Eval:
    type: object
    description: An Eval object with a data source config and testing criteria.
    required:
    - id
    - data_source_config
    - object
    - testing_criteria
    - name
    - created_at
    - metadata
    properties:
      object:
        type: string
        enum:
        - eval
        default: eval
      id:
        type: string
      name:
        type: string
      data_source_config:
        oneOf:
        - $EvalCustomDataSourceConfig
        - $EvalStoredCompletionsDataSourceConfig
      testing_criteria:
        type: array
        items:
          oneOf:
          - $EvalLabelModelGrader
          - $EvalStringCheckGrader
          - $EvalTextSimilarityGrader
          - $EvalPythonGrader
          - $EvalScoreModelGrader
        default: eval
      created_at:
        type: integer
      metadata:
        $ref: $Metadata
  EvalApiError:
    type: object
    description: An object representing an error response from the Eval API.
    required:
    - code
    - message
    properties:
      code:
        type: string
      message:
        type: string
  EvalCustomDataSourceConfig:
    type: object
    description: A CustomDataSourceConfig which specifies the schema of your `item` and optionally `sample` namespaces.
    required:
    - type
    - schema
    properties:
      type:
        type: string
        enum:
        - custom
        default: custom
      schema:
        type: object
  EvalItem:
    type: object
    description: |-
      A message input to the model with a role indicating instruction following
      hierarchy.
    required:
    - role
    - content
    properties:
      role:
        type: string
        enum:
        - user
        - assistant
        - system
        - developer
      content:
        oneOf:
        - string
        - $InputTextContent
        - object
      type:
        type: string
        enum:
        - message
  EvalJsonlFileContentSource:
    type: object
    required:
    - type
    - content
    properties:
      type:
        type: string
        enum:
        - file_content
        default: file_content
      content:
        type: array
        items: object
  EvalJsonlFileIdSource:
    type: object
    required:
    - type
    - id
    properties:
      type:
        type: string
        enum:
        - file_id
        default: file_id
      id:
        type: string
  EvalLabelModelGrader:
    type: object
    description: |-
      A LabelModelGrader object which uses a model to assign labels to each item
      in the evaluation.
    required:
    - type
    - model
    - input
    - passing_labels
    - labels
    - name
    properties:
      type:
        type: string
        enum:
        - label_model
      name:
        type: string
      model:
        type: string
      input:
        type: array
        items: $EvalItem
      labels:
        type: array
        items: string
      passing_labels:
        type: array
        items: string
  EvalList:
    type: object
    description: An object representing a list of evals.
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
        enum:
        - list
        default: list
      data:
        type: array
        items: $Eval
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  EvalPythonGrader:
    type: object
    description: A PythonGrader object that runs a python script on the input.
    required:
    - type
    - name
    - source
    properties:
      type:
        type: string
        enum:
        - python
      name:
        type: string
      source:
        type: string
      pass_threshold:
        type: number
      image_tag:
        type: string
  EvalResponsesSource:
    type: object
    description: A EvalResponsesSource object describing a run data source configuration.
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - responses
      metadata:
        type: object
        nullable: true
      model:
        type: string
        nullable: true
      instructions_search:
        type: string
        nullable: true
      created_after:
        type: integer
        nullable: true
      created_before:
        type: integer
        nullable: true
      has_tool_calls:
        type: boolean
        nullable: true
      reasoning_effort:
        $ref: $ReasoningEffort
      temperature:
        type: number
        nullable: true
      top_p:
        type: number
        nullable: true
      users:
        type: array
        items: string
        nullable: true
      allow_parallel_tool_calls:
        type: boolean
        nullable: true
  EvalRun:
    type: object
    description: A schema representing an evaluation run.
    required:
    - object
    - id
    - eval_id
    - status
    - model
    - name
    - created_at
    - report_url
    - result_counts
    - per_model_usage
    - per_testing_criteria_results
    - data_source
    - metadata
    - error
    properties:
      object:
        type: string
        enum:
        - eval.run
        default: eval.run
      id:
        type: string
      eval_id:
        type: string
      status:
        type: string
      model:
        type: string
      name:
        type: string
      created_at:
        type: integer
      report_url:
        type: string
      result_counts:
        type: object
      per_model_usage:
        type: array
        items: object
      per_testing_criteria_results:
        type: array
        items: object
      data_source:
        oneOf:
        - $CreateEvalJsonlRunDataSource
        - $CreateEvalCompletionsRunDataSource
        - $CreateEvalResponsesRunDataSource
      metadata:
        $ref: $Metadata
      error:
        $ref: $EvalApiError
  EvalRunList:
    type: object
    description: An object representing a list of runs for an evaluation.
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
        enum:
        - list
        default: list
      data:
        type: array
        items: $EvalRun
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  EvalRunOutputItem:
    type: object
    description: A schema representing an evaluation run output item.
    required:
    - object
    - id
    - run_id
    - eval_id
    - created_at
    - status
    - datasource_item_id
    - datasource_item
    - results
    - sample
    properties:
      object:
        type: string
        enum:
        - eval.run.output_item
        default: eval.run.output_item
      id:
        type: string
      run_id:
        type: string
      eval_id:
        type: string
      created_at:
        type: integer
      status:
        type: string
      datasource_item_id:
        type: integer
      datasource_item:
        type: object
      results:
        type: array
        items: object
      sample:
        type: object
  EvalRunOutputItemList:
    type: object
    description: An object representing a list of output items for an evaluation run.
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
        enum:
        - list
        default: list
      data:
        type: array
        items: $EvalRunOutputItem
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  EvalScoreModelGrader:
    type: object
    description: A ScoreModelGrader object that uses a model to assign a score to the input.
    required:
    - type
    - name
    - input
    - model
    properties:
      type:
        type: string
        enum:
        - score_model
      name:
        type: string
      model:
        type: string
      sampling_params:
        type: object
      input:
        type: array
        items: $EvalItem
      pass_threshold:
        type: number
      range:
        type: array
        items: number
  EvalStoredCompletionsDataSourceConfig:
    type: object
    description: A StoredCompletionsDataSourceConfig which specifies the metadata property of your stored completions query.
    required:
    - type
    - schema
    properties:
      type:
        type: string
        enum:
        - stored_completions
        default: stored_completions
      metadata:
        $ref: $Metadata
      schema:
        type: object
  EvalStoredCompletionsSource:
    type: object
    description: A StoredCompletionsRunDataSource configuration describing a set of filters
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - stored_completions
        default: stored_completions
      metadata:
        $ref: $Metadata
      model:
        type: string
        nullable: true
      created_after:
        type: integer
        nullable: true
      created_before:
        type: integer
        nullable: true
      limit:
        type: integer
        nullable: true
  EvalStringCheckGrader:
    type: object
    description: A StringCheckGrader object that performs a string comparison between input and reference using a specified
      operation.
    required:
    - type
    - name
    - input
    - reference
    - operation
    properties:
      type:
        type: string
        enum:
        - string_check
      name:
        type: string
      input:
        type: string
      reference:
        type: string
      operation:
        type: string
        enum:
        - eq
        - ne
        - like
        - ilike
  EvalTextSimilarityGrader:
    type: object
    description: A TextSimilarityGrader object which grades text based on similarity metrics.
    required:
    - type
    - input
    - reference
    - pass_threshold
    - evaluation_metric
    properties:
      type:
        type: string
        enum:
        - text_similarity
        default: text_similarity
      name:
        type: string
      input:
        type: string
      reference:
        type: string
      pass_threshold:
        type: number
      evaluation_metric:
        type: string
        enum:
        - fuzzy_match
        - bleu
        - gleu
        - meteor
        - rouge_1
        - rouge_2
        - rouge_3
        - rouge_4
        - rouge_5
        - rouge_l
  FileCitationBody:
    type: object
    description: A citation to a file.
    required:
    - type
    - file_id
    - index
    properties:
      type:
        type: string
        enum:
        - file_citation
        default: file_citation
      file_id:
        type: string
      index:
        type: integer
  FilePath:
    type: object
    description: A path to a file.
    required:
    - type
    - file_id
    - index
    properties:
      type:
        type: string
        enum:
        - file_path
      file_id:
        type: string
      index:
        type: integer
  FileSearchRanker:
    type: string
    description: The ranker to use for the file search.
    enum:
    - auto
    - default_2024_08_21
  FileSearchRankingOptions:
    type: object
    description: The ranking options for the file search.
    required:
    - score_threshold
    properties:
      ranker:
        $ref: $FileSearchRanker
      score_threshold:
        type: number
  FileSearchTool:
    type: object
    description: A tool that searches for relevant content from uploaded files.
    required:
    - type
    - vector_store_ids
    properties:
      type:
        type: string
        enum:
        - file_search
        default: file_search
      vector_store_ids:
        type: array
        items: string
      max_num_results:
        type: integer
      ranking_options:
        $ref: $RankingOptions
      filters:
        anyOf:
        - $Filters
        - 'null'
  FileSearchToolCall:
    type: object
    description: The results of a file search tool call.
    required:
    - id
    - type
    - status
    - queries
    properties:
      id:
        type: string
      type:
        type: string
        enum:
        - file_search_call
      status:
        type: string
        enum:
        - in_progress
        - searching
        - completed
        - incomplete
        - failed
      queries:
        type: array
        items: string
      results:
        type: array
        items: object
        nullable: true
  Filters:
    anyOf:
    - $ComparisonFilter
    - $CompoundFilter
  FineTuneChatCompletionRequestAssistantMessage:
    allOf:
    - object
    - $ChatCompletionRequestAssistantMessage
    required:
    - role
  FineTuneChatRequestInput:
    type: object
    description: The per-line training example of a fine-tuning input file for chat models using the supervised method.
    properties:
      messages:
        type: array
        items:
          oneOf:
          - $ChatCompletionRequestSystemMessage
          - $ChatCompletionRequestUserMessage
          - $FineTuneChatCompletionRequestAssistantMessage
          - $ChatCompletionRequestToolMessage
          - $ChatCompletionRequestFunctionMessage
      tools:
        type: array
        items: $ChatCompletionTool
      parallel_tool_calls:
        $ref: $ParallelToolCalls
      functions:
        type: array
        items: $ChatCompletionFunctions
  FineTuneCompletionRequestInput:
    type: object
    description: The per-line training example of a fine-tuning input file for completions models
    properties:
      prompt:
        type: string
      completion:
        type: string
  FineTuneDPOMethod:
    type: object
    description: Configuration for the DPO fine-tuning method.
    properties:
      hyperparameters:
        type: object
  FineTuneMethod:
    type: object
    description: The method used for fine-tuning.
    properties:
      type:
        type: string
        enum:
        - supervised
        - dpo
      supervised:
        $ref: $FineTuneSupervisedMethod
      dpo:
        $ref: $FineTuneDPOMethod
  FineTunePreferenceRequestInput:
    type: object
    description: The per-line training example of a fine-tuning input file for chat models using the dpo method.
    properties:
      input:
        type: object
      preferred_completion:
        type: array
        items:
          oneOf:
          - $ChatCompletionRequestAssistantMessage
      non_preferred_completion:
        type: array
        items:
          oneOf:
          - $ChatCompletionRequestAssistantMessage
  FineTuneSupervisedMethod:
    type: object
    description: Configuration for the supervised fine-tuning method.
    properties:
      hyperparameters:
        type: object
  FineTuningCheckpointPermission:
    type: object
    description: The `checkpoint.permission` object represents a permission for a fine-tuned model checkpoint.
    required:
    - created_at
    - id
    - object
    - project_id
    properties:
      id:
        type: string
      created_at:
        type: integer
      project_id:
        type: string
      object:
        type: string
        enum:
        - checkpoint.permission
  FineTuningIntegration:
    type: object
    required:
    - type
    - wandb
    properties:
      type:
        type: string
        enum:
        - wandb
      wandb:
        type: object
  FineTuningJob:
    type: object
    description: The `fine_tuning.job` object represents a fine-tuning job that has been created through the API.
    required:
    - created_at
    - error
    - finished_at
    - fine_tuned_model
    - hyperparameters
    - id
    - model
    - object
    - organization_id
    - result_files
    - status
    - trained_tokens
    - training_file
    - validation_file
    - seed
    properties:
      id:
        type: string
      created_at:
        type: integer
      error:
        type: object
        nullable: true
      fine_tuned_model:
        type: string
        nullable: true
      finished_at:
        type: integer
        nullable: true
      hyperparameters:
        type: object
      model:
        type: string
      object:
        type: string
        enum:
        - fine_tuning.job
      organization_id:
        type: string
      result_files:
        type: array
        items: string
      status:
        type: string
        enum:
        - validating_files
        - queued
        - running
        - succeeded
        - failed
        - cancelled
      trained_tokens:
        type: integer
        nullable: true
      training_file:
        type: string
      validation_file:
        type: string
        nullable: true
      integrations:
        type: array
        items:
          oneOf:
          - $FineTuningIntegration
        nullable: true
      seed:
        type: integer
      estimated_finish:
        type: integer
        nullable: true
      method:
        $ref: $FineTuneMethod
      metadata:
        $ref: $Metadata
  FineTuningJobCheckpoint:
    type: object
    description: The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine-tuning job that is ready
      to use.
    required:
    - created_at
    - fine_tuning_job_id
    - fine_tuned_model_checkpoint
    - id
    - metrics
    - object
    - step_number
    properties:
      id:
        type: string
      created_at:
        type: integer
      fine_tuned_model_checkpoint:
        type: string
      step_number:
        type: integer
      metrics:
        type: object
      fine_tuning_job_id:
        type: string
      object:
        type: string
        enum:
        - fine_tuning.job.checkpoint
  FineTuningJobEvent:
    type: object
    description: Fine-tuning job event object
    required:
    - id
    - object
    - created_at
    - level
    - message
    properties:
      object:
        type: string
        enum:
        - fine_tuning.job.event
      id:
        type: string
      created_at:
        type: integer
      level:
        type: string
        enum:
        - info
        - warn
        - error
      message:
        type: string
      type:
        type: string
        enum:
        - message
        - metrics
      data:
        type: object
  FunctionCallOutputItemParam:
    type: object
    description: The output of a function tool call.
    required:
    - call_id
    - type
    - output
    properties:
      id:
        anyOf:
        - string
        - 'null'
      call_id:
        type: string
      type:
        type: string
        enum:
        - function_call_output
        default: function_call_output
      output:
        type: string
      status:
        anyOf:
        - string
        - 'null'
  FunctionObject:
    type: object
    required:
    - name
    properties:
      description:
        type: string
      name:
        type: string
      parameters:
        $ref: $FunctionParameters
      strict:
        type: boolean
        nullable: true
        default: false
  FunctionParameters:
    type: object
    description: The parameters the functions accepts, described as a JSON Schema object.
  FunctionTool:
    type: object
    description: Defines a function in your own code the model can choose to call.
    required:
    - type
    - name
    - strict
    - parameters
    properties:
      type:
        type: string
        enum:
        - function
        default: function
      name:
        type: string
      description:
        anyOf:
        - string
        - 'null'
      parameters:
        anyOf:
        - object
        - 'null'
      strict:
        anyOf:
        - boolean
        - 'null'
  FunctionToolCall:
    type: object
    description: A tool call to run a function.
    required:
    - type
    - call_id
    - name
    - arguments
    properties:
      id:
        type: string
      type:
        type: string
        enum:
        - function_call
      call_id:
        type: string
      name:
        type: string
      arguments:
        type: string
      status:
        type: string
        enum:
        - in_progress
        - completed
        - incomplete
  FunctionToolCallOutput:
    type: object
    description: The output of a function tool call.
    required:
    - type
    - call_id
    - output
    properties:
      id:
        type: string
      type:
        type: string
        enum:
        - function_call_output
      call_id:
        type: string
      output:
        type: string
      status:
        type: string
        enum:
        - in_progress
        - completed
        - incomplete
  FunctionToolCallOutputResource:
    allOf:
    - $FunctionToolCallOutput
    - object
  FunctionToolCallResource:
    allOf:
    - $FunctionToolCall
    - object
  Image:
    type: object
    description: Represents the content or the URL of an image generated by the OpenAI API.
    properties:
      b64_json:
        type: string
      url:
        type: string
      revised_prompt:
        type: string
  ImagesResponse:
    type: object
    description: The response from the image generation endpoint.
    required:
    - created
    properties:
      created:
        type: integer
      data:
        type: array
        items: $Image
      usage:
        type: object
  Includable:
    type: string
    description: Specify additional output data to include in the model response.
    enum:
    - file_search_call.results
    - message.input_image.image_url
    - computer_call_output.output.image_url
  InputAudio:
    type: object
    description: An audio input to the model.
    required:
    - type
    - data
    - format
    properties:
      type:
        type: string
        enum:
        - input_audio
      data:
        type: string
      format:
        type: string
        enum:
        - mp3
        - wav
  InputContent:
    oneOf:
    - $InputTextContent
    - $InputImageContent
    - $InputFileContent
  InputFileContent:
    type: object
    description: A file input to the model.
    required: *id001
    properties:
      type:
        type: string
        enum:
        - input_file
        default: input_file
      file_id:
        anyOf:
        - string
        - 'null'
      filename:
        type: string
      file_data:
        type: string
  InputImageContent:
    type: object
    description: An image input to the model.
    required:
    - type
    - detail
    properties:
      type:
        type: string
        enum:
        - input_image
        default: input_image
      image_url:
        anyOf:
        - string
        - 'null'
      file_id:
        anyOf:
        - string
        - 'null'
      detail:
        type: string
        enum:
        - low
        - high
        - auto
  InputItem:
    oneOf:
    - $EasyInputMessage
    - $Item
    - $ItemReferenceParam
  InputMessage:
    type: object
    description: |-
      A message input to the model with a role indicating instruction following
      hierarchy.
    required:
    - role
    - content
    properties:
      type:
        type: string
        enum:
        - message
      role:
        type: string
        enum:
        - user
        - system
        - developer
      status:
        type: string
        enum:
        - in_progress
        - completed
        - incomplete
      content:
        $ref: $InputMessageContentList
  InputMessageContentList:
    type: array
    description: "A list of one or many input items to the model, containing different content \ntypes."
    items: $InputContent
  InputMessageResource:
    allOf:
    - $InputMessage
    - object
  InputTextContent:
    type: object
    description: A text input to the model.
    required:
    - type
    - text
    properties:
      type:
        type: string
        enum:
        - input_text
        default: input_text
      text:
        type: string
  Invite:
    type: object
    description: Represents an individual `invite` to the organization.
    required:
    - object
    - id
    - email
    - role
    - status
    - invited_at
    - expires_at
    properties:
      object:
        type: string
        enum:
        - organization.invite
      id:
        type: string
      email:
        type: string
      role:
        type: string
        enum:
        - owner
        - reader
      status:
        type: string
        enum:
        - accepted
        - expired
        - pending
      invited_at:
        type: integer
      expires_at:
        type: integer
      accepted_at:
        type: integer
      projects:
        type: array
        items: object
  InviteDeleteResponse:
    type: object
    required:
    - object
    - id
    - deleted
    properties:
      object:
        type: string
        enum:
        - organization.invite.deleted
      id:
        type: string
      deleted:
        type: boolean
  InviteListResponse:
    type: object
    required:
    - object
    - data
    properties:
      object:
        type: string
        enum:
        - list
      data:
        type: array
        items: $Invite
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  InviteRequest:
    type: object
    required:
    - email
    - role
    properties:
      email:
        type: string
      role:
        type: string
        enum:
        - reader
        - owner
      projects:
        type: array
        items: object
  Item:
    oneOf:
    - $InputMessage
    - $OutputMessage
    - $FileSearchToolCall
    - $ComputerToolCall
    - $ComputerCallOutputItemParam
    - $WebSearchToolCall
    - $FunctionToolCall
    - $FunctionCallOutputItemParam
    - $ReasoningItem
    type: object
    description: Content item used to generate a response.
  ItemReferenceParam:
    type: object
    description: An internal identifier for an item to reference.
    required:
    - id
    properties:
      type:
        anyOf:
        - string
        - 'null'
      id:
        type: string
  ItemResource:
    oneOf:
    - $InputMessageResource
    - $OutputMessage
    - $FileSearchToolCall
    - $ComputerToolCall
    - $ComputerToolCallOutputResource
    - $WebSearchToolCall
    - $FunctionToolCallResource
    - $FunctionToolCallOutputResource
    description: Content item used to generate a response.
  KeyPress:
    type: object
    description: A collection of keypresses the model would like to perform.
    required:
    - type
    - keys
    properties:
      type:
        type: string
        enum:
        - keypress
        default: keypress
      keys:
        type: array
        items: string
  ListAssistantsResponse:
    type: object
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
      data:
        type: array
        items: $AssistantObject
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  ListAuditLogsResponse:
    type: object
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
        enum:
        - list
      data:
        type: array
        items: $AuditLog
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  ListBatchesResponse:
    type: object
    required:
    - object
    - data
    - has_more
    properties:
      data:
        type: array
        items: $Batch
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
      object:
        type: string
        enum:
        - list
  ListCertificatesResponse:
    type: object
    required:
    - object
    - data
    - has_more
    properties:
      data:
        type: array
        items: $Certificate
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
      object:
        type: string
        enum:
        - list
  ListFilesResponse:
    type: object
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
      data:
        type: array
        items: $OpenAIFile
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  ListFineTuningCheckpointPermissionResponse:
    type: object
    required:
    - object
    - data
    - has_more
    properties:
      data:
        type: array
        items: $FineTuningCheckpointPermission
      object:
        type: string
        enum:
        - list
      first_id:
        type: string
        nullable: true
      last_id:
        type: string
        nullable: true
      has_more:
        type: boolean
  ListFineTuningJobCheckpointsResponse:
    type: object
    required:
    - object
    - data
    - has_more
    properties:
      data:
        type: array
        items: $FineTuningJobCheckpoint
      object:
        type: string
        enum:
        - list
      first_id:
        type: string
        nullable: true
      last_id:
        type: string
        nullable: true
      has_more:
        type: boolean
  ListFineTuningJobEventsResponse:
    type: object
    required:
    - object
    - data
    - has_more
    properties:
      data:
        type: array
        items: $FineTuningJobEvent
      object:
        type: string
        enum:
        - list
      has_more:
        type: boolean
  ListMessagesResponse:
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
      data:
        type: array
        items: $MessageObject
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  ListModelsResponse:
    type: object
    required:
    - object
    - data
    properties:
      object:
        type: string
        enum:
        - list
      data:
        type: array
        items: $Model
  ListPaginatedFineTuningJobsResponse:
    type: object
    required:
    - object
    - data
    - has_more
    properties:
      data:
        type: array
        items: $FineTuningJob
      has_more:
        type: boolean
      object:
        type: string
        enum:
        - list
  ListRunStepsResponse:
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
      data:
        type: array
        items: $RunStepObject
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  ListRunsResponse:
    type: object
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
      data:
        type: array
        items: $RunObject
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  ListVectorStoreFilesResponse:
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
      data:
        type: array
        items: $VectorStoreFileObject
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  ListVectorStoresResponse:
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
      data:
        type: array
        items: $VectorStoreObject
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  LogProbProperties:
    type: object
    description: A log probability object.
    required:
    - token
    - logprob
    - bytes
    properties:
      token:
        type: string
      logprob:
        type: number
      bytes:
        type: array
        items: integer
  MessageContentImageFileObject:
    type: object
    description: References an image [File](/docs/api-reference/files) in the content of a message.
    required:
    - type
    - image_file
    properties:
      type:
        type: string
        enum:
        - image_file
      image_file:
        type: object
  MessageContentImageUrlObject:
    type: object
    description: References an image URL in the content of a message.
    required:
    - type
    - image_url
    properties:
      type:
        type: string
        enum:
        - image_url
      image_url:
        type: object
  MessageContentRefusalObject:
    type: object
    description: The refusal content generated by the assistant.
    required:
    - type
    - refusal
    properties:
      type:
        type: string
        enum:
        - refusal
      refusal:
        type: string
  MessageContentTextAnnotationsFileCitationObject:
    type: object
    description: A citation within the message that points to a specific quote from a specific File associated with the assistant
      or t...
    required:
    - type
    - text
    - file_citation
    - start_index
    - end_index
    properties:
      type:
        type: string
        enum:
        - file_citation
      text:
        type: string
      file_citation:
        type: object
      start_index:
        type: integer
      end_index:
        type: integer
  MessageContentTextAnnotationsFilePathObject:
    type: object
    description: A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.
    required:
    - type
    - text
    - file_path
    - start_index
    - end_index
    properties:
      type:
        type: string
        enum:
        - file_path
      text:
        type: string
      file_path:
        type: object
      start_index:
        type: integer
      end_index:
        type: integer
  MessageContentTextObject:
    type: object
    description: The text content that is part of a message.
    required:
    - type
    - text
    properties:
      type:
        type: string
        enum:
        - text
      text:
        type: object
  MessageDeltaContentImageFileObject:
    type: object
    description: References an image [File](/docs/api-reference/files) in the content of a message.
    required:
    - index
    - type
    properties:
      index:
        type: integer
      type:
        type: string
        enum:
        - image_file
      image_file:
        type: object
  MessageDeltaContentImageUrlObject:
    type: object
    description: References an image URL in the content of a message.
    required:
    - index
    - type
    properties:
      index:
        type: integer
      type:
        type: string
        enum:
        - image_url
      image_url:
        type: object
  MessageDeltaContentRefusalObject:
    type: object
    description: The refusal content that is part of a message.
    required:
    - index
    - type
    properties:
      index:
        type: integer
      type:
        type: string
        enum:
        - refusal
      refusal:
        type: string
  MessageDeltaContentTextAnnotationsFileCitationObject:
    type: object
    description: A citation within the message that points to a specific quote from a specific File associated with the assistant
      or t...
    required:
    - index
    - type
    properties:
      index:
        type: integer
      type:
        type: string
        enum:
        - file_citation
      text:
        type: string
      file_citation:
        type: object
      start_index:
        type: integer
      end_index:
        type: integer
  MessageDeltaContentTextAnnotationsFilePathObject:
    type: object
    description: A URL for the file that's generated when the assistant used the `code_interpreter` tool to generate a file.
    required:
    - index
    - type
    properties:
      index:
        type: integer
      type:
        type: string
        enum:
        - file_path
      text:
        type: string
      file_path:
        type: object
      start_index:
        type: integer
      end_index:
        type: integer
  MessageDeltaContentTextObject:
    type: object
    description: The text content that is part of a message.
    required:
    - index
    - type
    properties:
      index:
        type: integer
      type:
        type: string
        enum:
        - text
      text:
        type: object
  MessageDeltaObject:
    type: object
    description: Represents a message delta i.e.
    required:
    - id
    - object
    - delta
    properties:
      id:
        type: string
      object:
        type: string
        enum:
        - thread.message.delta
      delta:
        type: object
  MessageObject:
    type: object
    description: Represents a message within a [thread](/docs/api-reference/threads).
    required:
    - id
    - object
    - created_at
    - thread_id
    - status
    - incomplete_details
    - completed_at
    - incomplete_at
    - role
    - content
    - assistant_id
    - run_id
    - attachments
    - metadata
    properties:
      id:
        type: string
      object:
        type: string
        enum:
        - thread.message
      created_at:
        type: integer
      thread_id:
        type: string
      status:
        type: string
        enum:
        - in_progress
        - incomplete
        - completed
      incomplete_details:
        type: object
        nullable: true
      completed_at:
        type: integer
        nullable: true
      incomplete_at:
        type: integer
        nullable: true
      role:
        type: string
        enum:
        - user
        - assistant
      content:
        type: array
        items:
          oneOf:
          - $MessageContentImageFileObject
          - $MessageContentImageUrlObject
          - $MessageContentTextObject
          - $MessageContentRefusalObject
      assistant_id:
        type: string
        nullable: true
      run_id:
        type: string
        nullable: true
      attachments:
        type: array
        items: object
        nullable: true
      metadata:
        $ref: $Metadata
  MessageRequestContentTextObject:
    type: object
    description: The text content that is part of a message.
    required:
    - type
    - text
    properties:
      type:
        type: string
        enum:
        - text
      text:
        type: string
  MessageStreamEvent:
    oneOf:
    - object
    - object
    - object
    - object
    - object
  Metadata:
    type: object
    description: Set of 16 key-value pairs that can be attached to an object.
    additionalProperties: string
  Model:
    description: Describes an OpenAI model offering that can be used with the API.
    required:
    - id
    - object
    - created
    - owned_by
    properties:
      id:
        type: string
      created:
        type: integer
      object:
        type: string
        enum:
        - model
      owned_by:
        type: string
  ModelIds:
    anyOf:
    - $ModelIdsShared
    - $ModelIdsResponses
  ModelIdsResponses:
    anyOf:
    - $ModelIdsShared
    - string
  ModelIdsShared:
    anyOf:
    - string
    - string
  ModelResponseProperties:
    type: object
    properties:
      metadata:
        $ref: $Metadata
      temperature:
        type: number
        nullable: true
        default: 1
      top_p:
        type: number
        nullable: true
        default: 1
      user:
        type: string
      service_tier:
        $ref: $ServiceTier
  ModifyAssistantRequest:
    type: object
    properties:
      model:
        anyOf:
        - string
        - $AssistantSupportedModels
      reasoning_effort:
        $ref: $ReasoningEffort
      name:
        type: string
        nullable: true
      description:
        type: string
        nullable: true
      instructions:
        type: string
        nullable: true
      tools:
        type: array
        items:
          oneOf:
          - $AssistantToolsCode
          - $AssistantToolsFileSearch
          - $AssistantToolsFunction
      tool_resources:
        type: object
        nullable: true
      metadata:
        $ref: $Metadata
      temperature:
        type: number
        nullable: true
        default: 1
      top_p:
        type: number
        nullable: true
        default: 1
      response_format:
        $ref: $AssistantsApiResponseFormatOption
  ModifyCertificateRequest:
    type: object
    required:
    - name
    properties:
      name:
        type: string
  ModifyMessageRequest:
    type: object
    properties:
      metadata:
        $ref: $Metadata
  ModifyRunRequest:
    type: object
    properties:
      metadata:
        $ref: $Metadata
  ModifyThreadRequest:
    type: object
    properties:
      tool_resources:
        type: object
        nullable: true
      metadata:
        $ref: $Metadata
  Move:
    type: object
    description: A mouse move action.
    required:
    - type
    - x
    - y
    properties:
      type:
        type: string
        enum:
        - move
        default: move
      x:
        type: integer
      y:
        type: integer
  OpenAIFile:
    description: The `File` object represents a document that has been uploaded to OpenAI.
    required:
    - id
    - object
    - bytes
    - created_at
    - filename
    - purpose
    - status
    properties:
      id:
        type: string
      bytes:
        type: integer
      created_at:
        type: integer
      expires_at:
        type: integer
      filename:
        type: string
      object:
        type: string
        enum:
        - file
      purpose:
        type: string
        enum:
        - assistants
        - assistants_output
        - batch
        - batch_output
        - fine-tune
        - fine-tune-results
        - vision
      status:
        type: string
        enum:
        - uploaded
        - processed
        - error
      status_details:
        type: string
  OtherChunkingStrategyResponseParam:
    type: object
    description: This is returned when the chunking strategy is unknown.
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - other
  OutputAudio:
    type: object
    description: An audio output from the model.
    required:
    - type
    - data
    - transcript
    properties:
      type:
        type: string
        enum:
        - output_audio
      data:
        type: string
      transcript:
        type: string
  OutputContent:
    oneOf:
    - $OutputTextContent
    - $RefusalContent
  OutputItem:
    anyOf:
    - $OutputMessage
    - $FileSearchToolCall
    - $FunctionToolCall
    - $WebSearchToolCall
    - $ComputerToolCall
    - $ReasoningItem
  OutputMessage:
    type: object
    description: An output message from the model.
    required:
    - id
    - type
    - role
    - content
    - status
    properties:
      id:
        type: string
      type:
        type: string
        enum:
        - message
      role:
        type: string
        enum:
        - assistant
      content:
        type: array
        items: $OutputContent
      status:
        type: string
        enum:
        - in_progress
        - completed
        - incomplete
  OutputTextContent:
    type: object
    description: A text output from the model.
    required:
    - type
    - text
    - annotations
    properties:
      type:
        type: string
        enum:
        - output_text
        default: output_text
      text:
        type: string
      annotations:
        type: array
        items: $Annotation
  ParallelToolCalls:
    type: boolean
    description: Whether to enable [parallel function calling](/docs/guides/function-calling#configuring-parallel-function-calling)
      du...
  PredictionContent:
    type: object
    description: |-
      Static predicted output content, such as the content of a text file that is
      being regenerated.
    required:
    - type
    - content
    properties:
      type:
        type: string
        enum:
        - content
      content:
        oneOf:
        - string
        - array
  Project:
    type: object
    description: Represents an individual project.
    required:
    - id
    - object
    - name
    - created_at
    - status
    properties:
      id:
        type: string
      object:
        type: string
        enum:
        - organization.project
      name:
        type: string
      created_at:
        type: integer
      archived_at:
        type: integer
        nullable: true
      status:
        type: string
        enum:
        - active
        - archived
  ProjectApiKey:
    type: object
    description: Represents an individual API key in a project.
    required:
    - object
    - redacted_value
    - name
    - created_at
    - last_used_at
    - id
    - owner
    properties:
      object:
        type: string
        enum:
        - organization.project.api_key
      redacted_value:
        type: string
      name:
        type: string
      created_at:
        type: integer
      last_used_at:
        type: integer
      id:
        type: string
      owner:
        type: object
  ProjectApiKeyDeleteResponse:
    type: object
    required:
    - object
    - id
    - deleted
    properties:
      object:
        type: string
        enum:
        - organization.project.api_key.deleted
      id:
        type: string
      deleted:
        type: boolean
  ProjectApiKeyListResponse:
    type: object
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
        enum:
        - list
      data:
        type: array
        items: $ProjectApiKey
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  ProjectCreateRequest:
    type: object
    required:
    - name
    properties:
      name:
        type: string
  ProjectListResponse:
    type: object
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
        enum:
        - list
      data:
        type: array
        items: $Project
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  ProjectRateLimit:
    type: object
    description: Represents a project rate limit config.
    required:
    - object
    - id
    - model
    - max_requests_per_1_minute
    - max_tokens_per_1_minute
    properties:
      object:
        type: string
        enum:
        - project.rate_limit
      id:
        type: string
      model:
        type: string
      max_requests_per_1_minute:
        type: integer
      max_tokens_per_1_minute:
        type: integer
      max_images_per_1_minute:
        type: integer
      max_audio_megabytes_per_1_minute:
        type: integer
      max_requests_per_1_day:
        type: integer
      batch_1_day_max_input_tokens:
        type: integer
  ProjectRateLimitListResponse:
    type: object
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
        enum:
        - list
      data:
        type: array
        items: $ProjectRateLimit
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  ProjectRateLimitUpdateRequest:
    type: object
    properties:
      max_requests_per_1_minute:
        type: integer
      max_tokens_per_1_minute:
        type: integer
      max_images_per_1_minute:
        type: integer
      max_audio_megabytes_per_1_minute:
        type: integer
      max_requests_per_1_day:
        type: integer
      batch_1_day_max_input_tokens:
        type: integer
  ProjectServiceAccount:
    type: object
    description: Represents an individual service account in a project.
    required:
    - object
    - id
    - name
    - role
    - created_at
    properties:
      object:
        type: string
        enum:
        - organization.project.service_account
      id:
        type: string
      name:
        type: string
      role:
        type: string
        enum:
        - owner
        - member
      created_at:
        type: integer
  ProjectServiceAccountApiKey:
    type: object
    required:
    - object
    - value
    - name
    - created_at
    - id
    properties:
      object:
        type: string
        enum:
        - organization.project.service_account.api_key
      value:
        type: string
      name:
        type: string
      created_at:
        type: integer
      id:
        type: string
  ProjectServiceAccountCreateRequest:
    type: object
    required:
    - name
    properties:
      name:
        type: string
  ProjectServiceAccountCreateResponse:
    type: object
    required:
    - object
    - id
    - name
    - role
    - created_at
    - api_key
    properties:
      object:
        type: string
        enum:
        - organization.project.service_account
      id:
        type: string
      name:
        type: string
      role:
        type: string
        enum:
        - member
      created_at:
        type: integer
      api_key:
        $ref: $ProjectServiceAccountApiKey
  ProjectServiceAccountDeleteResponse:
    type: object
    required:
    - object
    - id
    - deleted
    properties:
      object:
        type: string
        enum:
        - organization.project.service_account.deleted
      id:
        type: string
      deleted:
        type: boolean
  ProjectServiceAccountListResponse:
    type: object
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
        enum:
        - list
      data:
        type: array
        items: $ProjectServiceAccount
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  ProjectUpdateRequest:
    type: object
    required:
    - name
    properties:
      name:
        type: string
  ProjectUser:
    type: object
    description: Represents an individual user in a project.
    required:
    - object
    - id
    - name
    - email
    - role
    - added_at
    properties:
      object:
        type: string
        enum:
        - organization.project.user
      id:
        type: string
      name:
        type: string
      email:
        type: string
      role:
        type: string
        enum:
        - owner
        - member
      added_at:
        type: integer
  ProjectUserCreateRequest:
    type: object
    required:
    - user_id
    - role
    properties:
      user_id:
        type: string
      role:
        type: string
        enum:
        - owner
        - member
  ProjectUserDeleteResponse:
    type: object
    required:
    - object
    - id
    - deleted
    properties:
      object:
        type: string
        enum:
        - organization.project.user.deleted
      id:
        type: string
      deleted:
        type: boolean
  ProjectUserListResponse:
    type: object
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
      data:
        type: array
        items: $ProjectUser
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  ProjectUserUpdateRequest:
    type: object
    required:
    - role
    properties:
      role:
        type: string
        enum:
        - owner
        - member
  RankingOptions:
    type: object
    properties:
      ranker:
        type: string
        enum:
        - auto
        - default-2024-11-15
      score_threshold:
        type: number
  RealtimeClientEvent:
    anyOf:
    - $RealtimeClientEventConversationItemCreate
    - $RealtimeClientEventConversationItemDelete
    - $RealtimeClientEventConversationItemRetrieve
    - $RealtimeClientEventConversationItemTruncate
    - $RealtimeClientEventInputAudioBufferAppend
    - $RealtimeClientEventInputAudioBufferClear
    - $RealtimeClientEventOutputAudioBufferClear
    - $RealtimeClientEventInputAudioBufferCommit
    - $RealtimeClientEventResponseCancel
    - $RealtimeClientEventResponseCreate
    - $RealtimeClientEventSessionUpdate
    - $RealtimeClientEventTranscriptionSessionUpdate
    description: A realtime client event.
  RealtimeClientEventConversationItemCreate:
    type: object
    description: "Add a new Item to the Conversation's context, including messages, function \ncalls, and function call responses."
    required:
    - type
    - item
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - conversation.item.create
      previous_item_id:
        type: string
      item:
        $ref: $RealtimeConversationItem
  RealtimeClientEventConversationItemDelete:
    type: object
    description: "Send this event when you want to remove any item from the conversation \nhistory."
    required:
    - type
    - item_id
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - conversation.item.delete
      item_id:
        type: string
  RealtimeClientEventConversationItemRetrieve:
    type: object
    description: Send this event when you want to retrieve the server's representation of a specific item in the conversation
      history.
    required:
    - type
    - item_id
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - conversation.item.retrieve
      item_id:
        type: string
  RealtimeClientEventConversationItemTruncate:
    type: object
    description: Send this event to truncate a previous assistant message’s audio.
    required:
    - type
    - item_id
    - content_index
    - audio_end_ms
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - conversation.item.truncate
      item_id:
        type: string
      content_index:
        type: integer
      audio_end_ms:
        type: integer
  RealtimeClientEventInputAudioBufferAppend:
    type: object
    description: Send this event to append audio bytes to the input audio buffer.
    required:
    - type
    - audio
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - input_audio_buffer.append
      audio:
        type: string
  RealtimeClientEventInputAudioBufferClear:
    type: object
    description: Send this event to clear the audio bytes in the buffer.
    required:
    - type
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - input_audio_buffer.clear
  RealtimeClientEventInputAudioBufferCommit:
    type: object
    description: "Send this event to commit the user input audio buffer, which will create a \nnew user message item in the\
      \ conversation."
    required:
    - type
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - input_audio_buffer.commit
  RealtimeClientEventOutputAudioBufferClear:
    type: object
    description: '**WebRTC Only:** Emit to cut off the current audio response.'
    required:
    - type
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - output_audio_buffer.clear
  RealtimeClientEventResponseCancel:
    type: object
    description: Send this event to cancel an in-progress response.
    required:
    - type
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - response.cancel
      response_id:
        type: string
  RealtimeClientEventResponseCreate:
    type: object
    description: "This event instructs the server to create a Response, which means triggering \nmodel inference."
    required:
    - type
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - response.create
      response:
        $ref: $RealtimeResponseCreateParams
  RealtimeClientEventSessionUpdate:
    type: object
    description: |-
      Send this event to update the session’s default configuration.
      The client may send this event at any time to update a...
    required:
    - type
    - session
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - session.update
      session:
        $ref: $RealtimeSessionCreateRequest
  RealtimeClientEventTranscriptionSessionUpdate:
    type: object
    description: Send this event to update a transcription session.
    required:
    - type
    - session
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - transcription_session.update
      session:
        $ref: $RealtimeTranscriptionSessionCreateRequest
  RealtimeConversationItem:
    type: object
    description: The item to add to the conversation.
    properties:
      id:
        type: string
      type:
        type: string
        enum:
        - message
        - function_call
        - function_call_output
      object:
        type: string
        enum:
        - realtime.item
      status:
        type: string
        enum:
        - completed
        - incomplete
      role:
        type: string
        enum:
        - user
        - assistant
        - system
      content:
        type: array
        items: object
      call_id:
        type: string
      name:
        type: string
      arguments:
        type: string
      output:
        type: string
  RealtimeConversationItemWithReference:
    type: object
    description: The item to add to the conversation.
    properties:
      id:
        type: string
      type:
        type: string
        enum:
        - message
        - function_call
        - function_call_output
      object:
        type: string
        enum:
        - realtime.item
      status:
        type: string
        enum:
        - completed
        - incomplete
      role:
        type: string
        enum:
        - user
        - assistant
        - system
      content:
        type: array
        items: object
      call_id:
        type: string
      name:
        type: string
      arguments:
        type: string
      output:
        type: string
  RealtimeResponse:
    type: object
    description: The response resource.
    properties:
      id:
        type: string
      object:
        type: string
        enum:
        - realtime.response
      status:
        type: string
        enum:
        - completed
        - cancelled
        - failed
        - incomplete
      status_details:
        type: object
      output:
        type: array
        items: $RealtimeConversationItem
      metadata:
        $ref: $Metadata
      usage:
        type: object
      conversation_id:
        type: string
      voice:
        $ref: $VoiceIdsShared
      modalities:
        type: array
        items: string
      output_audio_format:
        type: string
        enum:
        - pcm16
        - g711_ulaw
        - g711_alaw
      temperature:
        type: number
      max_output_tokens:
        oneOf:
        - integer
        - string
  RealtimeResponseCreateParams:
    type: object
    description: Create a new Realtime response with these parameters
    properties:
      modalities:
        type: array
        items: string
      instructions:
        type: string
      voice:
        $ref: $VoiceIdsShared
      output_audio_format:
        type: string
        enum:
        - pcm16
        - g711_ulaw
        - g711_alaw
      tools:
        type: array
        items: object
      tool_choice:
        type: string
      temperature:
        type: number
      max_response_output_tokens:
        oneOf:
        - integer
        - string
      conversation:
        oneOf:
        - string
        - string
      metadata:
        $ref: $Metadata
      input:
        type: array
        items: $RealtimeConversationItemWithReference
  RealtimeServerEvent:
    anyOf:
    - $RealtimeServerEventConversationCreated
    - $RealtimeServerEventConversationItemCreated
    - $RealtimeServerEventConversationItemDeleted
    - $RealtimeServerEventConversationItemInputAudioTranscriptionCompleted
    - $RealtimeServerEventConversationItemInputAudioTranscriptionDelta
    - $RealtimeServerEventConversationItemInputAudioTranscriptionFailed
    - $RealtimeServerEventConversationItemRetrieved
    - $RealtimeServerEventConversationItemTruncated
    - $RealtimeServerEventError
    - $RealtimeServerEventInputAudioBufferCleared
    - $RealtimeServerEventInputAudioBufferCommitted
    - $RealtimeServerEventInputAudioBufferSpeechStarted
    - $RealtimeServerEventInputAudioBufferSpeechStopped
    - $RealtimeServerEventRateLimitsUpdated
    - $RealtimeServerEventResponseAudioDelta
    - $RealtimeServerEventResponseAudioDone
    - $RealtimeServerEventResponseAudioTranscriptDelta
    - $RealtimeServerEventResponseAudioTranscriptDone
    - $RealtimeServerEventResponseContentPartAdded
    - $RealtimeServerEventResponseContentPartDone
    - $RealtimeServerEventResponseCreated
    - $RealtimeServerEventResponseDone
    - $RealtimeServerEventResponseFunctionCallArgumentsDelta
    - $RealtimeServerEventResponseFunctionCallArgumentsDone
    - $RealtimeServerEventResponseOutputItemAdded
    - $RealtimeServerEventResponseOutputItemDone
    - $RealtimeServerEventResponseTextDelta
    - $RealtimeServerEventResponseTextDone
    - $RealtimeServerEventSessionCreated
    - $RealtimeServerEventSessionUpdated
    - $RealtimeServerEventTranscriptionSessionUpdated
    - $RealtimeServerEventOutputAudioBufferStarted
    - $RealtimeServerEventOutputAudioBufferStopped
    - $RealtimeServerEventOutputAudioBufferCleared
    description: A realtime server event.
  RealtimeServerEventConversationCreated:
    type: object
    description: Returned when a conversation is created.
    required:
    - event_id
    - type
    - conversation
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - conversation.created
      conversation:
        type: object
  RealtimeServerEventConversationItemCreated:
    type: object
    description: Returned when a conversation item is created.
    required:
    - event_id
    - type
    - previous_item_id
    - item
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - conversation.item.created
      previous_item_id:
        type: string
      item:
        $ref: $RealtimeConversationItem
  RealtimeServerEventConversationItemDeleted:
    type: object
    description: "Returned when an item in the conversation is deleted by the client with a \n`conversation.item.delete` event."
    required:
    - event_id
    - type
    - item_id
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - conversation.item.deleted
      item_id:
        type: string
  RealtimeServerEventConversationItemInputAudioTranscriptionCompleted:
    type: object
    description: "This event is the output of audio transcription for user audio written to the \nuser audio buffer."
    required:
    - event_id
    - type
    - item_id
    - content_index
    - transcript
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - conversation.item.input_audio_transcription.completed
      item_id:
        type: string
      content_index:
        type: integer
      transcript:
        type: string
      logprobs:
        type: array
        items: $LogProbProperties
        nullable: true
  RealtimeServerEventConversationItemInputAudioTranscriptionDelta:
    type: object
    description: Returned when the text value of an input audio transcription content part is updated.
    required:
    - event_id
    - type
    - item_id
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - conversation.item.input_audio_transcription.delta
      item_id:
        type: string
      content_index:
        type: integer
      delta:
        type: string
      logprobs:
        type: array
        items: $LogProbProperties
        nullable: true
  RealtimeServerEventConversationItemInputAudioTranscriptionFailed:
    type: object
    description: "Returned when input audio transcription is configured, and a transcription \nrequest for a user message\
      \ failed."
    required:
    - event_id
    - type
    - item_id
    - content_index
    - error
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - conversation.item.input_audio_transcription.failed
      item_id:
        type: string
      content_index:
        type: integer
      error:
        type: object
  RealtimeServerEventConversationItemRetrieved:
    type: object
    description: Returned when a conversation item is retrieved with `conversation.item.retrieve`.
    required:
    - event_id
    - type
    - item
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - conversation.item.retrieved
      item:
        $ref: $RealtimeConversationItem
  RealtimeServerEventConversationItemTruncated:
    type: object
    description: "Returned when an earlier assistant audio message item is truncated by the \nclient with a `conversation.item.truncate`..."
    required:
    - event_id
    - type
    - item_id
    - content_index
    - audio_end_ms
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - conversation.item.truncated
      item_id:
        type: string
      content_index:
        type: integer
      audio_end_ms:
        type: integer
  RealtimeServerEventError:
    type: object
    description: "Returned when an error occurs, which could be a client problem or a server \nproblem."
    required:
    - event_id
    - type
    - error
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - error
      error:
        type: object
  RealtimeServerEventInputAudioBufferCleared:
    type: object
    description: "Returned when the input audio buffer is cleared by the client with a \n`input_audio_buffer.clear` event."
    required:
    - event_id
    - type
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - input_audio_buffer.cleared
  RealtimeServerEventInputAudioBufferCommitted:
    type: object
    description: "Returned when an input audio buffer is committed, either by the client or \nautomatically in server VAD\
      \ mode."
    required:
    - event_id
    - type
    - previous_item_id
    - item_id
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - input_audio_buffer.committed
      previous_item_id:
        type: string
      item_id:
        type: string
  RealtimeServerEventInputAudioBufferSpeechStarted:
    type: object
    description: "Sent by the server when in `server_vad` mode to indicate that speech has been \ndetected in the audio buffer."
    required:
    - event_id
    - type
    - audio_start_ms
    - item_id
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - input_audio_buffer.speech_started
      audio_start_ms:
        type: integer
      item_id:
        type: string
  RealtimeServerEventInputAudioBufferSpeechStopped:
    type: object
    description: "Returned in `server_vad` mode when the server detects the end of speech in \nthe audio buffer."
    required:
    - event_id
    - type
    - audio_end_ms
    - item_id
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - input_audio_buffer.speech_stopped
      audio_end_ms:
        type: integer
      item_id:
        type: string
  RealtimeServerEventOutputAudioBufferCleared:
    type: object
    description: '**WebRTC Only:** Emitted when the output audio buffer is cleared.'
    required:
    - event_id
    - type
    - response_id
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - output_audio_buffer.cleared
      response_id:
        type: string
  RealtimeServerEventOutputAudioBufferStarted:
    type: object
    description: '**WebRTC Only:** Emitted when the server begins streaming audio to the client.'
    required:
    - event_id
    - type
    - response_id
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - output_audio_buffer.started
      response_id:
        type: string
  RealtimeServerEventOutputAudioBufferStopped:
    type: object
    description: |-
      **WebRTC Only:** Emitted when the output audio buffer has been completely drained on the server,
      and no more audio is...
    required:
    - event_id
    - type
    - response_id
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - output_audio_buffer.stopped
      response_id:
        type: string
  RealtimeServerEventRateLimitsUpdated:
    type: object
    description: Emitted at the beginning of a Response to indicate the updated rate limits.
    required:
    - event_id
    - type
    - rate_limits
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - rate_limits.updated
      rate_limits:
        type: array
        items: object
  RealtimeServerEventResponseAudioDelta:
    type: object
    description: Returned when the model-generated audio is updated.
    required:
    - event_id
    - type
    - response_id
    - item_id
    - output_index
    - content_index
    - delta
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - response.audio.delta
      response_id:
        type: string
      item_id:
        type: string
      output_index:
        type: integer
      content_index:
        type: integer
      delta:
        type: string
  RealtimeServerEventResponseAudioDone:
    type: object
    description: Returned when the model-generated audio is done.
    required:
    - event_id
    - type
    - response_id
    - item_id
    - output_index
    - content_index
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - response.audio.done
      response_id:
        type: string
      item_id:
        type: string
      output_index:
        type: integer
      content_index:
        type: integer
  RealtimeServerEventResponseAudioTranscriptDelta:
    type: object
    description: Returned when the model-generated transcription of audio output is updated.
    required:
    - event_id
    - type
    - response_id
    - item_id
    - output_index
    - content_index
    - delta
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - response.audio_transcript.delta
      response_id:
        type: string
      item_id:
        type: string
      output_index:
        type: integer
      content_index:
        type: integer
      delta:
        type: string
  RealtimeServerEventResponseAudioTranscriptDone:
    type: object
    description: |-
      Returned when the model-generated transcription of audio output is done
      streaming.
    required:
    - event_id
    - type
    - response_id
    - item_id
    - output_index
    - content_index
    - transcript
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - response.audio_transcript.done
      response_id:
        type: string
      item_id:
        type: string
      output_index:
        type: integer
      content_index:
        type: integer
      transcript:
        type: string
  RealtimeServerEventResponseContentPartAdded:
    type: object
    description: |-
      Returned when a new content part is added to an assistant message item during
      response generation.
    required:
    - event_id
    - type
    - response_id
    - item_id
    - output_index
    - content_index
    - part
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - response.content_part.added
      response_id:
        type: string
      item_id:
        type: string
      output_index:
        type: integer
      content_index:
        type: integer
      part:
        type: object
  RealtimeServerEventResponseContentPartDone:
    type: object
    description: Returned when a content part is done streaming in an assistant message item.
    required:
    - event_id
    - type
    - response_id
    - item_id
    - output_index
    - content_index
    - part
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - response.content_part.done
      response_id:
        type: string
      item_id:
        type: string
      output_index:
        type: integer
      content_index:
        type: integer
      part:
        type: object
  RealtimeServerEventResponseCreated:
    type: object
    description: Returned when a new Response is created.
    required:
    - event_id
    - type
    - response
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - response.created
      response:
        $ref: $RealtimeResponse
  RealtimeServerEventResponseDone:
    type: object
    description: Returned when a Response is done streaming.
    required:
    - event_id
    - type
    - response
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - response.done
      response:
        $ref: $RealtimeResponse
  RealtimeServerEventResponseFunctionCallArgumentsDelta:
    type: object
    description: Returned when the model-generated function call arguments are updated.
    required:
    - event_id
    - type
    - response_id
    - item_id
    - output_index
    - call_id
    - delta
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - response.function_call_arguments.delta
      response_id:
        type: string
      item_id:
        type: string
      output_index:
        type: integer
      call_id:
        type: string
      delta:
        type: string
  RealtimeServerEventResponseFunctionCallArgumentsDone:
    type: object
    description: Returned when the model-generated function call arguments are done streaming.
    required:
    - event_id
    - type
    - response_id
    - item_id
    - output_index
    - call_id
    - arguments
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - response.function_call_arguments.done
      response_id:
        type: string
      item_id:
        type: string
      output_index:
        type: integer
      call_id:
        type: string
      arguments:
        type: string
  RealtimeServerEventResponseOutputItemAdded:
    type: object
    description: Returned when a new Item is created during Response generation.
    required:
    - event_id
    - type
    - response_id
    - output_index
    - item
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - response.output_item.added
      response_id:
        type: string
      output_index:
        type: integer
      item:
        $ref: $RealtimeConversationItem
  RealtimeServerEventResponseOutputItemDone:
    type: object
    description: Returned when an Item is done streaming.
    required:
    - event_id
    - type
    - response_id
    - output_index
    - item
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - response.output_item.done
      response_id:
        type: string
      output_index:
        type: integer
      item:
        $ref: $RealtimeConversationItem
  RealtimeServerEventResponseTextDelta:
    type: object
    description: Returned when the text value of a "text" content part is updated.
    required:
    - event_id
    - type
    - response_id
    - item_id
    - output_index
    - content_index
    - delta
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - response.text.delta
      response_id:
        type: string
      item_id:
        type: string
      output_index:
        type: integer
      content_index:
        type: integer
      delta:
        type: string
  RealtimeServerEventResponseTextDone:
    type: object
    description: Returned when the text value of a "text" content part is done streaming.
    required:
    - event_id
    - type
    - response_id
    - item_id
    - output_index
    - content_index
    - text
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - response.text.done
      response_id:
        type: string
      item_id:
        type: string
      output_index:
        type: integer
      content_index:
        type: integer
      text:
        type: string
  RealtimeServerEventSessionCreated:
    type: object
    description: Returned when a Session is created.
    required:
    - event_id
    - type
    - session
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - session.created
      session:
        $ref: $RealtimeSession
  RealtimeServerEventSessionUpdated:
    type: object
    description: "Returned when a session is updated with a `session.update` event, unless \nthere is an error."
    required:
    - event_id
    - type
    - session
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - session.updated
      session:
        $ref: $RealtimeSession
  RealtimeServerEventTranscriptionSessionUpdated:
    type: object
    description: "Returned when a transcription session is updated with a `transcription_session.update` event, unless \n\
      there is an error."
    required:
    - event_id
    - type
    - session
    properties:
      event_id:
        type: string
      type:
        type: string
        enum:
        - transcription_session.updated
      session:
        $ref: $RealtimeTranscriptionSessionCreateResponse
  RealtimeSession:
    type: object
    description: Realtime session object configuration.
    properties:
      id:
        type: string
      modalities: {}
      model:
        type: string
        enum:
        - gpt-4o-realtime-preview
        - gpt-4o-realtime-preview-2024-10-01
        - gpt-4o-realtime-preview-2024-12-17
        - gpt-4o-mini-realtime-preview
        - gpt-4o-mini-realtime-preview-2024-12-17
      instructions:
        type: string
      voice:
        $ref: $VoiceIdsShared
      input_audio_format:
        type: string
        enum:
        - pcm16
        - g711_ulaw
        - g711_alaw
        default: pcm16
      output_audio_format:
        type: string
        enum:
        - pcm16
        - g711_ulaw
        - g711_alaw
        default: pcm16
      input_audio_transcription:
        type: object
      turn_detection:
        type: object
      input_audio_noise_reduction:
        type: object
      tools:
        type: array
        items: object
      tool_choice:
        type: string
        default: auto
      temperature:
        type: number
        default: 0.8
      max_response_output_tokens:
        oneOf:
        - integer
        - string
  RealtimeSessionCreateRequest:
    type: object
    description: Realtime session object configuration.
    properties:
      modalities: {}
      model:
        type: string
        enum:
        - gpt-4o-realtime-preview
        - gpt-4o-realtime-preview-2024-10-01
        - gpt-4o-realtime-preview-2024-12-17
        - gpt-4o-mini-realtime-preview
        - gpt-4o-mini-realtime-preview-2024-12-17
      instructions:
        type: string
      voice:
        $ref: $VoiceIdsShared
      input_audio_format:
        type: string
        enum:
        - pcm16
        - g711_ulaw
        - g711_alaw
        default: pcm16
      output_audio_format:
        type: string
        enum:
        - pcm16
        - g711_ulaw
        - g711_alaw
        default: pcm16
      input_audio_transcription:
        type: object
      turn_detection:
        type: object
      input_audio_noise_reduction:
        type: object
      tools:
        type: array
        items: object
      tool_choice:
        type: string
        default: auto
      temperature:
        type: number
        default: 0.8
      max_response_output_tokens:
        oneOf:
        - integer
        - string
  RealtimeSessionCreateResponse:
    type: object
    description: A new Realtime session configuration, with an ephermeral key.
    required:
    - client_secret
    properties:
      client_secret:
        type: object
      modalities: {}
      instructions:
        type: string
      voice:
        $ref: $VoiceIdsShared
      input_audio_format:
        type: string
      output_audio_format:
        type: string
      input_audio_transcription:
        type: object
      turn_detection:
        type: object
      tools:
        type: array
        items: object
      tool_choice:
        type: string
      temperature:
        type: number
      max_response_output_tokens:
        oneOf:
        - integer
        - string
  RealtimeTranscriptionSessionCreateRequest:
    type: object
    description: Realtime transcription session object configuration.
    properties:
      modalities: {}
      input_audio_format:
        type: string
        enum:
        - pcm16
        - g711_ulaw
        - g711_alaw
        default: pcm16
      input_audio_transcription:
        type: object
      turn_detection:
        type: object
      input_audio_noise_reduction:
        type: object
      include:
        type: array
        items: string
  RealtimeTranscriptionSessionCreateResponse:
    type: object
    description: |-
      A new Realtime transcription session configuration.

      When a session is created on the server via REST API, the sessio...
    required:
    - client_secret
    properties:
      client_secret:
        type: object
      modalities: {}
      input_audio_format:
        type: string
      input_audio_transcription:
        type: object
      turn_detection:
        type: object
  Reasoning:
    type: object
    description: "**o-series models only**\n\nConfiguration options for \n[reasoning models](https://platform.openai.com/docs/guides/reaso..."
    properties:
      effort:
        $ref: $ReasoningEffort
      summary:
        type: string
        enum:
        - auto
        - concise
        - detailed
        nullable: true
      generate_summary:
        type: string
        enum:
        - auto
        - concise
        - detailed
        nullable: true
  ReasoningEffort:
    type: string
    description: "**o-series models only** \n\nConstrains effort on reasoning for \n[reasoning models](https://platform.openai.com/docs/gu..."
    enum:
    - low
    - medium
    - high
  ReasoningItem:
    type: object
    description: |-
      A description of the chain of thought used by a reasoning model while generating
      a response.
    required:
    - id
    - summary
    - type
    properties:
      type:
        type: string
        enum:
        - reasoning
      id:
        type: string
      summary:
        type: array
        items: object
      status:
        type: string
        enum:
        - in_progress
        - completed
        - incomplete
  RefusalContent:
    type: object
    description: A refusal from the model.
    required:
    - type
    - refusal
    properties:
      type:
        type: string
        enum:
        - refusal
        default: refusal
      refusal:
        type: string
  Response:
    allOf:
    - $ModelResponseProperties
    - $ResponseProperties
    - object
  ResponseAudioDeltaEvent:
    type: object
    description: Emitted when there is a partial audio response.
    required:
    - type
    - delta
    properties:
      type:
        type: string
        enum:
        - response.audio.delta
      delta:
        type: string
  ResponseAudioDoneEvent:
    type: object
    description: Emitted when the audio response is complete.
    required:
    - type
    - response_id
    properties:
      type:
        type: string
        enum:
        - response.audio.done
  ResponseAudioTranscriptDeltaEvent:
    type: object
    description: Emitted when there is a partial transcript of audio.
    required:
    - type
    - response_id
    - delta
    properties:
      type:
        type: string
        enum:
        - response.audio.transcript.delta
      delta:
        type: string
  ResponseAudioTranscriptDoneEvent:
    type: object
    description: Emitted when the full audio transcript is completed.
    required:
    - type
    - response_id
    properties:
      type:
        type: string
        enum:
        - response.audio.transcript.done
  ResponseCodeInterpreterCallCodeDeltaEvent:
    type: object
    description: Emitted when a partial code snippet is added by the code interpreter.
    required:
    - type
    - response_id
    - output_index
    - delta
    properties:
      type:
        type: string
        enum:
        - response.code_interpreter_call.code.delta
      output_index:
        type: integer
      delta:
        type: string
  ResponseCodeInterpreterCallCodeDoneEvent:
    type: object
    description: Emitted when code snippet output is finalized by the code interpreter.
    required:
    - type
    - response_id
    - output_index
    - code
    properties:
      type:
        type: string
        enum:
        - response.code_interpreter_call.code.done
      output_index:
        type: integer
      code:
        type: string
  ResponseCodeInterpreterCallCompletedEvent:
    type: object
    description: Emitted when the code interpreter call is completed.
    required:
    - type
    - response_id
    - output_index
    - code_interpreter_call
    properties:
      type:
        type: string
        enum:
        - response.code_interpreter_call.completed
      output_index:
        type: integer
      code_interpreter_call:
        $ref: $CodeInterpreterToolCall
  ResponseCodeInterpreterCallInProgressEvent:
    type: object
    description: Emitted when a code interpreter call is in progress.
    required:
    - type
    - response_id
    - output_index
    - code_interpreter_call
    properties:
      type:
        type: string
        enum:
        - response.code_interpreter_call.in_progress
      output_index:
        type: integer
      code_interpreter_call:
        $ref: $CodeInterpreterToolCall
  ResponseCodeInterpreterCallInterpretingEvent:
    type: object
    description: Emitted when the code interpreter is actively interpreting the code snippet.
    required:
    - type
    - response_id
    - output_index
    - code_interpreter_call
    properties:
      type:
        type: string
        enum:
        - response.code_interpreter_call.interpreting
      output_index:
        type: integer
      code_interpreter_call:
        $ref: $CodeInterpreterToolCall
  ResponseCompletedEvent:
    type: object
    description: Emitted when the model response is complete.
    required:
    - type
    - response
    properties:
      type:
        type: string
        enum:
        - response.completed
      response:
        $ref: $Response
  ResponseContentPartAddedEvent:
    type: object
    description: Emitted when a new content part is added.
    required:
    - type
    - item_id
    - output_index
    - content_index
    - part
    properties:
      type:
        type: string
        enum:
        - response.content_part.added
      item_id:
        type: string
      output_index:
        type: integer
      content_index:
        type: integer
      part:
        $ref: $OutputContent
  ResponseContentPartDoneEvent:
    type: object
    description: Emitted when a content part is done.
    required:
    - type
    - item_id
    - output_index
    - content_index
    - part
    properties:
      type:
        type: string
        enum:
        - response.content_part.done
      item_id:
        type: string
      output_index:
        type: integer
      content_index:
        type: integer
      part:
        $ref: $OutputContent
  ResponseCreatedEvent:
    type: object
    description: An event that is emitted when a response is created.
    required:
    - type
    - response
    properties:
      type:
        type: string
        enum:
        - response.created
      response:
        $ref: $Response
  ResponseError:
    type: object
    description: An error object returned when the model fails to generate a Response.
    required:
    - code
    - message
    properties:
      code:
        $ref: $ResponseErrorCode
      message:
        type: string
  ResponseErrorCode:
    type: string
    description: The error code for the response.
    enum:
    - server_error
    - rate_limit_exceeded
    - invalid_prompt
    - vector_store_timeout
    - invalid_image
    - invalid_image_format
    - invalid_base64_image
    - invalid_image_url
    - image_too_large
    - image_too_small
    - image_parse_error
    - image_content_policy_violation
    - invalid_image_mode
    - image_file_too_large
    - unsupported_image_media_type
    - empty_image_file
    - failed_to_download_image
    - image_file_not_found
  ResponseErrorEvent:
    type: object
    description: Emitted when an error occurs.
    required:
    - type
    - code
    - message
    - param
    properties:
      type:
        type: string
        enum:
        - error
      code:
        type: string
        nullable: true
      message:
        type: string
      param:
        type: string
        nullable: true
  ResponseFailedEvent:
    type: object
    description: An event that is emitted when a response fails.
    required:
    - type
    - response
    properties:
      type:
        type: string
        enum:
        - response.failed
      response:
        $ref: $Response
  ResponseFileSearchCallCompletedEvent:
    type: object
    description: Emitted when a file search call is completed (results found).
    required:
    - type
    - output_index
    - item_id
    properties:
      type:
        type: string
        enum:
        - response.file_search_call.completed
      output_index:
        type: integer
      item_id:
        type: string
  ResponseFileSearchCallInProgressEvent:
    type: object
    description: Emitted when a file search call is initiated.
    required:
    - type
    - output_index
    - item_id
    properties:
      type:
        type: string
        enum:
        - response.file_search_call.in_progress
      output_index:
        type: integer
      item_id:
        type: string
  ResponseFileSearchCallSearchingEvent:
    type: object
    description: Emitted when a file search is currently searching.
    required:
    - type
    - output_index
    - item_id
    properties:
      type:
        type: string
        enum:
        - response.file_search_call.searching
      output_index:
        type: integer
      item_id:
        type: string
  ResponseFormatJsonObject:
    type: object
    description: JSON object response format.
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - json_object
  ResponseFormatJsonSchema:
    type: object
    description: JSON Schema response format.
    required:
    - type
    - json_schema
    properties:
      type:
        type: string
        enum:
        - json_schema
      json_schema:
        type: object
  ResponseFormatJsonSchemaSchema:
    type: object
    description: The schema for the response format, described as a JSON Schema object.
  ResponseFormatText:
    type: object
    description: Default response format.
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - text
  ResponseFunctionCallArgumentsDeltaEvent:
    type: object
    description: Emitted when there is a partial function-call arguments delta.
    required:
    - type
    - item_id
    - output_index
    - delta
    properties:
      type:
        type: string
        enum:
        - response.function_call_arguments.delta
      item_id:
        type: string
      output_index:
        type: integer
      delta:
        type: string
  ResponseFunctionCallArgumentsDoneEvent:
    type: object
    description: Emitted when function-call arguments are finalized.
    required:
    - type
    - item_id
    - output_index
    - arguments
    properties:
      type:
        type: string
        enum:
        - response.function_call_arguments.done
      item_id:
        type: string
      output_index:
        type: integer
      arguments:
        type: string
  ResponseInProgressEvent:
    type: object
    description: Emitted when the response is in progress.
    required:
    - type
    - response
    properties:
      type:
        type: string
        enum:
        - response.in_progress
      response:
        $ref: $Response
  ResponseIncompleteEvent:
    type: object
    description: An event that is emitted when a response finishes as incomplete.
    required:
    - type
    - response
    properties:
      type:
        type: string
        enum:
        - response.incomplete
      response:
        $ref: $Response
  ResponseItemList:
    type: object
    description: A list of Response items.
    required:
    - object
    - data
    - has_more
    - first_id
    - last_id
    properties:
      object:
        type: string
        enum:
        - list
      data:
        type: array
        items: $ItemResource
      has_more:
        type: boolean
      first_id:
        type: string
      last_id:
        type: string
  ResponseModalities:
    type: array
    description: |-
      Output types that you would like the model to generate.
      Most models are capable of generating text, which is the defa...
    items: string
  ResponseOutputItemAddedEvent:
    type: object
    description: Emitted when a new output item is added.
    required:
    - type
    - output_index
    - item
    properties:
      type:
        type: string
        enum:
        - response.output_item.added
      output_index:
        type: integer
      item:
        $ref: $OutputItem
  ResponseOutputItemDoneEvent:
    type: object
    description: Emitted when an output item is marked done.
    required:
    - type
    - output_index
    - item
    properties:
      type:
        type: string
        enum:
        - response.output_item.done
      output_index:
        type: integer
      item:
        $ref: $OutputItem
  ResponseProperties:
    type: object
    properties:
      previous_response_id:
        type: string
        nullable: true
      model:
        $ref: $ModelIdsResponses
      reasoning:
        $ref: $Reasoning
      max_output_tokens:
        type: integer
        nullable: true
      instructions:
        type: string
        nullable: true
      text:
        type: object
      tools:
        type: array
        items: $Tool
      tool_choice:
        oneOf:
        - $ToolChoiceOptions
        - $ToolChoiceTypes
        - $ToolChoiceFunction
      truncation:
        type: string
        enum:
        - auto
        - disabled
        nullable: true
        default: disabled
  ResponseReasoningSummaryPartAddedEvent:
    type: object
    description: Emitted when a new reasoning summary part is added.
    required:
    - type
    - item_id
    - output_index
    - summary_index
    - part
    properties:
      type:
        type: string
        enum:
        - response.reasoning_summary_part.added
      item_id:
        type: string
      output_index:
        type: integer
      summary_index:
        type: integer
      part:
        type: object
  ResponseReasoningSummaryPartDoneEvent:
    type: object
    description: Emitted when a reasoning summary part is completed.
    required:
    - type
    - item_id
    - output_index
    - summary_index
    - part
    properties:
      type:
        type: string
        enum:
        - response.reasoning_summary_part.done
      item_id:
        type: string
      output_index:
        type: integer
      summary_index:
        type: integer
      part:
        type: object
  ResponseReasoningSummaryTextDeltaEvent:
    type: object
    description: Emitted when a delta is added to a reasoning summary text.
    required:
    - type
    - item_id
    - output_index
    - summary_index
    - delta
    properties:
      type:
        type: string
        enum:
        - response.reasoning_summary_text.delta
      item_id:
        type: string
      output_index:
        type: integer
      summary_index:
        type: integer
      delta:
        type: string
  ResponseReasoningSummaryTextDoneEvent:
    type: object
    description: Emitted when a reasoning summary text is completed.
    required:
    - type
    - item_id
    - output_index
    - summary_index
    - text
    properties:
      type:
        type: string
        enum:
        - response.reasoning_summary_text.done
      item_id:
        type: string
      output_index:
        type: integer
      summary_index:
        type: integer
      text:
        type: string
  ResponseRefusalDeltaEvent:
    type: object
    description: Emitted when there is a partial refusal text.
    required:
    - type
    - item_id
    - output_index
    - content_index
    - delta
    properties:
      type:
        type: string
        enum:
        - response.refusal.delta
      item_id:
        type: string
      output_index:
        type: integer
      content_index:
        type: integer
      delta:
        type: string
  ResponseRefusalDoneEvent:
    type: object
    description: Emitted when refusal text is finalized.
    required:
    - type
    - item_id
    - output_index
    - content_index
    - refusal
    properties:
      type:
        type: string
        enum:
        - response.refusal.done
      item_id:
        type: string
      output_index:
        type: integer
      content_index:
        type: integer
      refusal:
        type: string
  ResponseStreamEvent:
    anyOf:
    - $ResponseAudioDeltaEvent
    - $ResponseAudioDoneEvent
    - $ResponseAudioTranscriptDeltaEvent
    - $ResponseAudioTranscriptDoneEvent
    - $ResponseCodeInterpreterCallCodeDeltaEvent
    - $ResponseCodeInterpreterCallCodeDoneEvent
    - $ResponseCodeInterpreterCallCompletedEvent
    - $ResponseCodeInterpreterCallInProgressEvent
    - $ResponseCodeInterpreterCallInterpretingEvent
    - $ResponseCompletedEvent
    - $ResponseContentPartAddedEvent
    - $ResponseContentPartDoneEvent
    - $ResponseCreatedEvent
    - $ResponseErrorEvent
    - $ResponseFileSearchCallCompletedEvent
    - $ResponseFileSearchCallInProgressEvent
    - $ResponseFileSearchCallSearchingEvent
    - $ResponseFunctionCallArgumentsDeltaEvent
    - $ResponseFunctionCallArgumentsDoneEvent
    - $ResponseInProgressEvent
    - $ResponseFailedEvent
    - $ResponseIncompleteEvent
    - $ResponseOutputItemAddedEvent
    - $ResponseOutputItemDoneEvent
    - $ResponseReasoningSummaryPartAddedEvent
    - $ResponseReasoningSummaryPartDoneEvent
    - $ResponseReasoningSummaryTextDeltaEvent
    - $ResponseReasoningSummaryTextDoneEvent
    - $ResponseRefusalDeltaEvent
    - $ResponseRefusalDoneEvent
    - $ResponseTextAnnotationDeltaEvent
    - $ResponseTextDeltaEvent
    - $ResponseTextDoneEvent
    - $ResponseWebSearchCallCompletedEvent
    - $ResponseWebSearchCallInProgressEvent
    - $ResponseWebSearchCallSearchingEvent
  ResponseTextAnnotationDeltaEvent:
    type: object
    description: Emitted when a text annotation is added.
    required:
    - type
    - item_id
    - output_index
    - content_index
    - annotation_index
    - annotation
    properties:
      type:
        type: string
        enum:
        - response.output_text.annotation.added
      item_id:
        type: string
      output_index:
        type: integer
      content_index:
        type: integer
      annotation_index:
        type: integer
      annotation:
        $ref: $Annotation
  ResponseTextDeltaEvent:
    type: object
    description: Emitted when there is an additional text delta.
    required:
    - type
    - item_id
    - output_index
    - content_index
    - delta
    properties:
      type:
        type: string
        enum:
        - response.output_text.delta
      item_id:
        type: string
      output_index:
        type: integer
      content_index:
        type: integer
      delta:
        type: string
  ResponseTextDoneEvent:
    type: object
    description: Emitted when text content is finalized.
    required:
    - type
    - item_id
    - output_index
    - content_index
    - text
    properties:
      type:
        type: string
        enum:
        - response.output_text.done
      item_id:
        type: string
      output_index:
        type: integer
      content_index:
        type: integer
      text:
        type: string
  ResponseUsage:
    type: object
    description: |-
      Represents token usage details including input tokens, output tokens,
      a breakdown of output tokens, and the total tok...
    required:
    - input_tokens
    - input_tokens_details
    - output_tokens
    - output_tokens_details
    - total_tokens
    properties:
      input_tokens:
        type: integer
      input_tokens_details:
        type: object
      output_tokens:
        type: integer
      output_tokens_details:
        type: object
      total_tokens:
        type: integer
  ResponseWebSearchCallCompletedEvent:
    type: object
    description: Emitted when a web search call is completed.
    required:
    - type
    - output_index
    - item_id
    properties:
      type:
        type: string
        enum:
        - response.web_search_call.completed
      output_index:
        type: integer
      item_id:
        type: string
  ResponseWebSearchCallInProgressEvent:
    type: object
    description: Emitted when a web search call is initiated.
    required:
    - type
    - output_index
    - item_id
    properties:
      type:
        type: string
        enum:
        - response.web_search_call.in_progress
      output_index:
        type: integer
      item_id:
        type: string
  ResponseWebSearchCallSearchingEvent:
    type: object
    description: Emitted when a web search call is executing.
    required:
    - type
    - output_index
    - item_id
    properties:
      type:
        type: string
        enum:
        - response.web_search_call.searching
      output_index:
        type: integer
      item_id:
        type: string
  RunCompletionUsage:
    type: object
    description: Usage statistics related to the run.
    required:
    - prompt_tokens
    - completion_tokens
    - total_tokens
    properties:
      completion_tokens:
        type: integer
      prompt_tokens:
        type: integer
      total_tokens:
        type: integer
  RunObject:
    type: object
    description: Represents an execution run on a [thread](/docs/api-reference/threads).
    required:
    - id
    - object
    - created_at
    - thread_id
    - assistant_id
    - status
    - required_action
    - last_error
    - expires_at
    - started_at
    - cancelled_at
    - failed_at
    - completed_at
    - model
    - instructions
    - tools
    - metadata
    - usage
    - incomplete_details
    - max_prompt_tokens
    - max_completion_tokens
    - truncation_strategy
    - tool_choice
    - parallel_tool_calls
    - response_format
    properties:
      id:
        type: string
      object:
        type: string
        enum:
        - thread.run
      created_at:
        type: integer
      thread_id:
        type: string
      assistant_id:
        type: string
      status:
        type: string
        enum:
        - queued
        - in_progress
        - requires_action
        - cancelling
        - cancelled
        - failed
        - completed
        - incomplete
        - expired
      required_action:
        type: object
        nullable: true
      last_error:
        type: object
        nullable: true
      expires_at:
        type: integer
        nullable: true
      started_at:
        type: integer
        nullable: true
      cancelled_at:
        type: integer
        nullable: true
      failed_at:
        type: integer
        nullable: true
      completed_at:
        type: integer
        nullable: true
      incomplete_details:
        type: object
        nullable: true
      model:
        type: string
      instructions:
        type: string
      tools:
        type: array
        items:
          oneOf:
          - $AssistantToolsCode
          - $AssistantToolsFileSearch
          - $AssistantToolsFunction
      metadata:
        $ref: $Metadata
      usage:
        $ref: $RunCompletionUsage
      temperature:
        type: number
        nullable: true
      top_p:
        type: number
        nullable: true
      max_prompt_tokens:
        type: integer
        nullable: true
      max_completion_tokens:
        type: integer
        nullable: true
      truncation_strategy:
        allOf:
        - $TruncationObject
        - '?'
      tool_choice:
        allOf:
        - $AssistantsApiToolChoiceOption
        - '?'
      parallel_tool_calls:
        $ref: $ParallelToolCalls
      response_format:
        $ref: $AssistantsApiResponseFormatOption
  RunStepCompletionUsage:
    type: object
    description: Usage statistics related to the run step.
    required:
    - prompt_tokens
    - completion_tokens
    - total_tokens
    properties:
      completion_tokens:
        type: integer
      prompt_tokens:
        type: integer
      total_tokens:
        type: integer
  RunStepDeltaObject:
    type: object
    description: Represents a run step delta i.e.
    required:
    - id
    - object
    - delta
    properties:
      id:
        type: string
      object:
        type: string
        enum:
        - thread.run.step.delta
      delta:
        type: object
  RunStepDeltaStepDetailsMessageCreationObject:
    type: object
    description: Details of the message creation by the run step.
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - message_creation
      message_creation:
        type: object
  RunStepDeltaStepDetailsToolCallsCodeObject:
    type: object
    description: Details of the Code Interpreter tool call the run step was involved in.
    required:
    - index
    - type
    properties:
      index:
        type: integer
      id:
        type: string
      type:
        type: string
        enum:
        - code_interpreter
      code_interpreter:
        type: object
  RunStepDeltaStepDetailsToolCallsCodeOutputImageObject:
    type: object
    required:
    - index
    - type
    properties:
      index:
        type: integer
      type:
        type: string
        enum:
        - image
      image:
        type: object
  RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject:
    type: object
    description: Text output from the Code Interpreter tool call as part of a run step.
    required:
    - index
    - type
    properties:
      index:
        type: integer
      type:
        type: string
        enum:
        - logs
      logs:
        type: string
  RunStepDeltaStepDetailsToolCallsFileSearchObject:
    type: object
    required:
    - index
    - type
    - file_search
    properties:
      index:
        type: integer
      id:
        type: string
      type:
        type: string
        enum:
        - file_search
      file_search:
        type: object
  RunStepDeltaStepDetailsToolCallsFunctionObject:
    type: object
    required:
    - index
    - type
    properties:
      index:
        type: integer
      id:
        type: string
      type:
        type: string
        enum:
        - function
      function:
        type: object
  RunStepDeltaStepDetailsToolCallsObject:
    type: object
    description: Details of the tool call.
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - tool_calls
      tool_calls:
        type: array
        items:
          oneOf:
          - $RunStepDeltaStepDetailsToolCallsCodeObject
          - $RunStepDeltaStepDetailsToolCallsFileSearchObject
          - $RunStepDeltaStepDetailsToolCallsFunctionObject
  RunStepDetailsMessageCreationObject:
    type: object
    description: Details of the message creation by the run step.
    required:
    - type
    - message_creation
    properties:
      type:
        type: string
        enum:
        - message_creation
      message_creation:
        type: object
  RunStepDetailsToolCallsCodeObject:
    type: object
    description: Details of the Code Interpreter tool call the run step was involved in.
    required:
    - id
    - type
    - code_interpreter
    properties:
      id:
        type: string
      type:
        type: string
        enum:
        - code_interpreter
      code_interpreter:
        type: object
  RunStepDetailsToolCallsCodeOutputImageObject:
    type: object
    required:
    - type
    - image
    properties:
      type:
        type: string
        enum:
        - image
      image:
        type: object
  RunStepDetailsToolCallsCodeOutputLogsObject:
    type: object
    description: Text output from the Code Interpreter tool call as part of a run step.
    required:
    - type
    - logs
    properties:
      type:
        type: string
        enum:
        - logs
      logs:
        type: string
  RunStepDetailsToolCallsFileSearchObject:
    type: object
    required:
    - id
    - type
    - file_search
    properties:
      id:
        type: string
      type:
        type: string
        enum:
        - file_search
      file_search:
        type: object
  RunStepDetailsToolCallsFileSearchRankingOptionsObject:
    type: object
    description: The ranking options for the file search.
    required:
    - ranker
    - score_threshold
    properties:
      ranker:
        $ref: $FileSearchRanker
      score_threshold:
        type: number
  RunStepDetailsToolCallsFileSearchResultObject:
    type: object
    description: A result instance of the file search.
    required:
    - file_id
    - file_name
    - score
    properties:
      file_id:
        type: string
      file_name:
        type: string
      score:
        type: number
      content:
        type: array
        items: object
  RunStepDetailsToolCallsFunctionObject:
    type: object
    required:
    - id
    - type
    - function
    properties:
      id:
        type: string
      type:
        type: string
        enum:
        - function
      function:
        type: object
  RunStepDetailsToolCallsObject:
    type: object
    description: Details of the tool call.
    required:
    - type
    - tool_calls
    properties:
      type:
        type: string
        enum:
        - tool_calls
      tool_calls:
        type: array
        items:
          oneOf:
          - $RunStepDetailsToolCallsCodeObject
          - $RunStepDetailsToolCallsFileSearchObject
          - $RunStepDetailsToolCallsFunctionObject
  RunStepObject:
    type: object
    description: Represents a step in execution of a run.
    required:
    - id
    - object
    - created_at
    - assistant_id
    - thread_id
    - run_id
    - type
    - status
    - step_details
    - last_error
    - expired_at
    - cancelled_at
    - failed_at
    - completed_at
    - metadata
    - usage
    properties:
      id:
        type: string
      object:
        type: string
        enum:
        - thread.run.step
      created_at:
        type: integer
      assistant_id:
        type: string
      thread_id:
        type: string
      run_id:
        type: string
      type:
        type: string
        enum:
        - message_creation
        - tool_calls
      status:
        type: string
        enum:
        - in_progress
        - cancelled
        - failed
        - completed
        - expired
      step_details:
        oneOf:
        - $RunStepDetailsMessageCreationObject
        - $RunStepDetailsToolCallsObject
      last_error:
        type: object
        nullable: true
      expired_at:
        type: integer
        nullable: true
      cancelled_at:
        type: integer
        nullable: true
      failed_at:
        type: integer
        nullable: true
      completed_at:
        type: integer
        nullable: true
      metadata:
        $ref: $Metadata
      usage:
        $ref: $RunStepCompletionUsage
  RunStepStreamEvent:
    oneOf:
    - object
    - object
    - object
    - object
    - object
    - object
    - object
  RunStreamEvent:
    oneOf:
    - object
    - object
    - object
    - object
    - object
    - object
    - object
    - object
    - object
    - object
  RunToolCallObject:
    type: object
    description: Tool call objects
    required:
    - id
    - type
    - function
    properties:
      id:
        type: string
      type:
        type: string
        enum:
        - function
      function:
        type: object
  Screenshot:
    type: object
    description: A screenshot action.
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - screenshot
        default: screenshot
  Scroll:
    type: object
    description: A scroll action.
    required:
    - type
    - x
    - y
    - scroll_x
    - scroll_y
    properties:
      type:
        type: string
        enum:
        - scroll
        default: scroll
      x:
        type: integer
      y:
        type: integer
      scroll_x:
        type: integer
      scroll_y:
        type: integer
  ServiceTier:
    type: string
    description: Specifies the latency tier to use for processing the request.
    enum:
    - auto
    - default
    - flex
  StaticChunkingStrategy:
    type: object
    required:
    - max_chunk_size_tokens
    - chunk_overlap_tokens
    properties:
      max_chunk_size_tokens:
        type: integer
      chunk_overlap_tokens:
        type: integer
  StaticChunkingStrategyRequestParam:
    type: object
    description: Customize your own chunking strategy by setting chunk size and chunk overlap.
    required:
    - type
    - static
    properties:
      type:
        type: string
        enum:
        - static
      static:
        $ref: $StaticChunkingStrategy
  StaticChunkingStrategyResponseParam:
    type: object
    required:
    - type
    - static
    properties:
      type:
        type: string
        enum:
        - static
      static:
        $ref: $StaticChunkingStrategy
  StopConfiguration:
    oneOf:
    - string
    - array
    description: |-
      Not supported with latest reasoning models `o3` and `o4-mini`.

      Up to 4 sequences where the API will stop generating ...
  SubmitToolOutputsRunRequest:
    type: object
    required:
    - tool_outputs
    properties:
      tool_outputs:
        type: array
        items: object
      stream:
        type: boolean
        nullable: true
  TextResponseFormatConfiguration:
    oneOf:
    - $ResponseFormatText
    - $TextResponseFormatJsonSchema
    - $ResponseFormatJsonObject
    description: |-
      An object specifying the format that the model must output.

      Configuring `{ "type": "json_schema" }` enables Structur...
  TextResponseFormatJsonSchema:
    type: object
    description: JSON Schema response format.
    required:
    - type
    - schema
    - name
    properties:
      type:
        type: string
        enum:
        - json_schema
      description:
        type: string
      name:
        type: string
      schema:
        $ref: $ResponseFormatJsonSchemaSchema
      strict:
        type: boolean
        nullable: true
        default: false
  ThreadObject:
    type: object
    description: Represents a thread that contains [messages](/docs/api-reference/messages).
    required:
    - id
    - object
    - created_at
    - tool_resources
    - metadata
    properties:
      id:
        type: string
      object:
        type: string
        enum:
        - thread
      created_at:
        type: integer
      tool_resources:
        type: object
        nullable: true
      metadata:
        $ref: $Metadata
  ThreadStreamEvent:
    oneOf:
    - object
  ToggleCertificatesRequest:
    type: object
    required:
    - certificate_ids
    properties:
      certificate_ids:
        type: array
        items: string
  Tool:
    oneOf:
    - $FileSearchTool
    - $FunctionTool
    - $WebSearchPreviewTool
    - $ComputerUsePreviewTool
  ToolChoiceFunction:
    type: object
    description: Use this option to force the model to call a specific function.
    required:
    - type
    - name
    properties:
      type:
        type: string
        enum:
        - function
      name:
        type: string
  ToolChoiceOptions:
    type: string
    description: Controls which (if any) tool is called by the model.
    enum:
    - none
    - auto
    - required
  ToolChoiceTypes:
    type: object
    description: Indicates that the model should use a built-in tool to generate a response.
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - file_search
        - web_search_preview
        - computer_use_preview
        - web_search_preview_2025_03_11
  TranscriptTextDeltaEvent:
    type: object
    description: Emitted when there is an additional text delta.
    required:
    - type
    - delta
    properties:
      type:
        type: string
        enum:
        - transcript.text.delta
      delta:
        type: string
      logprobs:
        type: array
        items: object
  TranscriptTextDoneEvent:
    type: object
    description: Emitted when the transcription is complete.
    required:
    - type
    - text
    properties:
      type:
        type: string
        enum:
        - transcript.text.done
      text:
        type: string
      logprobs:
        type: array
        items: object
  TranscriptionInclude:
    type: string
    enum:
    - logprobs
  TranscriptionSegment:
    type: object
    required:
    - id
    - seek
    - start
    - end
    - text
    - tokens
    - temperature
    - avg_logprob
    - compression_ratio
    - no_speech_prob
    properties:
      id:
        type: integer
      seek:
        type: integer
      start:
        type: number
      end:
        type: number
      text:
        type: string
      tokens:
        type: array
        items: integer
      temperature:
        type: number
      avg_logprob:
        type: number
      compression_ratio:
        type: number
      no_speech_prob:
        type: number
  TranscriptionWord:
    type: object
    required:
    - word
    - start
    - end
    properties:
      word:
        type: string
      start:
        type: number
      end:
        type: number
  TruncationObject:
    type: object
    description: Controls for how a thread will be truncated prior to the run.
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - auto
        - last_messages
      last_messages:
        type: integer
        nullable: true
  Type:
    type: object
    description: An action to type in text.
    required:
    - type
    - text
    properties:
      type:
        type: string
        enum:
        - type
        default: type
      text:
        type: string
  UpdateVectorStoreFileAttributesRequest:
    type: object
    required:
    - attributes
    properties:
      attributes:
        $ref: $VectorStoreFileAttributes
  UpdateVectorStoreRequest:
    type: object
    properties:
      name:
        type: string
        nullable: true
      expires_after:
        allOf:
        - $VectorStoreExpirationAfter
        - '?'
      metadata:
        $ref: $Metadata
  Upload:
    type: object
    description: The Upload object can accept byte chunks in the form of Parts.
    required:
    - bytes
    - created_at
    - expires_at
    - filename
    - id
    - purpose
    - status
    properties:
      id:
        type: string
      created_at:
        type: integer
      filename:
        type: string
      bytes:
        type: integer
      purpose:
        type: string
      status:
        type: string
        enum:
        - pending
        - completed
        - cancelled
        - expired
      expires_at:
        type: integer
      object:
        type: string
        enum:
        - upload
      file:
        allOf:
        - $OpenAIFile
        - '?'
  UploadCertificateRequest:
    type: object
    required:
    - content
    properties:
      name:
        type: string
      content:
        type: string
  UploadPart:
    type: object
    description: The upload Part represents a chunk of bytes we can add to an Upload object.
    required:
    - created_at
    - id
    - object
    - upload_id
    properties:
      id:
        type: string
      created_at:
        type: integer
      upload_id:
        type: string
      object:
        type: string
        enum:
        - upload.part
  UrlCitationBody:
    type: object
    description: A citation for a web resource used to generate a model response.
    required:
    - type
    - url
    - start_index
    - end_index
    - title
    properties:
      type:
        type: string
        enum:
        - url_citation
        default: url_citation
      url:
        type: string
      start_index:
        type: integer
      end_index:
        type: integer
      title:
        type: string
  UsageAudioSpeechesResult:
    type: object
    description: The aggregated audio speeches usage details of the specific time bucket.
    required:
    - object
    - characters
    - num_model_requests
    properties:
      object:
        type: string
        enum:
        - organization.usage.audio_speeches.result
      characters:
        type: integer
      num_model_requests:
        type: integer
      project_id:
        type: string
        nullable: true
      user_id:
        type: string
        nullable: true
      api_key_id:
        type: string
        nullable: true
      model:
        type: string
        nullable: true
  UsageAudioTranscriptionsResult:
    type: object
    description: The aggregated audio transcriptions usage details of the specific time bucket.
    required:
    - object
    - seconds
    - num_model_requests
    properties:
      object:
        type: string
        enum:
        - organization.usage.audio_transcriptions.result
      seconds:
        type: integer
      num_model_requests:
        type: integer
      project_id:
        type: string
        nullable: true
      user_id:
        type: string
        nullable: true
      api_key_id:
        type: string
        nullable: true
      model:
        type: string
        nullable: true
  UsageCodeInterpreterSessionsResult:
    type: object
    description: The aggregated code interpreter sessions usage details of the specific time bucket.
    required:
    - object
    - sessions
    properties:
      object:
        type: string
        enum:
        - organization.usage.code_interpreter_sessions.result
      num_sessions:
        type: integer
      project_id:
        type: string
        nullable: true
  UsageCompletionsResult:
    type: object
    description: The aggregated completions usage details of the specific time bucket.
    required:
    - object
    - input_tokens
    - output_tokens
    - num_model_requests
    properties:
      object:
        type: string
        enum:
        - organization.usage.completions.result
      input_tokens:
        type: integer
      input_cached_tokens:
        type: integer
      output_tokens:
        type: integer
      input_audio_tokens:
        type: integer
      output_audio_tokens:
        type: integer
      num_model_requests:
        type: integer
      project_id:
        type: string
        nullable: true
      user_id:
        type: string
        nullable: true
      api_key_id:
        type: string
        nullable: true
      model:
        type: string
        nullable: true
      batch:
        type: boolean
        nullable: true
  UsageEmbeddingsResult:
    type: object
    description: The aggregated embeddings usage details of the specific time bucket.
    required:
    - object
    - input_tokens
    - num_model_requests
    properties:
      object:
        type: string
        enum:
        - organization.usage.embeddings.result
      input_tokens:
        type: integer
      num_model_requests:
        type: integer
      project_id:
        type: string
        nullable: true
      user_id:
        type: string
        nullable: true
      api_key_id:
        type: string
        nullable: true
      model:
        type: string
        nullable: true
  UsageImagesResult:
    type: object
    description: The aggregated images usage details of the specific time bucket.
    required:
    - object
    - images
    - num_model_requests
    properties:
      object:
        type: string
        enum:
        - organization.usage.images.result
      images:
        type: integer
      num_model_requests:
        type: integer
      source:
        type: string
        nullable: true
      size:
        type: string
        nullable: true
      project_id:
        type: string
        nullable: true
      user_id:
        type: string
        nullable: true
      api_key_id:
        type: string
        nullable: true
      model:
        type: string
        nullable: true
  UsageModerationsResult:
    type: object
    description: The aggregated moderations usage details of the specific time bucket.
    required:
    - object
    - input_tokens
    - num_model_requests
    properties:
      object:
        type: string
        enum:
        - organization.usage.moderations.result
      input_tokens:
        type: integer
      num_model_requests:
        type: integer
      project_id:
        type: string
        nullable: true
      user_id:
        type: string
        nullable: true
      api_key_id:
        type: string
        nullable: true
      model:
        type: string
        nullable: true
  UsageResponse:
    type: object
    required:
    - object
    - data
    - has_more
    - next_page
    properties:
      object:
        type: string
        enum:
        - page
      data:
        type: array
        items: $UsageTimeBucket
      has_more:
        type: boolean
      next_page:
        type: string
  UsageTimeBucket:
    type: object
    required:
    - object
    - start_time
    - end_time
    - result
    properties:
      object:
        type: string
        enum:
        - bucket
      start_time:
        type: integer
      end_time:
        type: integer
      result:
        type: array
        items:
          oneOf:
          - $UsageCompletionsResult
          - $UsageEmbeddingsResult
          - $UsageModerationsResult
          - $UsageImagesResult
          - $UsageAudioSpeechesResult
          - $UsageAudioTranscriptionsResult
          - $UsageVectorStoresResult
          - $UsageCodeInterpreterSessionsResult
          - $CostsResult
  UsageVectorStoresResult:
    type: object
    description: The aggregated vector stores usage details of the specific time bucket.
    required:
    - object
    - usage_bytes
    properties:
      object:
        type: string
        enum:
        - organization.usage.vector_stores.result
      usage_bytes:
        type: integer
      project_id:
        type: string
        nullable: true
  User:
    type: object
    description: Represents an individual `user` within an organization.
    required:
    - object
    - id
    - name
    - email
    - role
    - added_at
    properties:
      object:
        type: string
        enum:
        - organization.user
      id:
        type: string
      name:
        type: string
      email:
        type: string
      role:
        type: string
        enum:
        - owner
        - reader
      added_at:
        type: integer
  UserDeleteResponse:
    type: object
    required:
    - object
    - id
    - deleted
    properties:
      object:
        type: string
        enum:
        - organization.user.deleted
      id:
        type: string
      deleted:
        type: boolean
  UserListResponse:
    type: object
    required:
    - object
    - data
    - first_id
    - last_id
    - has_more
    properties:
      object:
        type: string
        enum:
        - list
      data:
        type: array
        items: $User
      first_id:
        type: string
      last_id:
        type: string
      has_more:
        type: boolean
  UserRoleUpdateRequest:
    type: object
    required:
    - role
    properties:
      role:
        type: string
        enum:
        - owner
        - reader
  VectorStoreExpirationAfter:
    type: object
    description: The expiration policy for a vector store.
    required:
    - anchor
    - days
    properties:
      anchor:
        type: string
        enum:
        - last_active_at
      days:
        type: integer
  VectorStoreFileAttributes:
    type: object
    description: Set of 16 key-value pairs that can be attached to an object.
  VectorStoreFileBatchObject:
    type: object
    description: A batch of files attached to a vector store.
    required:
    - id
    - object
    - created_at
    - vector_store_id
    - status
    - file_counts
    properties:
      id:
        type: string
      object:
        type: string
        enum:
        - vector_store.files_batch
      created_at:
        type: integer
      vector_store_id:
        type: string
      status:
        type: string
        enum:
        - in_progress
        - completed
        - cancelled
        - failed
      file_counts:
        type: object
  VectorStoreFileContentResponse:
    type: object
    description: Represents the parsed content of a vector store file.
    required:
    - object
    - data
    - has_more
    - next_page
    properties:
      object:
        type: string
        enum:
        - vector_store.file_content.page
      data:
        type: array
        items: object
      has_more:
        type: boolean
      next_page:
        type: string
        nullable: true
  VectorStoreFileObject:
    type: object
    description: A list of files attached to a vector store.
    required:
    - id
    - object
    - usage_bytes
    - created_at
    - vector_store_id
    - status
    - last_error
    properties:
      id:
        type: string
      object:
        type: string
        enum:
        - vector_store.file
      usage_bytes:
        type: integer
      created_at:
        type: integer
      vector_store_id:
        type: string
      status:
        type: string
        enum:
        - in_progress
        - completed
        - cancelled
        - failed
      last_error:
        type: object
        nullable: true
      chunking_strategy:
        oneOf:
        - $StaticChunkingStrategyResponseParam
        - $OtherChunkingStrategyResponseParam
      attributes:
        $ref: $VectorStoreFileAttributes
  VectorStoreObject:
    type: object
    description: A vector store is a collection of processed files can be used by the `file_search` tool.
    required:
    - id
    - object
    - usage_bytes
    - created_at
    - status
    - last_active_at
    - name
    - file_counts
    - metadata
    properties:
      id:
        type: string
      object:
        type: string
        enum:
        - vector_store
      created_at:
        type: integer
      name:
        type: string
      usage_bytes:
        type: integer
      file_counts:
        type: object
      status:
        type: string
        enum:
        - expired
        - in_progress
        - completed
      expires_after:
        $ref: $VectorStoreExpirationAfter
      expires_at:
        type: integer
        nullable: true
      last_active_at:
        type: integer
        nullable: true
      metadata:
        $ref: $Metadata
  VectorStoreSearchRequest:
    type: object
    required:
    - query
    properties:
      query:
        oneOf:
        - string
        - array
      rewrite_query:
        type: boolean
        default: false
      max_num_results:
        type: integer
        default: 10
      filters:
        oneOf:
        - $ComparisonFilter
        - $CompoundFilter
      ranking_options:
        type: object
  VectorStoreSearchResultContentObject:
    type: object
    required:
    - type
    - text
    properties:
      type:
        type: string
        enum:
        - text
      text:
        type: string
  VectorStoreSearchResultItem:
    type: object
    required:
    - file_id
    - filename
    - score
    - attributes
    - content
    properties:
      file_id:
        type: string
      filename:
        type: string
      score:
        type: number
      attributes:
        $ref: $VectorStoreFileAttributes
      content:
        type: array
        items: $VectorStoreSearchResultContentObject
  VectorStoreSearchResultsPage:
    type: object
    required:
    - object
    - search_query
    - data
    - has_more
    - next_page
    properties:
      object:
        type: string
        enum:
        - vector_store.search_results.page
      search_query:
        type: array
        items: string
      data:
        type: array
        items: $VectorStoreSearchResultItem
      has_more:
        type: boolean
      next_page:
        type: string
        nullable: true
  VoiceIdsShared:
    anyOf:
    - string
    - string
  Wait:
    type: object
    description: A wait action.
    required:
    - type
    properties:
      type:
        type: string
        enum:
        - wait
        default: wait
  WebSearchContextSize:
    type: string
    description: "High level guidance for the amount of context window space to use for the \nsearch."
    enum:
    - low
    - medium
    - high
  WebSearchLocation:
    type: object
    description: Approximate location parameters for the search.
    properties:
      country:
        type: string
      region:
        type: string
      city:
        type: string
      timezone:
        type: string
  WebSearchPreviewTool:
    type: object
    description: This tool searches the web for relevant results to use in a response.
    required: *id001
    properties:
      type:
        type: string
        enum:
        - web_search_preview
        - web_search_preview_2025_03_11
        default: web_search_preview
      user_location:
        anyOf:
        - $ApproximateLocation
        - 'null'
      search_context_size:
        type: string
        enum:
        - low
        - medium
        - high
  WebSearchToolCall:
    type: object
    description: The results of a web search tool call.
    required:
    - id
    - type
    - status
    properties:
      id:
        type: string
      type:
        type: string
        enum:
        - web_search_call
      status:
        type: string
        enum:
        - in_progress
        - searching
        - completed
        - failed