Copy Page

YesAPI Docs - 全网最低价 Claude & Codex API 接口 (低至 0.3 折)

• Default module
  • Chat Models
    • Claude
      • Claude Opus 4.8
      • Claude Opus 4.7
      • Claude Haiku 4.5
      • Claude Fable 5
      • Claude Sonnet 5
      • Claude Mythos 5
      • Claude Opus 4.6
    • ChatGPT
      • GPT-5.6 Sol
      • GPT-5.6 Terra
      • GPT-5.6 Luna
      • GPT-5.5
      • GPT-5.5 Pro
      • GPT-5.4 Pro
      • GPT-5.4 mini
      • GPT-5.4 nano
      • GPT-5.2 Codex
      • GPT-5.1 Codex
      • GPT Image 2
      • GPT Image 1.5
      • GPT Image 1 Mini
  • Getting Started
  • Market
  • Image Models
  • Video Models
  • Music Models
• OpenAI API
  • Assistants
    • Returns a list of assistants.
    • Create an assistant with a model and instructions.
    • Retrieves an assistant.
    • Modifies an assistant.
    • Delete an assistant.
    • Create a thread.
    • Create a thread and run it in one request.
    • Retrieves a thread.
    • Modifies a thread.
    • Delete a thread.
    • Returns a list of messages for a given thread.
    • Create a message.
    • Retrieve a message.
    • Modifies a message.
    • Deletes a message.
    • Returns a list of runs belonging to a thread.
    • Create a run.
    • Retrieves a run.
    • Modifies a run.
    • Cancels a run that is `in_progress`.
    • Returns a list of run steps belonging to a run.
    • Retrieves a run step.
    • When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.
  • Audio
    • Generates audio from the input text. Returns the audio file content, or a stream of audio events.
    • Transcribes audio into the input language. Returns a transcription object in `json`, `diarized_json`, or `verbose_json` format, or a stream of transcript events.
    • Translates audio into English.
    • Upload a voice consent recording.
    • Returns a list of voice consent recordings.
    • Retrieves a voice consent recording.
    • Updates a voice consent recording (metadata only).
    • Deletes a voice consent recording.
    • Creates a custom voice.
  • Batch
    • Creates and executes a batch from an uploaded file of requests
    • List your organization's batches.
    • Retrieves a batch.
    • Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes, before changing to `cancelled`, where it will have partial results (if any) available in the output file.
  • Chat
    • List stored Chat Completions. Only Chat Completions that have been stored with the `store` parameter set to `true` will be returned.
    • **Starting a new project?** We recommend trying [Responses](/docs/api-reference/responses) to take advantage of the latest OpenAI platform features. Compare [Chat Completions with Responses](/docs/guides/responses-vs-chat-completions?api-mode=responses).
    • Get a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` will be returned.
    • Modify a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` can be modified. Currently, the only supported modification is to update the `metadata` field.
    • Delete a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` can be deleted.
    • Get the messages in a stored chat completion. Only Chat Completions that have been created with the `store` parameter set to `true` will be returned.
  • Completions
    • Creates a completion for the provided prompt and parameters. Returns a completion object, or a sequence of completion objects if the request is streamed.
  • Conversations
    • Create items in a conversation with the given ID.
    • List all items for a conversation with the given ID.
    • Get a single item from a conversation with the given IDs.
    • Delete an item from a conversation with the given IDs.
    • Create a conversation.
    • Get a conversation
    • Delete a conversation. Items in the conversation will not be deleted.
    • Update a conversation
  • Embeddings
    • Creates an embedding vector representing the input text.
  • Evals
    • List evaluations for a project.
    • Create the structure of an evaluation that can be used to test a model's performance. An evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation,
    • Get an evaluation by ID.
    • Update certain properties of an evaluation.
    • Delete an evaluation.
    • Get a list of runs for an evaluation.
    • Kicks off a new run for a given evaluation, specifying the data source, and what model configuration to use to test. The datasource will be validated against the schema specified in the config of the evaluation.
    • Get an evaluation run by ID.
    • Cancel an ongoing evaluation run.
    • Delete an eval run.
    • Get a list of output items for an evaluation run.
    • Get an evaluation run output item by ID.
  • Files
    • Returns a list of files.
    • Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and each project can store up to 2.5 TB of files in total. There is no organization-wide storage limit. Uploads to this endpoint are rate-limited to 1,000 reque
    • Delete a file and remove it from all vector stores.
    • Returns information about a specific file.
    • Returns the contents of the specified file.
  • Fine-tuning
    • Run a grader.
    • Validate a grader.
    • **NOTE:** This endpoint requires an [admin API key](../admin-api-keys). Organization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint.
    • **NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys). This enables organization owners to share fine-tuned models with other projects in their organization.
    • **NOTE:** This endpoint requires an [admin API key](../admin-api-keys). Organization owners can use this endpoint to delete a permission for a fine-tuned model checkpoint.
    • Creates a fine-tuning job which begins the process of creating a new model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. [Learn more about fine-tuning](/docs
    • List your organization's fine-tuning jobs
    • Get info about a fine-tuning job. [Learn more about fine-tuning](/docs/guides/model-optimization)
    • Immediately cancel a fine-tune job.
    • List checkpoints for a fine-tuning job.
    • Get status updates for a fine-tuning job.
    • Pause a fine-tune job.
    • Resume a fine-tune job.
  • Images
    • Creates an edited or extended image given one or more source images and a prompt. This endpoint supports GPT Image models (`gpt-image-1.5`, `gpt-image-1`, `gpt-image-1-mini`, and `chatgpt-image-latest`) and `dall-e-2`.
    • Creates an image given a prompt. [Learn more](/docs/guides/images).
    • Creates a variation of a given image. This endpoint only supports `dall-e-2`.
  • Models
    • Lists the currently available models, and provides basic information about each one such as the owner and availability.
    • Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
    • Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.
  • Moderations
    • Classifies if text and/or image inputs are potentially harmful. Learn more in the [moderation guide](/docs/guides/moderation).
  • Audit Logs
    • List user actions and configuration changes within this organization.
  • Certificates
    • List uploaded certificates for this organization.
    • Upload a certificate to the organization. This does **not** automatically activate the certificate. Organizations can upload up to 50 certificates.
    • Activate certificates at the organization level. You can atomically and idempotently activate up to 10 certificates at a time.
    • Deactivate certificates at the organization level. You can atomically and idempotently deactivate up to 10 certificates at a time.
    • Get a certificate that has been uploaded to the organization. You can get a certificate regardless of whether it is active or not.
    • Modify a certificate. Note that only the name can be modified.
    • Delete a certificate from the organization. The certificate must be inactive for the organization and all projects.
    • List certificates for this project.
    • Activate certificates at the project level. You can atomically and idempotently activate up to 10 certificates at a time.
    • Deactivate certificates at the project level. You can atomically and idempotently deactivate up to 10 certificates at a time.
  • Usage
    • Get costs details for the organization.
    • Get audio speeches usage details for the organization.
    • Get audio transcriptions usage details for the organization.
    • Get code interpreter sessions usage details for the organization.
    • Get completions usage details for the organization.
    • Get embeddings usage details for the organization.
    • Get file search calls usage details for the organization.
    • Get images usage details for the organization.
    • Get moderations usage details for the organization.
    • Get vector stores usage details for the organization.
    • Get web search calls usage details for the organization.
  • Data retention
    • Retrieves organization data retention controls.
    • Updates organization data retention controls.
    • Retrieves project data retention controls.
    • Updates project data retention controls.
  • Groups
    • Lists all groups in the organization.
    • Creates a new group in the organization.
    • Retrieves a group.
    • Updates a group's information.
    • Deletes a group from the organization.
  • Group organization role assignments
    • Lists the organization roles assigned to a group within the organization.
    • Assigns an organization role to a group within the organization.
    • Retrieves an organization role assigned to a group.
    • Unassigns an organization role from a group within the organization.
  • Group users
    • Lists the users assigned to a group.
    • Adds a user to a group.
    • Retrieves a user in a group.
    • Removes a user from a group.
  • Invites
    • Returns a list of invites in the organization.
    • Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.
    • Retrieves an invite.
    • Delete an invite. If the invite has already been accepted, it cannot be deleted.
  • Projects
    • Returns a list of projects.
    • Create a new project in the organization. Projects can be created and archived, but cannot be deleted.
    • Retrieves a project.
    • Modifies a project in the organization.
    • Returns a list of API keys in the project.
    • Retrieves an API key in the project.
    • Deletes an API key from the project. Returns confirmation of the key deletion, or an error if the key belonged to a service account.
    • Archives a project in the organization. Archived projects cannot be used or updated.
    • Returns model permissions for a project.
    • Updates model permissions for a project.
    • Deletes model permissions for a project.
    • Returns the rate limits per model for a project.
    • Updates a project rate limit.
    • Returns a list of service accounts in the project.
    • Creates a new service account in the project. By default, this also returns an unredacted API key for the service account.
    • Retrieves a service account in the project.
    • Updates a service account in the project.
    • Deletes a service account from the project. Returns confirmation of service account deletion, or an error if the project is archived (archived projects have no service accounts).
    • Creates an API key for a service account in the project.
    • Returns a list of users in the project.
    • Adds a user to the project. Users must already be members of the organization to be added to a project.
    • Retrieves a user in the project.
    • Modifies a user's role in the project.
    • Deletes a user from the project. Returns confirmation of project user deletion, or an error if the project is archived (archived projects have no users).
  • Project groups
    • Lists the groups that have access to a project.
    • Grants a group access to a project.
    • Retrieves a project's group.
    • Revokes a group's access to a project.
  • Hosted tools
    • Returns hosted tool permissions for a project.
    • Updates hosted tool permissions for a project.
  • Spend alerts
    • Lists project spend alerts.
    • Creates a project spend alert.
    • Retrieves a project spend alert.
    • Updates a project spend alert.
    • Deletes a project spend alert.
    • Lists organization spend alerts.
    • Creates an organization spend alert.
    • Retrieves an organization spend alert.
    • Updates an organization spend alert.
    • Deletes an organization spend alert.
  • Roles
    • Lists the roles configured for the organization.
    • Creates a custom role for the organization.
    • Retrieves an organization role.
    • Updates an existing organization role.
    • Deletes a custom role from the organization.
    • Lists the roles configured for a project.
    • Creates a custom role for a project.
    • Retrieves a project role.
    • Updates an existing project role.
    • Deletes a custom role from a project.
  • Users
    • Lists all of the users in the organization.
    • Retrieves a user by their identifier.
    • Modifies a user's role in the organization.
    • Deletes a user from the organization.
  • User organization role assignments
    • Lists the organization roles assigned to a user within the organization.
    • Assigns an organization role to a user within the organization.
    • Retrieves an organization role assigned to a user.
    • Unassigns an organization role from a user within the organization.
  • Project group role assignments
    • Lists the project roles assigned to a group within a project.
    • Assigns a project role to a group within a project.
    • Retrieves a project role assigned to a group.
    • Unassigns a project role from a group within a project.
  • Project user role assignments
    • Lists the project roles assigned to a user within a project.
    • Assigns a project role to a user within a project.
    • Retrieves a project role assigned to a user.
    • Unassigns a project role from a user within a project.
  • Realtime
    • Create a new Realtime API call over WebRTC and receive the SDP answer needed to complete the peer connection.
    • Accept an incoming SIP call and configure the realtime session that will handle it.
    • End an active Realtime API call, whether it was initiated over SIP or WebRTC.
    • Transfer an active SIP call to a new destination using the SIP REFER verb.
    • Decline an incoming SIP call by returning a SIP status code to the caller.
    • Create a Realtime client secret with an associated session configuration. Client secrets are short-lived tokens that can be passed to a client app, such as a web frontend or mobile client, which grants access to the Realtime API without leaking your main
    • Create an ephemeral API token for use in client-side applications with the Realtime API. Can be configured with the same session parameters as the `session.update` client event. It responds with a session object, plus a `client_secret` key which contains
    • Create an ephemeral API token for use in client-side applications with the Realtime API specifically for realtime transcriptions. Can be configured with the same session parameters as the `transcription_session.update` client event. It responds with a s
    • Create a Realtime translation client secret with an associated translation session configuration. Client secrets are short-lived tokens that can be passed to a client app, such as a web frontend or mobile client, which grants access to the Realtime Trans
  • Responses
    • Creates a model response. Provide [text](/docs/guides/text) or [image](/docs/guides/images) inputs to generate [text](/docs/guides/text) or [JSON](/docs/guides/structured-outputs) outputs. Have the model call your own [custom code](/docs/guides/function-c
    • Retrieves a model response with the given ID.
    • Deletes a model response with the given ID.
    • Cancels a model response with the given ID. Only responses created with the `background` parameter set to `true` can be cancelled. [Learn more](/docs/guides/background).
    • Returns a list of input items for a given response.
    • Creates a model response. Provide [text](/docs/guides/text) or [image](/docs/guides/images) inputs to generate [text](/docs/guides/text) or [JSON](/docs/guides/structured-outputs) outputs. Have the model call your own [custom code](/docs/guides/function-c
    • Retrieves a model response with the given ID.
    • Deletes a model response with the given ID.
    • Cancels a model response with the given ID. Only responses created with the `background` parameter set to `true` can be cancelled. [Learn more](/docs/guides/background).
    • Returns a list of input items for a given response.
  • Uploads
    • Creates an intermediate [Upload](/docs/api-reference/uploads/object) object that you can add [Parts](/docs/api-reference/uploads/part-object) to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it. Once yo
    • Cancels the Upload. No Parts may be added after an Upload is cancelled. Returns the Upload object with status `cancelled`.
    • Completes the [Upload](/docs/api-reference/uploads/object). Within the returned Upload object, there is a nested [File](/docs/api-reference/files/object) object that is ready to use in the rest of the platform. You can specify the order of the Parts by
    • Adds a [Part](/docs/api-reference/uploads/part-object) to an [Upload](/docs/api-reference/uploads/object) object. A Part represents a chunk of bytes from the file you are trying to upload. Each Part can be at most 64 MB, and you can add Parts until you
  • Vector stores
    • Returns a list of vector stores.
    • Create a vector store.
    • Retrieves a vector store.
    • Modifies a vector store.
    • Delete a vector store.
    • Create a vector store file batch.
    • Retrieves a vector store file batch.
    • Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.
    • Returns a list of vector store files in a batch.
    • Returns a list of vector store files.
    • Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).
    • Retrieves a vector store file.
    • Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint.
    • Update attributes on a vector store file.
    • Retrieve the parsed contents of a vector store file.
    • Search a vector store for relevant chunks based on a query and file attributes filter.
  • Videos
    • Create a new video generation job from a prompt and optional reference assets.
    • List recently generated videos for the current project.
    • Create a character from an uploaded video.
    • Fetch a character.
    • Create a new video generation job by editing a source video or existing generated video.
    • Create an extension of a completed video.
    • Fetch the latest metadata for a generated video.
    • Permanently delete a completed or failed video and its stored assets.
    • Download the generated video bytes or a derived preview asset. Streams the rendered video content for the specified video job.
    • Create a remix of a completed video using a refreshed prompt.
  • Skills
    • Create a new skill.
    • List all skills for the current project.
    • Delete a skill by its ID.
    • Get a skill by its ID.
    • Update the default version pointer for a skill.
    • Download a skill zip bundle by its ID.
    • Create a new immutable skill version.
    • List skill versions for a skill.
    • Get a specific skill version.
    • Delete a skill version.
    • Download a skill version zip bundle.
  • List Containers
    GET
  • Create Container
    POST
  • Retrieve Container
    GET
  • Delete Container
    DELETE
  • Create a Container File You can send either a multipart/form-data request with the raw file content, or a JSON request with a file ID.
    POST
  • List Container files
    GET
  • Retrieve Container File
    GET
  • Delete Container File
    DELETE
  • Retrieve Container File Content
    GET
  • List organization API keys
    GET
  • Create an organization admin API key
    POST
  • Retrieve a single organization API key
    GET
  • Delete an organization admin API key
    DELETE
  • Returns input token counts of the request. Returns an object with `object` set to `response.input_tokens` and an `input_tokens` count.
    POST
  • Compact a conversation. Returns a compacted response object. Learn when and how to compact long-running conversations in the [conversation state guide](/docs/guides/conversation-state#managing-the-context-window). For ZDR-compatible compaction details, s
    POST
  • Cancel an active ChatKit session and return its most recent metadata. Cancelling prevents new requests from using the issued client secret.
    POST
  • Create a ChatKit session.
    POST
  • List items that belong to a ChatKit thread.
    GET
  • Retrieve a ChatKit thread by its identifier.
    GET
  • Delete a ChatKit thread along with its items and stored attachments.
    DELETE
  • List ChatKit threads with optional pagination and user filters.
    GET
  • Compact a conversation. Returns a compacted response object. Learn when and how to compact long-running conversations in the [conversation state guide](/docs/guides/conversation-state#managing-the-context-window). For ZDR-compatible compaction details, s
    POST
  • Returns input token counts of the request. Returns an object with `object` set to `response.input_tokens` and an `input_tokens` count.
    POST
  • /batch_cancelled
  • /batch_completed
  • /batch_expired
  • /batch_failed
  • /eval_run_canceled
  • /eval_run_failed
  • /eval_run_succeeded
  • /fine_tuning_job_cancelled
  • /fine_tuning_job_failed
  • /fine_tuning_job_succeeded
  • /realtime_call_incoming
  • /response_cancelled
  • /response_completed
  • /response_failed
  • /response_incomplete
  • Schemas
    • AddUploadPartRequest
    • AdminApiKey
    • AdminApiKeyCreateResponse
    • ApiKeyList
    • AssignedRoleDetails
    • Assistant
    • AssistantStreamEvent
    • AssistantSupportedModels
    • Code interpreter tool
    • FileSearch tool
    • FileSearch tool
    • Function tool
    • AssistantsApiResponseFormatOption
    • AssistantsApiToolChoiceOption
    • AssistantsNamedToolChoice
    • AudioResponseFormat
    • AudioTranscription
    • AudioTranscriptionResponse
    • AuditLog
    • AuditLogActor
    • AuditLogActorApiKey
    • AuditLogActorServiceAccount
    • AuditLogActorSession
    • AuditLogActorUser
    • AuditLogEventType
    • Auto Chunking Strategy
    • Batch
    • BatchError
    • File expiration policy
    • BatchRequestCounts
    • Certificate
    • Allowed tools
    • Allowed tools
    • ChatCompletionDeleted
    • ChatCompletionFunctionCallOption
    • ChatCompletionFunctions
    • ChatCompletionList
    • Custom tool call
    • ChatCompletionMessageList
    • Function tool call
    • ChatCompletionMessageToolCallChunk
    • ChatCompletionMessageToolCalls
    • ChatCompletionModalities
    • ChatCompletionModeration
    • ChatCompletionModerationError
    • ChatCompletionModerationResults
    • Function tool choice
    • Custom tool choice
    • Assistant message
    • ChatCompletionRequestAssistantMessageContentPart
    • Developer message
    • Function message
    • ChatCompletionRequestMessage
    • Audio content part
    • File content part
    • Image content part
    • Refusal content part
    • Text content part
    • System message
    • ChatCompletionRequestSystemMessageContentPart
    • Tool message
    • ChatCompletionRequestToolMessageContentPart
    • User message
    • ChatCompletionRequestUserMessageContentPart
    • ChatCompletionResponseMessage
    • ChatCompletionRole
    • ChatCompletionStreamOptions
    • ChatCompletionStreamResponseDelta
    • ChatCompletionTokenLogprob
    • Function tool
    • ChatCompletionToolChoiceOption
    • ChunkingStrategyRequestParam
    • Code interpreter file output
    • Code interpreter text output
    • Code interpreter
    • Code interpreter tool call
    • Comparison Filter
    • CompleteUploadRequest
    • CompletionUsage
    • Compound Filter
    • ComputerAction
    • Computer Action List
    • ComputerScreenshotImage
    • Computer tool call
    • Computer tool call output
    • ComputerToolCallOutputResource
    • ContainerFileListResource
    • The container file object
    • ContainerListResource
    • The container object
    • Content
    • Conversation item
    • The conversation item list
    • ConversationParam
    • CostsResult
    • CreateAssistantRequest
    • CreateBatchRequest
    • CreateChatCompletionRequest
    • CreateChatCompletionResponse
    • CreateChatCompletionStreamResponse
    • CreateCompletionRequest
    • CreateCompletionResponse
    • CreateContainerBody
    • CreateContainerFileBody
    • CreateEmbeddingRequest
    • CreateEmbeddingResponse
    • CompletionsRunDataSource
    • CustomDataSourceConfig
    • CreateEvalItem
    • JsonlRunDataSource
    • LabelModelGrader
    • LogsDataSourceConfig
    • CreateEvalRequest
    • ResponsesRunDataSource
    • CreateEvalRunRequest
    • StoredCompletionsDataSourceConfig
    • CreateFileRequest
    • CreateFineTuningCheckpointPermissionRequest
    • CreateFineTuningJobRequest
    • CreateGroupBody
    • CreateGroupUserBody
    • CreateImageEditRequest
    • CreateImageRequest
    • CreateImageVariationRequest
    • CreateMessageRequest
    • CreateModelResponseProperties
    • CreateModerationRequest
    • CreateModerationResponse
    • CreateResponse
    • CreateRunRequest
    • CreateSpeechRequest
    • CreateSpeechResponseStreamEvent
    • CreateSpendAlertBody
    • CreateThreadAndRunRequest
    • CreateThreadRequest
    • CreateTranscriptionRequest
    • CreateTranscriptionResponseDiarizedJson
    • CreateTranscriptionResponseJson
    • CreateTranscriptionResponseStreamEvent
    • CreateTranscriptionResponseVerboseJson
    • CreateTranslationRequest
    • CreateTranslationResponseJson
    • CreateTranslationResponseVerboseJson
    • CreateUploadRequest
    • CreateVectorStoreFileBatchRequest
    • CreateVectorStoreFileRequest
    • CreateVectorStoreRequest
    • CreateVoiceConsentRequest
    • CreateVoiceRequest
    • Custom tool call
    • Custom tool call output
    • ResponseCustomToolCallOutputItem
    • ResponseCustomToolCallItem
    • Custom tool
    • DeleteAssistantResponse
    • DeleteCertificateResponse
    • DeleteFileResponse
    • DeleteFineTuningCheckpointPermissionResponse
    • DeleteMessageResponse
    • DeleteModelResponse
    • DeleteThreadResponse
    • DeleteVectorStoreFileResponse
    • DeleteVectorStoreResponse
    • The deleted conversation object
    • DeletedRoleAssignmentResource
    • DoneEvent
    • Input message
    • EditImageBodyJsonParam
    • Embedding
    • Error
    • ErrorEvent
    • ErrorResponse
    • Eval
    • EvalApiError
    • CustomDataSourceConfig
    • LabelModelGrader
    • PythonGrader
    • ScoreModelGrader
    • StringCheckGrader
    • TextSimilarityGrader
    • Eval message object
    • Eval content
    • An array of Input text, Output text, Input image, and Input audio
    • Eval content item
    • Output text
    • Text input
    • Input image
    • EvalJsonlFileContentSource
    • EvalJsonlFileIdSource
    • EvalList
    • LogsDataSourceConfig
    • EvalResponsesSource
    • EvalRun
    • EvalRunList
    • EvalRunOutputItem
    • EvalRunOutputItemList
    • EvalRunOutputItemResult
    • StoredCompletionsDataSourceConfig
    • StoredCompletionsRunDataSource
    • File expiration policy
    • File path
    • FileSearchRanker
    • File search tool call ranking options
    • File search tool call
    • FineTuneChatCompletionRequestAssistantMessage
    • FineTuneDPOHyperparameters
    • FineTuneDPOMethod
    • FineTuneMethod
    • FineTuneReinforcementHyperparameters
    • FineTuneReinforcementMethod
    • FineTuneSupervisedHyperparameters
    • FineTuneSupervisedMethod
    • FineTuningCheckpointPermission
    • Fine-Tuning Job Integration
    • FineTuningJob
    • FineTuningJobCheckpoint
    • FineTuningJobEvent
    • FunctionAndCustomToolCallOutput
    • FunctionObject
    • FunctionParameters
    • Function tool call
    • Function tool call output
    • FunctionToolCallOutputResource
    • FunctionToolCallResource
    • LabelModelGrader
    • MultiGrader
    • PythonGrader
    • ScoreModelGrader
    • StringCheckGrader
    • TextSimilarityGrader
    • Group
    • GroupDeletedResource
    • GroupListResource
    • GroupMemberUser
    • GroupResourceWithSuccess
    • GroupResponse
    • GroupRoleAssignment
    • GroupUser
    • GroupUserAssignment
    • GroupUserDeletedResource
    • HostedToolPermission
    • HostedToolPermissionUpdate
    • Image
    • ImageEditCompletedEvent
    • ImageEditPartialImageEvent
    • ImageEditStreamEvent
    • ImageGenCompletedEvent
    • ImageGenPartialImageEvent
    • ImageGenStreamEvent
    • Image generation tool
    • Image generation call
    • ImageRefParam
    • Image generation response
    • ImagesUsage
    • Input audio
    • InputContent
    • InputItem
    • Input message
    • Input item content list
    • InputMessageResource
    • InputParam
    • Invite
    • InviteDeleteResponse
    • InviteListResponse
    • InviteProjectGroupBody
    • InviteRequest
    • Item
    • ItemResource
    • ListAssistantsResponse
    • ListAuditLogsResponse
    • ListBatchesResponse
    • ListCertificatesResponse
    • ListFilesResponse
    • ListFineTuningCheckpointPermissionResponse
    • ListFineTuningJobCheckpointsResponse
    • ListFineTuningJobEventsResponse
    • ListMessagesResponse
    • ListModelsResponse
    • ListPaginatedFineTuningJobsResponse
    • ListProjectCertificatesResponse
    • ListRunStepsResponse
    • ListRunsResponse
    • ListVectorStoreFilesResponse
    • ListVectorStoresResponse
    • Local shell call
    • Local shell call output
    • LogProbProperties
    • MCP approval request
    • MCP approval response
    • MCP approval response
    • MCP list tools
    • MCP list tools tool
    • MCP tool
    • MCP tool call
    • MCP tool filter
    • Image file
    • Image URL
    • Refusal
    • File citation
    • File path
    • Text
    • Image file
    • Image URL
    • Refusal
    • File citation
    • File path
    • Text
    • Message delta object
    • The message object
    • MessagePhase
    • Text
    • MessageStreamEvent
    • Metadata
    • Model
    • ModelIds
    • ModelIdsCompaction
    • ModelIdsResponses
    • ModelIdsShared
    • ModelResponseProperties
    • ModifyAssistantRequest
    • ModifyCertificateRequest
    • ModifyMessageRequest
    • ModifyRunRequest
    • ModifyThreadRequest
    • NoiseReductionType
    • OpenAIFile
    • OrganizationCertificate
    • OrganizationCertificateActivationResponse
    • OrganizationCertificateDeactivationResponse
    • OrganizationDataRetention
    • OrganizationProjectCertificate
    • OrganizationProjectCertificateActivationResponse
    • OrganizationProjectCertificateDeactivationResponse
    • OrganizationSpendAlert
    • OrganizationSpendAlertDeletedResource
    • OrganizationSpendAlertListResource
    • Other Chunking Strategy
    • Output audio
    • OutputContent
    • OutputItem
    • Output message
    • OutputMessageContent
    • ParallelToolCalls
    • PartialImages
    • Static Content
    • Project
    • ProjectApiKey
    • ProjectApiKeyDeleteResponse
    • ProjectApiKeyListResponse
    • ProjectApiKeyOwnerServiceAccount
    • ProjectApiKeyOwnerUser
    • ProjectCreateRequest
    • ProjectDataRetention
    • ProjectGroup
    • ProjectGroupDeletedResource
    • ProjectGroupListResource
    • ProjectHostedToolPermissions
    • ProjectHostedToolPermissionsUpdateRequest
    • ProjectListResponse
    • ProjectModelPermissions
    • ProjectModelPermissionsDeleteResponse
    • ProjectModelPermissionsUpdateRequest
    • ProjectRateLimit
    • ProjectRateLimitListResponse
    • ProjectRateLimitUpdateRequest
    • ProjectServiceAccount
    • ProjectServiceAccountApiKey
    • ProjectServiceAccountApiKeyCreateRequest
    • ProjectServiceAccountCreateRequest
    • ProjectServiceAccountCreateResponse
    • ProjectServiceAccountDeleteResponse
    • ProjectServiceAccountListResponse
    • ProjectSpendAlert
    • ProjectSpendAlertDeletedResource
    • ProjectSpendAlertListResource
    • ProjectUpdateRequest
    • ProjectUser
    • ProjectUserCreateRequest
    • ProjectUserDeleteResponse
    • ProjectUserListResponse
    • ProjectUserUpdateRequest
    • Prompt
    • PublicAssignOrganizationGroupRoleBody
    • PublicCreateOrganizationRoleBody
    • PublicRoleListResource
    • PublicUpdateOrganizationRoleBody
    • RealtimeAudioFormats
    • RealtimeBetaClientEventConversationItemCreate
    • RealtimeBetaClientEventConversationItemDelete
    • RealtimeBetaClientEventConversationItemRetrieve
    • RealtimeBetaClientEventConversationItemTruncate
    • RealtimeBetaClientEventInputAudioBufferAppend
    • RealtimeBetaClientEventInputAudioBufferClear
    • RealtimeBetaClientEventInputAudioBufferCommit
    • RealtimeBetaClientEventOutputAudioBufferClear
    • RealtimeBetaClientEventResponseCancel
    • RealtimeBetaClientEventResponseCreate
    • RealtimeBetaClientEventSessionUpdate
    • RealtimeBetaClientEventTranscriptionSessionUpdate
    • RealtimeBetaResponse
    • RealtimeBetaResponseCreateParams
    • RealtimeBetaServerEventConversationItemCreated
    • RealtimeBetaServerEventConversationItemDeleted
    • RealtimeBetaServerEventConversationItemInputAudioTranscriptionCompleted
    • RealtimeBetaServerEventConversationItemInputAudioTranscriptionDelta
    • RealtimeBetaServerEventConversationItemInputAudioTranscriptionFailed
    • RealtimeBetaServerEventConversationItemInputAudioTranscriptionSegment
    • RealtimeBetaServerEventConversationItemRetrieved
    • RealtimeBetaServerEventConversationItemTruncated
    • RealtimeBetaServerEventError
    • RealtimeBetaServerEventInputAudioBufferCleared
    • RealtimeBetaServerEventInputAudioBufferCommitted
    • RealtimeBetaServerEventInputAudioBufferSpeechStarted
    • RealtimeBetaServerEventInputAudioBufferSpeechStopped
    • RealtimeBetaServerEventMCPListToolsCompleted
    • RealtimeBetaServerEventMCPListToolsFailed
    • RealtimeBetaServerEventMCPListToolsInProgress
    • RealtimeBetaServerEventRateLimitsUpdated
    • RealtimeBetaServerEventResponseAudioDelta
    • RealtimeBetaServerEventResponseAudioDone
    • RealtimeBetaServerEventResponseAudioTranscriptDelta
    • RealtimeBetaServerEventResponseAudioTranscriptDone
    • RealtimeBetaServerEventResponseContentPartAdded
    • RealtimeBetaServerEventResponseContentPartDone
    • RealtimeBetaServerEventResponseCreated
    • RealtimeBetaServerEventResponseDone
    • RealtimeBetaServerEventResponseFunctionCallArgumentsDelta
    • RealtimeBetaServerEventResponseFunctionCallArgumentsDone
    • RealtimeBetaServerEventResponseMCPCallArgumentsDelta
    • RealtimeBetaServerEventResponseMCPCallArgumentsDone
    • RealtimeBetaServerEventResponseMCPCallCompleted
    • RealtimeBetaServerEventResponseMCPCallFailed
    • RealtimeBetaServerEventResponseMCPCallInProgress
    • RealtimeBetaServerEventResponseOutputItemAdded
    • RealtimeBetaServerEventResponseOutputItemDone
    • RealtimeBetaServerEventResponseTextDelta
    • RealtimeBetaServerEventResponseTextDone
    • RealtimeBetaServerEventSessionCreated
    • RealtimeBetaServerEventSessionUpdated
    • RealtimeBetaServerEventTranscriptionSessionCreated
    • RealtimeBetaServerEventTranscriptionSessionUpdated
    • Realtime call creation request
    • Realtime call refer request
    • Realtime call reject request
    • RealtimeClientEvent
    • RealtimeClientEventConversationItemCreate
    • RealtimeClientEventConversationItemDelete
    • RealtimeClientEventConversationItemRetrieve
    • RealtimeClientEventConversationItemTruncate
    • RealtimeClientEventInputAudioBufferAppend
    • RealtimeClientEventInputAudioBufferClear
    • RealtimeClientEventInputAudioBufferCommit
    • RealtimeClientEventOutputAudioBufferClear
    • RealtimeClientEventResponseCancel
    • RealtimeClientEventResponseCreate
    • RealtimeClientEventSessionUpdate
    • RealtimeClientEventTranscriptionSessionUpdate
    • RealtimeConversationItem
    • Realtime function call item
    • Realtime function call output item
    • Realtime assistant message item
    • Realtime system message item
    • Realtime user message item
    • RealtimeConversationItemWithReference
    • Realtime client secret creation request
    • Realtime session and client secret
    • Function tool
    • Realtime MCP approval request
    • Realtime MCP approval response
    • Realtime MCP HTTP error
    • Realtime MCP list tools
    • Realtime MCP protocol error
    • Realtime MCP tool call
    • Realtime MCP tool execution error
    • Realtime reasoning configuration
    • RealtimeReasoningEffort
    • RealtimeResponse
    • RealtimeResponseCreateParams
    • RealtimeServerEvent
    • RealtimeServerEventConversationCreated
    • RealtimeServerEventConversationItemAdded
    • RealtimeServerEventConversationItemCreated
    • RealtimeServerEventConversationItemDeleted
    • RealtimeServerEventConversationItemDone
    • RealtimeServerEventConversationItemInputAudioTranscriptionCompleted
    • RealtimeServerEventConversationItemInputAudioTranscriptionDelta
    • RealtimeServerEventConversationItemInputAudioTranscriptionFailed
    • RealtimeServerEventConversationItemInputAudioTranscriptionSegment
    • RealtimeServerEventConversationItemRetrieved
    • RealtimeServerEventConversationItemTruncated
    • RealtimeServerEventError
    • RealtimeServerEventInputAudioBufferCleared
    • RealtimeServerEventInputAudioBufferCommitted
    • RealtimeServerEventInputAudioBufferDtmfEventReceived
    • RealtimeServerEventInputAudioBufferSpeechStarted
    • RealtimeServerEventInputAudioBufferSpeechStopped
    • RealtimeServerEventInputAudioBufferTimeoutTriggered
    • RealtimeServerEventMCPListToolsCompleted
    • RealtimeServerEventMCPListToolsFailed
    • RealtimeServerEventMCPListToolsInProgress
    • RealtimeServerEventOutputAudioBufferCleared
    • RealtimeServerEventOutputAudioBufferStarted
    • RealtimeServerEventOutputAudioBufferStopped
    • RealtimeServerEventRateLimitsUpdated
    • RealtimeServerEventResponseAudioDelta
    • RealtimeServerEventResponseAudioDone
    • RealtimeServerEventResponseAudioTranscriptDelta
    • RealtimeServerEventResponseAudioTranscriptDone
    • RealtimeServerEventResponseContentPartAdded
    • RealtimeServerEventResponseContentPartDone
    • RealtimeServerEventResponseCreated
    • RealtimeServerEventResponseDone
    • RealtimeServerEventResponseFunctionCallArgumentsDelta
    • RealtimeServerEventResponseFunctionCallArgumentsDone
    • RealtimeServerEventResponseMCPCallArgumentsDelta
    • RealtimeServerEventResponseMCPCallArgumentsDone
    • RealtimeServerEventResponseMCPCallCompleted
    • RealtimeServerEventResponseMCPCallFailed
    • RealtimeServerEventResponseMCPCallInProgress
    • RealtimeServerEventResponseOutputItemAdded
    • RealtimeServerEventResponseOutputItemDone
    • RealtimeServerEventResponseTextDelta
    • RealtimeServerEventResponseTextDone
    • RealtimeServerEventSessionCreated
    • RealtimeServerEventSessionUpdated
    • RealtimeServerEventTranscriptionSessionUpdated
    • RealtimeSession
    • RealtimeSessionCreateRequest
    • Realtime session configuration
    • Realtime session configuration object
    • Realtime session configuration object
    • Realtime transcription session configuration
    • Realtime transcription session configuration
    • RealtimeTranscriptionSessionCreateResponse
    • Realtime transcription session configuration object
    • RealtimeTranslationClientEvent
    • RealtimeTranslationClientEventInputAudioBufferAppend
    • RealtimeTranslationClientEventSessionClose
    • RealtimeTranslationClientEventSessionUpdate
    • Realtime translation client secret creation request
    • Realtime translation session and client secret
    • RealtimeTranslationServerEvent
    • RealtimeTranslationServerEventSessionClosed
    • RealtimeTranslationServerEventSessionCreated
    • RealtimeTranslationServerEventSessionInputTranscriptDelta
    • RealtimeTranslationServerEventSessionOutputAudioDelta
    • RealtimeTranslationServerEventSessionOutputTranscriptDelta
    • RealtimeTranslationServerEventSessionUpdated
    • Realtime translation session
    • Realtime translation session configuration
    • Realtime translation session update
    • Realtime Truncation Controls
    • RealtimeTurnDetection
    • Reasoning
    • ReasoningEffort
    • Reasoning
    • The response object
    • ResponseAudioDeltaEvent
    • ResponseAudioDoneEvent
    • ResponseAudioTranscriptDeltaEvent
    • ResponseAudioTranscriptDoneEvent
    • ResponseCodeInterpreterCallCodeDeltaEvent
    • ResponseCodeInterpreterCallCodeDoneEvent
    • ResponseCodeInterpreterCallCompletedEvent
    • ResponseCodeInterpreterCallInProgressEvent
    • ResponseCodeInterpreterCallInterpretingEvent
    • ResponseCompletedEvent
    • ResponseContentPartAddedEvent
    • ResponseContentPartDoneEvent
    • ResponseCreatedEvent
    • ResponseCustomToolCallInputDelta
    • ResponseCustomToolCallInputDone
    • ResponseError
    • ResponseErrorCode
    • ResponseErrorEvent
    • ResponseFailedEvent
    • ResponseFileSearchCallCompletedEvent
    • ResponseFileSearchCallInProgressEvent
    • ResponseFileSearchCallSearchingEvent
    • JSON object
    • JSON schema
    • JSON schema
    • Text
    • Text grammar
    • Python grammar
    • ResponseFunctionCallArgumentsDeltaEvent
    • ResponseFunctionCallArgumentsDoneEvent
    • ResponseImageGenCallCompletedEvent
    • ResponseImageGenCallGeneratingEvent
    • ResponseImageGenCallInProgressEvent
    • ResponseImageGenCallPartialImageEvent
    • ResponseInProgressEvent
    • ResponseIncompleteEvent
    • ResponseItemList
    • ResponseLogProb
    • ResponseMCPCallArgumentsDeltaEvent
    • ResponseMCPCallArgumentsDoneEvent
    • ResponseMCPCallCompletedEvent
    • ResponseMCPCallFailedEvent
    • ResponseMCPCallInProgressEvent
    • ResponseMCPListToolsCompletedEvent
    • ResponseMCPListToolsFailedEvent
    • ResponseMCPListToolsInProgressEvent
    • ResponseModalities
    • ResponseOutputItemAddedEvent
    • ResponseOutputItemDoneEvent
    • ResponseOutputTextAnnotationAddedEvent
    • ResponsePromptVariables
    • ResponseProperties
    • ResponseQueuedEvent
    • ResponseReasoningSummaryPartAddedEvent
    • ResponseReasoningSummaryPartDoneEvent
    • ResponseReasoningSummaryTextDeltaEvent
    • ResponseReasoningSummaryTextDoneEvent
    • ResponseReasoningTextDeltaEvent
    • ResponseReasoningTextDoneEvent
    • ResponseRefusalDeltaEvent
    • ResponseRefusalDoneEvent
    • ResponseStreamEvent
    • ResponseStreamOptions
    • ResponseTextDeltaEvent
    • ResponseTextDoneEvent
    • ResponseTextParam
    • ResponseUsage
    • ResponseWebSearchCallCompletedEvent
    • ResponseWebSearchCallInProgressEvent
    • ResponseWebSearchCallSearchingEvent
    • ResponsesClientEvent
    • ResponsesClientEventResponseCreate
    • ResponsesServerEvent
    • Role
    • RoleDeletedResource
    • RoleListResource
    • RunCompletionUsage
    • RunGraderRequest
    • RunGraderResponse
    • A run on a thread
    • RunStepCompletionUsage
    • Run step delta object
    • Message creation
    • Code interpreter tool call
    • Code interpreter image output
    • Code interpreter log output
    • File search tool call
    • Function tool call
    • Tool calls
    • Message creation
    • Code Interpreter tool call
    • Code Interpreter image output
    • Code Interpreter log output
    • File search tool call
    • File search tool call ranking options
    • File search tool call result
    • Function tool call
    • Tool calls
    • Run steps
    • RunStepStreamEvent
    • RunStreamEvent
    • RunToolCallObject
    • ServiceTier
    • SpeechAudioDeltaEvent
    • SpeechAudioDoneEvent
    • SpendAlertNotificationChannel
    • StaticChunkingStrategy
    • Static Chunking Strategy
    • Static Chunking Strategy
    • StopConfiguration
    • SubmitToolOutputsRunRequest
    • TextResponseFormatConfiguration
    • JSON schema
    • Thread
    • ThreadStreamEvent
    • ToggleCertificatesRequest
    • Tool
    • Allowed tools
    • Custom tool
    • Function tool
    • MCP tool
    • Tool choice mode
    • ToolChoiceParam
    • Hosted tool
    • ToolsArray
    • TranscriptTextDeltaEvent
    • TranscriptTextDoneEvent
    • TranscriptTextSegmentEvent
    • Duration Usage
    • Token Usage
    • TranscriptionChunkingStrategy
    • TranscriptionDiarizedSegment
    • TranscriptionInclude
    • TranscriptionSegment
    • TranscriptionWord
    • Thread Truncation Controls
    • UpdateGroupBody
    • UpdateOrganizationDataRetentionBody
    • UpdateProjectDataRetentionBody
    • UpdateProjectServiceAccountBody
    • UpdateVectorStoreFileAttributesRequest
    • UpdateVectorStoreRequest
    • UpdateVoiceConsentRequest
    • Upload
    • UploadCertificateRequest
    • UploadPart
    • UsageAudioSpeechesResult
    • UsageAudioTranscriptionsResult
    • UsageCodeInterpreterSessionsResult
    • UsageCompletionsResult
    • UsageEmbeddingsResult
    • UsageFileSearchCallsResult
    • UsageImagesResult
    • UsageModerationsResult
    • UsageResponse
    • UsageTimeBucket
    • UsageVectorStoresResult
    • UsageWebSearchCallsResult
    • User
    • UserDeleteResponse
    • UserListResource
    • UserListResponse
    • UserRoleAssignment
    • UserRoleUpdateRequest
    • VadConfig
    • ValidateGraderRequest
    • ValidateGraderResponse
    • Vector store expiration policy
    • VectorStoreFileAttributes
    • Vector store file batch
    • VectorStoreFileContentResponse
    • Vector store files
    • Vector store
    • VectorStoreSearchRequest
    • VectorStoreSearchResultContentObject
    • VectorStoreSearchResultItem
    • VectorStoreSearchResultsPage
    • Verbosity
    • VoiceConsentDeletedResource
    • VoiceConsentListResource
    • Voice consent
    • Voice
    • VoiceIdsShared
    • Voice
    • Find action
    • Open page action
    • Search action
    • WebSearchApproximateLocation
    • WebSearchContextSize
    • Web search location
    • Web search
    • Web search tool call
    • batch.cancelled
    • batch.completed
    • batch.expired
    • batch.failed
    • eval.run.canceled
    • eval.run.failed
    • eval.run.succeeded
    • fine_tuning.job.cancelled
    • fine_tuning.job.failed
    • fine_tuning.job.succeeded
    • realtime.call.incoming
    • response.cancelled
    • response.completed
    • response.failed
    • response.incomplete
    • ModerationInputType
    • Moderation result
    • PromptCacheTTLEnum
    • PromptCacheModeEnum
    • Prompt cache options
    • Prompt cache breakpoint
    • ModerationMode
    • ModerationConfigParam
    • ModerationPolicyParam
    • ModerationParam
    • SkillReferenceParam
    • InlineSkillSourceParam
    • InlineSkillParam
    • ContainerNetworkPolicyDisabledParam
    • ContainerNetworkPolicyDomainSecretParam
    • ContainerNetworkPolicyAllowlistParam
    • IncludeEnum
    • MessageStatus
    • MessageRole
    • Prompt cache breakpoint
    • Input text
    • File citation
    • URL citation
    • Container file citation
    • Annotation
    • Top log probability
    • Log probability
    • Output text
    • Text Content
    • Summary text
    • Reasoning text
    • Refusal
    • ImageDetail
    • Input image
    • Computer screenshot
    • FileInputDetail
    • Input file
    • MessagePhase-2
    • Message
    • DirectToolCallCaller
    • ProgramToolCallCaller
    • ToolCallCaller
    • FunctionCallStatus
    • DirectToolCallCallerParam
    • ProgramToolCallCallerParam
    • ToolCallCallerParam
    • FunctionCallOutputStatusEnum
    • ClickButtonType
    • Click
    • DoubleClick
    • Coordinate
    • Drag
    • KeyPress
    • Move
    • Screenshot
    • Scroll
    • Type
    • Wait
    • ComputerCallSafetyCheckParam
    • ComputerCallOutputStatus
    • ToolSearchExecutionType
    • ToolSearchCall
    • CallableToolAllowedCaller
    • Function
    • RankerVersionType
    • HybridSearchOptions
    • RankingOptions
    • Filters
    • File search
    • Computer
    • ComputerEnvironment
    • Computer use preview
    • ContainerMemoryLimit
    • CodeInterpreterToolAuto
    • ProgrammaticToolCallingParam
    • InputFidelity
    • ImageGenActionEnum
    • Local shell tool
    • ContainerAutoParam
    • LocalSkillParam
    • LocalEnvironmentParam
    • ContainerReferenceParam
    • Shell tool
    • Text format
    • GrammarSyntax1
    • Grammar format
    • Custom tool
    • EmptyModelParam
    • FunctionToolParam
    • Namespace
    • Tool search tool
    • ApproximateLocation
    • SearchContextSize
    • SearchContentType
    • Web search preview
    • Apply patch tool
    • ToolSearchOutput
    • AdditionalTools
    • Program
    • ProgramOutputStatus
    • ProgramOutput
    • Compaction item
    • Code interpreter output logs
    • Code interpreter output image
    • Local shell exec action
    • Shell exec action
    • FunctionShellCallStatus
    • Local Environment
    • Container Reference
    • Shell tool call
    • FunctionShellCallOutputStatusEnum
    • Shell call timeout outcome
    • Shell call exit outcome
    • Shell call output content
    • Shell call output
    • ApplyPatchCallStatus
    • Apply patch create file operation
    • Apply patch delete file operation
    • Apply patch update file operation
    • Apply patch tool call
    • ApplyPatchCallOutputStatus
    • Apply patch tool call output
    • MCPToolCallStatus
    • DetailEnum
    • FunctionCallItemStatus
    • Computer tool call output
    • Input text
    • Input image
    • FileDetailEnum
    • Input file
    • Function tool call output
    • FileCitationParam
    • UrlCitationParam
    • ContainerFileCitationParam
    • ToolSearchCallItemParam
    • ToolSearchOutputItemParam
    • AdditionalToolsItemParam
    • Compaction item
    • Shell action
    • Shell call status
    • Shell tool call
    • Shell call timeout outcome
    • Shell call exit outcome
    • Shell call outcome
    • Shell output content
    • Shell tool call output
    • Apply patch call status
    • Apply patch create file operation
    • Apply patch delete file operation
    • Apply patch update file operation
    • Apply patch operation
    • Apply patch tool call
    • Apply patch call output status
    • Apply patch tool call output
    • Compaction trigger
    • Item reference
    • ProgramItemParam
    • ProgramOutputItemStatus
    • ProgramOutputItemParam
    • ConversationResource
    • Image generation output token details
    • Input usage details
    • Image generation usage
    • SpecificProgrammaticToolCallingParam
    • Specific apply patch tool choice
    • Specific shell tool choice
    • ReasoningModeEnum
    • Conversation object
    • ContextManagementParam
    • Prompt cache options
    • Moderation error
    • Moderation
    • Conversation
    • CreateConversationBody
    • UpdateConversationBody
    • DeletedConversationResource
    • OrderEnum
    • VideoModel
    • VideoStatus
    • VideoSize
    • Error
    • Video job
    • VideoListResource
    • ImageRefParam-2
    • VideoSeconds
    • Create video multipart request
    • Create video JSON request
    • Create character request
    • VideoCharacterResource
    • VideoReferenceInputParam
    • Create video edit multipart request
    • Create video edit JSON request
    • Create video extension multipart request
    • Create video extension JSON request
    • Deleted video response
    • VideoContentVariant
    • Create video remix request
    • TruncationEnum
    • PersonalityEnum
    • TokenCountsBody
    • Token counts
    • PromptCacheRetentionEnum
    • ServiceTierEnum
    • CompactResponseMethodPublicBody
    • ItemField
    • The compacted response object
    • SkillResource
    • SkillListResource
    • Create skill request
    • Update skill request
    • DeletedSkillResource
    • SkillVersionResource
    • SkillVersionListResource
    • Create skill version request
    • DeletedSkillVersionResource
    • Tracing Configuration
    • Workflow
    • Rate limits
    • ChatSessionStatus
    • Automatic thread titling
    • File upload settings
    • History settings
    • ChatKit configuration
    • The chat session object
    • Tracing Configuration
    • Workflow settings
    • Expiration overrides
    • Rate limit overrides
    • Automatic thread titling configuration
    • File upload configuration
    • Chat history configuration
    • ChatKit configuration overrides
    • Create chat session request
    • User message input
    • User message quoted text
    • AttachmentType
    • Attachment
    • Tool choice
    • Inference options
    • User Message Item
    • File annotation source
    • File annotation
    • URL annotation source
    • URL annotation
    • Assistant message content
    • Assistant message
    • Widget message
    • ClientToolCallStatus
    • Client tool call
    • TaskType
    • Task item
    • Task group task
    • Task group
    • The thread item
    • Thread Items
    • Active thread status
    • Locked thread status
    • Closed thread status
    • The thread object
    • Deleted thread
    • Threads
    • Coordinate
    • Token counts
    • BetaTokenCountsBody
    • BetaToolChoiceParam
    • Specific shell tool choice
    • Specific apply patch tool choice
    • BetaSpecificProgrammaticToolCallingParam
    • Custom tool
    • MCP tool
    • Function tool
    • Hosted tool
    • Allowed tools
    • Tool choice mode
    • BetaConversationParam
    • Conversation object
    • BetaPersonalityEnum
    • BetaTruncationEnum
    • Reasoning
    • BetaReasoningEffort
    • BetaReasoningModeEnum
    • BetaResponseTextParam
    • BetaVerbosity
    • BetaTextResponseFormatConfiguration
    • JSON object
    • JSON schema
    • JSON schema
    • Text
    • BetaTool
    • Apply patch tool
    • BetaCallableToolAllowedCaller
    • Web search preview
    • BetaSearchContentType
    • BetaSearchContextSize
    • BetaApproximateLocation
    • Tool search tool
    • BetaEmptyModelParam
    • BetaToolSearchExecutionType
    • Namespace
    • Custom tool
    • Grammar format
    • BetaGrammarSyntax1
    • Text format
    • BetaFunctionToolParam
    • Shell tool
    • BetaContainerReferenceParam
    • BetaLocalEnvironmentParam
    • BetaLocalSkillParam
    • BetaContainerAutoParam
    • BetaInlineSkillParam
    • BetaInlineSkillSourceParam
    • BetaSkillReferenceParam
    • BetaContainerNetworkPolicyAllowlistParam
    • BetaContainerNetworkPolicyDomainSecretParam
    • BetaContainerNetworkPolicyDisabledParam
    • BetaContainerMemoryLimit
    • Local shell tool
    • Image generation tool
    • BetaImageGenActionEnum
    • BetaInputFidelity
    • BetaProgrammaticToolCallingParam
    • Code interpreter
    • CodeInterpreterToolAuto
    • MCP tool
    • MCP tool filter
    • Web search
    • BetaWebSearchApproximateLocation
    • Computer use preview
    • BetaComputerEnvironment
    • Computer
    • File search
    • BetaFilters
    • Compound Filter
    • Comparison Filter
    • BetaRankingOptions
    • BetaHybridSearchOptions
    • BetaRankerVersionType
    • Function
    • BetaInputItem
    • BetaProgramOutputItemParam
    • BetaProgramOutputItemStatus
    • Beta_AgentTagParam
    • BetaProgramItemParam
    • Item reference
    • Compaction trigger
    • BetaItem
    • Custom tool call
    • BetaToolCallCaller
    • BetaProgramToolCallCaller
    • BetaDirectToolCallCaller
    • BetaAgentTag
    • Custom tool call output
    • BetaFunctionAndCustomToolCallOutput
    • Input file
    • BetaFileInputDetail
    • Prompt cache breakpoint
    • Input image
    • BetaImageDetail
    • Input text
    • BetaToolCallCallerParam
    • BetaProgramToolCallCallerParam
    • BetaDirectToolCallCallerParam
    • MCP tool call
    • BetaMCPToolCallStatus
    • MCP approval response
    • MCP approval request
    • MCP list tools
    • MCP list tools tool
    • Apply patch tool call output
    • Apply patch call output status
    • Apply patch tool call
    • Apply patch operation
    • Apply patch update file operation
    • Apply patch delete file operation
    • Apply patch create file operation
    • Apply patch call status
    • Shell tool call output
    • Shell call status
    • Shell output content
    • Shell call outcome
    • Shell call exit outcome
    • Shell call timeout outcome
    • Shell tool call
    • Shell action
    • Local shell call output
    • Local shell call
    • Local shell exec action
    • Code interpreter tool call
    • Code interpreter output image
    • Code interpreter output logs
    • Image generation call
    • Compaction item
    • Reasoning
    • Reasoning text
    • Summary text
    • BetaAdditionalToolsItemParam
    • BetaToolSearchOutputItemParam
    • BetaFunctionCallItemStatus
    • BetaToolSearchCallItemParam
    • BetaMultiAgentCallOutputItemParam
    • BetaOutputTextContentParam
    • BetaContainerFileCitationParam
    • BetaUrlCitationParam
    • BetaFileCitationParam
    • BetaMultiAgentAction1
    • BetaMultiAgentCallItemParam
    • Agent message
    • Encrypted content
    • Input image
    • Prompt cache breakpoint
    • BetaDetailEnum
    • Input text
    • Function tool call output
    • Input file
    • BetaFileDetailEnum
    • Function tool call
    • Web search tool call
    • Find action
    • Open page action
    • Search action
    • Computer tool call output
    • BetaComputerCallSafetyCheckParam
    • BetaComputerScreenshotImage
    • Computer tool call
    • Computer Action List
    • BetaComputerAction
    • Wait
    • Type
    • Scroll
    • Screenshot
    • Move
    • KeyPress
    • Drag
    • Coordinate
    • DoubleClick
    • Click
    • BetaClickButtonType
    • File search tool call
    • BetaVectorStoreFileAttributes
    • Output message
    • BetaMessagePhase
    • BetaOutputMessageContent
    • Refusal
    • Output text
    • Log probability
    • Top log probability
    • BetaAnnotation
    • File path
    • Container file citation
    • URL citation
    • File citation
    • Input message
    • Input item content list
    • BetaInputContent
    • Input message
    • BetaCompactResponseMethodPublicBody
    • BetaServiceTierEnum
    • Prompt cache options
    • BetaPromptCacheModeEnum
    • BetaPromptCacheTTLEnum
    • BetaPromptCacheRetentionEnum
    • BetaModelIdsCompaction
    • BetaModelIdsResponses
    • BetaModelIdsShared
    • BetaError
    • BetaResponseItemList
    • BetaItemResource
    • ResponseCustomToolCallOutputItem
    • BetaFunctionCallOutputStatusEnum
    • ResponseCustomToolCallItem
    • BetaFunctionCallStatus
    • MCP approval response
    • Apply patch tool call output
    • BetaApplyPatchCallOutputStatus
    • Apply patch tool call
    • Apply patch update file operation
    • Apply patch delete file operation
    • Apply patch create file operation
    • BetaApplyPatchCallStatus
    • Shell call output
    • Shell call output content
    • Shell call exit outcome
    • Shell call timeout outcome
    • BetaFunctionShellCallOutputStatusEnum
    • Shell tool call
    • Container Reference
    • Local Environment
    • BetaFunctionShellCallStatus
    • Shell exec action
    • Compaction item
    • BetaProgramOutput
    • BetaProgramOutputStatus
    • BetaProgram
    • BetaAdditionalTools
    • BetaMessageRole
    • BetaToolSearchOutput
    • BetaToolSearchCall
    • BetaMultiAgentCallOutput
    • BetaMultiAgentAction
    • BetaMultiAgentCall
    • BetaAgentMessage
    • Encrypted content
    • Computer screenshot
    • Text Content
    • BetaFunctionToolCallOutputResource
    • Function tool call output
    • BetaFunctionToolCallResource
    • BetaComputerToolCallOutputResource
    • BetaComputerCallOutputStatus
    • Computer tool call output
    • BetaInputMessageResource
    • The compacted response object
    • BetaResponseUsage
    • BetaItemField
    • Message
    • BetaMessagePhase-2
    • BetaMessageStatus
    • ResponseCustomToolCallInputDone
    • ResponseCustomToolCallInputDelta
    • ResponseQueuedEvent
    • The response object
    • Conversation
    • Moderation
    • Moderation error
    • Moderation result
    • BetaModerationInputType
    • Prompt cache options
    • BetaOutputItem
    • BetaResponseError
    • BetaResponseErrorCode
    • BetaResponseProperties
    • BetaPrompt
    • BetaResponsePromptVariables
    • BetaToolsArray
    • BetaModelResponseProperties
    • BetaServiceTier
    • BetaMetadata
    • ResponseOutputTextAnnotationAddedEvent
    • ResponseMCPListToolsInProgressEvent
    • ResponseMCPListToolsFailedEvent
    • ResponseMCPListToolsCompletedEvent
    • ResponseMCPCallInProgressEvent
    • ResponseMCPCallFailedEvent
    • ResponseMCPCallCompletedEvent
    • ResponseMCPCallArgumentsDoneEvent
    • ResponseMCPCallArgumentsDeltaEvent
    • ResponseImageGenCallPartialImageEvent
    • ResponseImageGenCallInProgressEvent
    • ResponseImageGenCallGeneratingEvent
    • ResponseImageGenCallCompletedEvent
    • BetaResponseReasoningTextDoneEvent
    • BetaResponseReasoningTextDeltaEvent
    • BetaResponseReasoningSummaryTextDoneEvent
    • BetaResponseReasoningSummaryTextDeltaEvent
    • BetaResponseReasoningSummaryPartDoneEvent
    • BetaResponseReasoningSummaryPartAddedEvent
    • BetaResponseTextDoneEvent
    • BetaResponseLogProb
    • BetaResponseTextDeltaEvent
    • BetaResponseRefusalDoneEvent
    • BetaResponseRefusalDeltaEvent
    • BetaResponseOutputItemDoneEvent
    • BetaResponseOutputItemAddedEvent
    • BetaResponseInProgressEvent
    • BetaResponseFunctionCallArgumentsDoneEvent
    • BetaResponseFunctionCallArgumentsDeltaEvent
    • BetaResponseFileSearchCallSearchingEvent
    • BetaResponseFileSearchCallInProgressEvent
    • BetaResponseFileSearchCallCompletedEvent
    • BetaResponseErrorEvent
    • BetaResponseCreatedEvent
    • BetaResponseContentPartDoneEvent
    • BetaOutputContent
    • BetaResponseContentPartAddedEvent
    • BetaResponseCompletedEvent
    • BetaResponseCodeInterpreterCallInterpretingEvent
    • BetaResponseCodeInterpreterCallInProgressEvent
    • BetaResponseCodeInterpreterCallCompletedEvent
    • BetaResponseCodeInterpreterCallCodeDoneEvent
    • BetaResponseCodeInterpreterCallCodeDeltaEvent
    • BetaResponseAudioTranscriptDoneEvent
    • BetaResponseAudioTranscriptDeltaEvent
    • BetaResponseAudioDoneEvent
    • BetaResponseAudioDeltaEvent
    • BetaResponseIncompleteEvent
    • BetaResponseFailedEvent
    • BetaResponseWebSearchCallCompletedEvent
    • BetaResponseWebSearchCallSearchingEvent
    • BetaResponseWebSearchCallInProgressEvent
    • Output audio
    • Input audio
    • BetaInputParam
    • BetaContent
    • BetaIncludeEnum
    • BetaResponsesServerEvent
    • ResponseInjectFailedEvent
    • ResponseInjectCreatedEvent
    • BetaResponseStreamEvent
    • BetaResponsesClientEvent
    • ResponseInjectEvent
    • BetaResponsesClientEventResponseCreate
    • BetaCreateResponse
    • BetaMultiAgentParam
    • BetaContextManagementParam
    • BetaResponseStreamOptions
    • BetaModerationParam
    • BetaModerationPolicyParam
    • BetaModerationConfigParam
    • BetaModerationMode
    • BetaCreateModelResponseProperties

Getting Started

GraderTextSimilarity(TextSimilarityGrader)

Copy Page

A TextSimilarityGrader object which grades text based on similarity metrics.

{
    "type": "text_similarity",
    "name": "string",
    "input": "string",
    "reference": "string",
    "evaluation_metric": "cosine"
}