Crate openai_openapi_types Copy item path Source activate_project_certificates add_upload_part admin_api_key admin_api_keys_create admin_api_keys_delete admin_api_keys_get admin_api_keys_list archive_project assistant_object assistant_tools_file_search assistants_named_tool_choice audit_log audit_log_actor audit_log_actor_api_key batch batch_request_input batch_request_output cancel_batch cancel_eval_run cancel_fine_tuning_job cancel_response cancel_run cancel_upload cancel_vector_store_file_batch certificate chat_completion_allowed_tools chat_completion_message_custom_tool_call chat_completion_message_list chat_completion_message_tool_call chat_completion_message_tool_call_chunk chat_completion_message_tool_calls chat_completion_modalities chat_completion_named_tool_choice chat_completion_named_tool_choice_custom chat_completion_request_assistant_message chat_completion_request_developer_message chat_completion_request_message_content_part_audio chat_completion_request_message_content_part_file chat_completion_request_message_content_part_image chat_completion_request_system_message chat_completion_request_tool_message chat_completion_request_user_message chat_completion_response_message chat_completion_stream_response_delta chat_completion_token_logprob click code_interpreter_file_output code_interpreter_tool code_interpreter_tool_call comparison_filter complete_upload completion_usage compound_filter computer_call_output_item_param computer_tool_call computer_tool_call_output computer_tool_call_output_resource computer_use_preview_tool container_resource costs_result create_assistant_request create_batch create_chat_completion_request create_chat_completion_response create_chat_completion_stream_response create_completion_request create_completion_response create_container create_container_body create_container_file create_conversation_items create_embedding_request create_embedding_response create_eval_completions_run_data_source create_eval_item create_eval_jsonl_run_data_source create_eval_request create_eval_responses_run_data_source create_eval_run create_eval_run_request create_fine_tuning_checkpoint_permission create_fine_tuning_job_request create_image_edit_request create_image_request create_image_variation_request create_message create_message_request create_moderation_request create_moderation_response create_project_service_account create_project_user create_response create_run create_run_request create_run_request_without_stream create_speech_request create_thread_and_run_request create_thread_and_run_request_without_stream create_thread_request create_transcription create_transcription_request create_transcription_response_json create_translation create_translation_request create_upload_request create_vector_store_file create_vector_store_file_batch custom_tool custom_tool_chat_completions deactivate_project_certificates delete_assistant delete_chat_completion delete_container delete_container_file delete_conversation delete_conversation_item delete_eval delete_eval_run delete_file delete_fine_tuning_checkpoint_permission delete_invite delete_message delete_model delete_project_api_key delete_project_service_account delete_project_user delete_response delete_thread delete_user delete_vector_store delete_vector_store_file download_file easy_input_message eval eval_grader_string_check eval_grader_text_similarity eval_item eval_jsonl_file_content_source eval_run eval_run_output_item file_search_tool_call fine_tune_chat_completion_request_assistant_message fine_tune_chat_request_input fine_tune_dpo_hyperparameters fine_tune_method fine_tune_preference_request_input fine_tune_reinforcement_hyperparameters fine_tune_reinforcement_method fine_tune_reinforcement_request_input fine_tune_supervised_hyperparameters fine_tuning_integration fine_tuning_job fine_tuning_job_checkpoint fine_tuning_job_event function_call_output_item_param function_tool_call function_tool_call_output function_tool_call_output_resource function_tool_call_resource get_assistant get_certificate get_chat_completion get_chat_completion_messages get_conversation get_conversation_item get_eval get_eval_run get_eval_run_output_item get_eval_run_output_items get_eval_runs get_message get_response get_run get_run_step get_thread get_vector_store get_vector_store_file get_vector_store_file_batch grader_multi grader_string_check grader_text_similarity image_edit_completed_event image_edit_partial_image_event image_gen_completed_event image_gen_partial_image_event image_gen_tool image_gen_tool_call images_response images_usage input_audio input_image_content input_image_content_2 input_message input_message_resource invite invite_request item_reference_param list_assistants list_audit_logs list_batches list_chat_completions list_container_files list_containers list_conversation_items list_evals list_files list_files_in_vector_store_batch list_fine_tuning_checkpoint_permissions list_fine_tuning_events list_fine_tuning_job_checkpoints list_input_items list_invites list_messages list_organization_certificates list_paginated_fine_tuning_jobs list_project_api_keys list_project_certificates list_project_rate_limits list_project_service_accounts list_project_users list_projects list_run_steps list_runs list_users list_vector_store_files list_vector_stores local_shell_tool_call local_shell_tool_call_output mcp_tool message message_content_image_file_object message_content_image_url_object message_content_text_annotations_file_citation_object message_content_text_annotations_file_path_object message_content_text_object message_delta_content_image_file_object message_delta_content_image_url_object message_delta_content_text_annotations_file_citation_object message_delta_content_text_annotations_file_path_object message_delta_content_text_object message_delta_object message_object message_stream_event moderation_image_url_input modify_assistant modify_assistant_request modify_message modify_project modify_project_user modify_run modify_thread modify_thread_request modify_user modify_vector_store open_ai_file output_message pause_fine_tuning_job prediction_content project project_api_key project_service_account project_user project_user_create_request project_user_update_request ranking_options realtime_conversation_item realtime_conversation_item_content realtime_conversation_item_with_reference realtime_response realtime_response_create_params realtime_server_event_conversation_created realtime_server_event_conversation_item_input_audio_transcription_completed realtime_server_event_conversation_item_input_audio_transcription_failed realtime_server_event_error realtime_server_event_rate_limits_updated realtime_server_event_response_content_part_added realtime_server_event_response_content_part_done realtime_session realtime_session_create_request realtime_session_create_response realtime_transcription_session_create_request realtime_transcription_session_create_response reasoning reasoning_item response response_format_json_schema response_log_prob response_modalities response_prompt_variables response_properties response_reasoning_summary_part_added_event response_reasoning_summary_part_done_event response_usage resume_fine_tuning_job retrieve_batch retrieve_container retrieve_container_file retrieve_container_file_content retrieve_file retrieve_fine_tuning_job retrieve_invite retrieve_model retrieve_project retrieve_project_api_key retrieve_project_service_account retrieve_project_user retrieve_user retrieve_vector_store_file_content run_grader_request run_grader_response run_object run_step_delta_object_delta run_step_delta_step_details_message_creation_object run_step_delta_step_details_tool_calls_code_object run_step_delta_step_details_tool_calls_code_output_image_object run_step_delta_step_details_tool_calls_function_object run_step_details_message_creation_object run_step_details_tool_calls_code_object run_step_details_tool_calls_code_output_image_object run_step_details_tool_calls_file_search_object run_step_details_tool_calls_file_search_result_object run_step_details_tool_calls_function_object run_step_object run_step_stream_event run_stream_event run_tool_call_object search_vector_store speech_audio_done_event submit_tool_ouputs_to_run submit_tool_outputs_run_request submit_tool_outputs_run_request_without_stream thread_object thread_stream_event tool_choice_allowed tool_choice_types transcript_text_delta_event transcript_text_done_event transcript_text_usage_tokens truncation_object update_chat_completion update_conversation update_eval update_project_rate_limits update_vector_store_file_attributes upload usage_audio_speeches usage_audio_transcriptions usage_code_interpreter_sessions usage_completions usage_costs usage_embeddings usage_images usage_moderations usage_time_bucket usage_vector_stores user user_role_update_request vad_config validate_grader_request validate_grader_response vector_store_file_attributes vector_store_file_batch_object vector_store_file_content_response vector_store_file_object vector_store_object vector_store_search_request vector_store_search_result_content_object web_search_preview_tool web_search_tool_call webhook_batch_cancelled webhook_batch_completed webhook_batch_expired webhook_batch_failed webhook_eval_run_canceled webhook_eval_run_failed webhook_eval_run_succeeded webhook_fine_tuning_job_cancelled webhook_fine_tuning_job_failed webhook_fine_tuning_job_succeeded webhook_response_cancelled webhook_response_completed webhook_response_failed webhook_response_incomplete AddUploadPartRequest AdminApiKey Represents an individual Admin API key in an org. ApiKeyList ApproximateLocation AssistantObject Represents an assistant that can call the model and use tools. AssistantToolsCode AssistantToolsFileSearch AssistantToolsFileSearchTypeOnly AssistantToolsFunction AssistantsNamedToolChoice Specifies a tool the model should use. Use to force the model to call a specific tool. AuditLog A log of a user action or configuration change within this organization. AuditLogActor The actor who performed the audit logged action. AuditLogActorApiKey The API Key used to perform the audit logged action. AuditLogActorServiceAccount The service account that performed the audit logged action. AuditLogActorSession The session in which the audit logged action was performed. AuditLogActorUser The user who performed the audit logged action. AutoChunkingStrategyRequestParam The default strategy. This strategy currently uses a max_chunk_size_tokens of 800 and chunk_overlap_tokens of 400. Batch BatchError BatchFileExpirationAfter The expiration policy for the output and/or error file that are generated for a batch. BatchRequestCounts The request counts for different statuses within the batch. BatchRequestInput The per-line object of the batch input file BatchRequestOutput The per-line object of the batch output and error files Certificate Represents an individual certificate uploaded to the organization. ChatCompletionAllowedTools Constrains the tools available to the model to a pre-defined set. ChatCompletionAllowedToolsChoice Constrains the tools available to the model to a pre-defined set. ChatCompletionDeleted ChatCompletionFunctionCallOption Specifying a particular function via {"name": "my_function"} forces the model to call that function. ChatCompletionFunctions ChatCompletionList An object representing a list of Chat Completions. ChatCompletionMessageCustomToolCall A call to a custom tool created by the model. ChatCompletionMessageList An object representing a list of chat completion messages. ChatCompletionMessageToolCall A call to a function tool created by the model. ChatCompletionMessageToolCallChunk ChatCompletionNamedToolChoice Specifies a tool the model should use. Use to force the model to call a specific function. ChatCompletionNamedToolChoiceCustom Specifies a tool the model should use. Use to force the model to call a specific custom tool. ChatCompletionRequestAssistantMessage Messages sent by the model in response to user messages. ChatCompletionRequestDeveloperMessage Developer-provided instructions that the model should follow, regardless of
messages sent by the user. With o1 models and newer, developer messages
replace the previous system messages. ChatCompletionRequestFunctionMessage ChatCompletionRequestMessageContentPartAudio Learn about audio inputs . ChatCompletionRequestMessageContentPartFile Learn about file inputs for text generation. ChatCompletionRequestMessageContentPartImage Learn about image inputs . ChatCompletionRequestMessageContentPartRefusal ChatCompletionRequestMessageContentPartText Learn about text inputs . ChatCompletionRequestSystemMessage Developer-provided instructions that the model should follow, regardless of
messages sent by the user. With o1 models and newer, use developer messages
for this purpose instead. ChatCompletionRequestToolMessage ChatCompletionRequestUserMessage Messages sent by an end user, containing prompts or additional context
information. ChatCompletionResponseMessage A chat completion message generated by the model. ChatCompletionStreamOptions Options for streaming response. Only set this when you set stream: true. ChatCompletionStreamResponseDelta A chat completion delta generated by streamed model responses. ChatCompletionTokenLogprob ChatCompletionTool A function tool that can be used to generate a response. Click A click action. CodeInterpreterFileOutput The output of a code interpreter tool call that is a file. CodeInterpreterOutputImage The image output from the code interpreter. CodeInterpreterOutputLogs The logs output from the code interpreter. CodeInterpreterTextOutput The output of a code interpreter tool call that is text. CodeInterpreterTool A tool that runs Python code to help generate a response to a prompt. CodeInterpreterToolAuto Configuration for a code interpreter container. Optionally specify the IDs
of the files to run the code on. CodeInterpreterToolCall A tool call to run code. ComparisonFilter A filter used to compare a specified attribute key to a given value using a defined comparison operation. CompleteUploadRequest CompletionUsage Usage statistics for the completion request. CompoundFilter Combine multiple filters using and or or. ComputerCallOutputItemParam The output of a computer tool call. ComputerCallSafetyCheckParam A pending safety check for the computer call. ComputerScreenshotContent ComputerScreenshotImage A computer screenshot image used with the computer use tool. ComputerToolCall A tool call to a computer use tool. See the
computer use guide for more information. ComputerToolCallOutput The output of a computer tool call. ComputerToolCallOutputResource ComputerToolCallSafetyCheck A pending safety check for the computer call. ComputerUsePreviewTool A tool that controls a virtual computer. Learn more about the computer tool . ContainerFileCitationBody A citation for a container file used to generate a model response. ContainerFileCitationBody2 ContainerFileListResource ContainerFileResource ContainerListResource ContainerResource Conversation Conversation2 The conversation that this response belongs to. Input items and output items from this response are automatically added to this conversation. ConversationItemList A list of Conversation items. ConversationParam The conversation that this response belongs to. ConversationResource Coordinate An x/y coordinate pair, e.g. { x: 100, y: 200 }. CostsResult The aggregated costs details of the specific time bucket. CreateAssistantRequest CreateChatCompletionRequest CreateChatCompletionResponse Represents a chat completion response returned by model, based on the provided input. CreateChatCompletionStreamResponse Represents a streamed chunk of a chat completion response returned
by the model, based on the provided input.
Learn more . CreateCompletionRequest CreateCompletionResponse Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint). CreateContainerBody CreateContainerFileBody CreateConversationRequest Create a conversation CreateEmbeddingRequest CreateEmbeddingResponse CreateEvalCompletionsRunDataSource A CompletionsRunDataSource object describing a model sampling configuration. CreateEvalCustomDataSourceConfig A CustomDataSourceConfig object that defines the schema for the data source used for the evaluation runs.
This schema is used to define the shape of the data that will be: CreateEvalJsonlRunDataSource A JsonlRunDataSource object with that specifies a JSONL file that matches the eval CreateEvalLabelModelGrader A LabelModelGrader object which uses a model to assign labels to each item
in the evaluation. CreateEvalLogsDataSourceConfig A data source config which specifies the metadata property of your logs query.
This is usually metadata like usecase=chatbot or prompt-version=v2, etc. CreateEvalRequest CreateEvalResponsesRunDataSource A ResponsesRunDataSource object describing a model sampling configuration. CreateEvalRunRequest CreateEvalStoredCompletionsDataSourceConfig Deprecated in favor of LogsDataSourceConfig. CreateFileRequest CreateFineTuningCheckpointPermissionRequest CreateFineTuningJobRequest CreateImageEditRequest CreateImageRequest CreateImageVariationRequest CreateMessageRequest CreateModelResponseProperties CreateModerationRequest CreateModerationResponse Represents if a given text input is potentially harmful. CreateResponse CreateRunRequest CreateRunRequestWithoutStream CreateSpeechRequest CreateThreadAndRunRequest CreateThreadAndRunRequestWithoutStream CreateThreadRequest Options to create a new thread. If no thread is provided when running a
request, an empty thread will be created. CreateTranscriptionRequest CreateTranscriptionResponseJson Represents a transcription response returned by model, based on the provided input. CreateTranscriptionResponseVerboseJson Represents a verbose json transcription response returned by model, based on the provided input. CreateTranslationRequest CreateTranslationResponseJson CreateTranslationResponseVerboseJson CreateUploadRequest CreateVectorStoreFileBatchRequest CreateVectorStoreFileRequest CreateVectorStoreRequest CustomTool A custom tool that processes input using a specified format. Learn more about
custom tools . CustomToolCall A call to a custom tool created by the model. CustomToolCallOutput The output of a custom tool call from your code, being sent back to the model. CustomToolChatCompletions A custom tool that processes input using a specified format. DeleteAssistantResponse DeleteCertificateResponse DeleteFileResponse DeleteFineTuningCheckpointPermissionResponse DeleteMessageResponse DeleteModelResponse DeleteThreadResponse DeleteVectorStoreFileResponse DeleteVectorStoreResponse DeletedConversation DeletedConversationResource DoneEvent Occurs when a stream ends. DoubleClick A double click action. Drag A drag action. EasyInputMessage A message input to the model with a role indicating instruction following
hierarchy. Instructions given with the developer or system role take
precedence over instructions given with the user role. Messages with the
assistant role are presumed to have been generated by the model in previous
interactions. Embedding Represents an embedding vector returned by embedding endpoint. Error ErrorEvent Occurs when an error occurs. This can happen due to an internal server error or a timeout. ErrorResponse Eval An Eval object with a data source config and testing criteria.
An Eval represents a task to be done for your LLM integration.
Like: EvalApiError An object representing an error response from the Eval API. EvalCustomDataSourceConfig A CustomDataSourceConfig which specifies the schema of your item and optionally sample namespaces.
The response schema defines the shape of the data that will be: EvalGraderLabelModel EvalGraderPython EvalGraderScoreModel EvalGraderStringCheck EvalGraderTextSimilarity EvalItem A message input to the model with a role indicating instruction following
hierarchy. Instructions given with the developer or system role take
precedence over instructions given with the user role. Messages with the
assistant role are presumed to have been generated by the model in previous
interactions. EvalJsonlFileContentSource EvalJsonlFileIdSource EvalList An object representing a list of evals. EvalLogsDataSourceConfig A LogsDataSourceConfig which specifies the metadata property of your logs query.
This is usually metadata like usecase=chatbot or prompt-version=v2, etc.
The schema returned by this data source config is used to defined what variables are available in your evals.
item and sample are both defined when using this data source config. EvalResponsesSource A EvalResponsesSource object describing a run data source configuration. EvalRun A schema representing an evaluation run. EvalRunList An object representing a list of runs for an evaluation. EvalRunOutputItem A schema representing an evaluation run output item. EvalRunOutputItemList An object representing a list of output items for an evaluation run. EvalStoredCompletionsDataSourceConfig Deprecated in favor of LogsDataSourceConfig. EvalStoredCompletionsSource A StoredCompletionsRunDataSource configuration describing a set of filters FileCitationBody A citation to a file. FileCitationBody2 FileExpirationAfter The expiration policy for a file. By default, files with purpose=batch expire after 30 days and all other files are persisted until they are manually deleted. FilePath A path to a file. FileSearchRankingOptions The ranking options for the file search. If not specified, the file search tool will use the auto ranker and a score_threshold of 0. FileSearchTool A tool that searches for relevant content from uploaded files. Learn more about the file search tool . FileSearchToolCall The results of a file search tool call. See the
file search guide for more information. FineTuneChatCompletionRequestAssistantMessage FineTuneChatRequestInput The per-line training example of a fine-tuning input file for chat models using the supervised method.
Input messages may contain text or image content only. Audio and file input messages
are not currently supported for fine-tuning. FineTuneDpoHyperparameters The hyperparameters used for the DPO fine-tuning job. FineTuneDpoMethod Configuration for the DPO fine-tuning method. FineTuneMethod The method used for fine-tuning. FineTunePreferenceRequestInput The per-line training example of a fine-tuning input file for chat models using the dpo method.
Input messages may contain text or image content only. Audio and file input messages
are not currently supported for fine-tuning. FineTuneReinforcementHyperparameters The hyperparameters used for the reinforcement fine-tuning job. FineTuneReinforcementMethod Configuration for the reinforcement fine-tuning method. FineTuneReinforcementRequestInput Per-line training example for reinforcement fine-tuning. Note that messages and tools are the only reserved keywords.
Any other arbitrary key-value data can be included on training datapoints and will be available to reference during grading under the {{ item.XXX }} template variable.
Input messages may contain text or image content only. Audio and file input messages
are not currently supported for fine-tuning. FineTuneSupervisedHyperparameters The hyperparameters used for the fine-tuning job. FineTuneSupervisedMethod Configuration for the supervised fine-tuning method. FineTuningCheckpointPermission The checkpoint.permission object represents a permission for a fine-tuned model checkpoint. FineTuningIntegration FineTuningJob The fine_tuning.job object represents a fine-tuning job that has been created through the API. FineTuningJobCheckpoint The fine_tuning.job.checkpoint object represents a model checkpoint for a fine-tuning job that is ready to use. FineTuningJobEvent Fine-tuning job event object FunctionCallOutputItemParam The output of a function tool call. FunctionObject FunctionTool Defines a function in your own code the model can choose to call. Learn more about function calling . FunctionToolCall A tool call to run a function. See the
function calling guide for more information. FunctionToolCallOutput The output of a function tool call. FunctionToolCallOutputResource FunctionToolCallResource GraderLabelModel A LabelModelGrader object which uses a model to assign labels to each item
in the evaluation. GraderMulti A MultiGrader object combines the output of multiple graders to produce a single score. GraderPython A PythonGrader object that runs a python script on the input. GraderScoreModel A ScoreModelGrader object that uses a model to assign a score to the input. GraderStringCheck A StringCheckGrader object that performs a string comparison between input and reference using a specified operation. GraderTextSimilarity A TextSimilarityGrader object which grades text based on similarity metrics. Image Represents the content or the URL of an image generated by the OpenAI API. ImageEditCompletedEvent Emitted when image editing has completed and the final image is available. ImageEditPartialImageEvent Emitted when a partial image is available during image editing streaming. ImageGenCompletedEvent Emitted when image generation has completed and the final image is available. ImageGenInputUsageDetails The input tokens detailed information for the image generation. ImageGenPartialImageEvent Emitted when a partial image is available during image generation streaming. ImageGenTool A tool that generates images using a model like gpt-image-1. ImageGenToolCall An image generation request made by the model. ImageGenUsage For gpt-image-1 only, the token usage information for the image generation. ImagesResponse The response from the image generation endpoint. ImagesUsage For gpt-image-1 only, the token usage information for the image generation. InputAudio An audio input to the model. InputFileContent A file input to the model. InputFileContent2 InputImageContent An image input to the model. Learn about image inputs . InputImageContent2 InputMessage A message input to the model with a role indicating instruction following
hierarchy. Instructions given with the developer or system role take
precedence over instructions given with the user role. InputMessageResource InputTextContent A text input to the model. InputTextContent2 Invite Represents an individual invite to the organization. InviteDeleteResponse InviteListResponse InviteRequest ItemReferenceParam An internal identifier for an item to reference. KeyPress A collection of keypresses the model would like to perform. ListAssistantsResponse ListAuditLogsResponse ListBatchesResponse ListCertificatesResponse ListFilesResponse ListFineTuningCheckpointPermissionResponse ListFineTuningJobCheckpointsResponse ListFineTuningJobEventsResponse ListMessagesResponse ListModelsResponse ListPaginatedFineTuningJobsResponse ListRunStepsResponse ListRunsResponse ListVectorStoreFilesResponse ListVectorStoresResponse LocalShellExecAction Execute a shell command on the server. LocalShellTool A tool that allows the model to execute shell commands in a local environment. LocalShellToolCall A tool call to run a command on the local shell. LocalShellToolCallOutput The output of a local shell tool call. LogProb The log probability of a token. LogProb2 LogProbProperties A log probability object. McpApprovalRequest A request for human approval of a tool invocation. McpApprovalResponse A response to an MCP approval request. McpApprovalResponseResource A response to an MCP approval request. McpListTools A list of tools available on an MCP server. McpListToolsTool A tool available on an MCP server. McpTool Give the model access to additional tools via remote Model Context Protocol
(MCP) servers. Learn more about MCP . McpToolCall An invocation of a tool on an MCP server. McpToolFilter A filter object to specify which tools are allowed. Message MessageContentImageFileObject References an image File in the content of a message. MessageContentImageUrlObject References an image URL in the content of a message. MessageContentRefusalObject The refusal content generated by the assistant. MessageContentTextAnnotationsFileCitationObject A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the “file_search” tool to search files. MessageContentTextAnnotationsFilePathObject A URL for the file that’s generated when the assistant used the code_interpreter tool to generate a file. MessageContentTextObject The text content that is part of a message. MessageDeltaContentImageFileObject References an image File in the content of a message. MessageDeltaContentImageUrlObject References an image URL in the content of a message. MessageDeltaContentRefusalObject The refusal content that is part of a message. MessageDeltaContentTextAnnotationsFileCitationObject A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the “file_search” tool to search files. MessageDeltaContentTextAnnotationsFilePathObject A URL for the file that’s generated when the assistant used the code_interpreter tool to generate a file. MessageDeltaContentTextObject The text content that is part of a message. MessageDeltaObject Represents a message delta i.e. any changed fields on a message during streaming. MessageObject Represents a message within a thread . MessageRequestContentTextObject The text content that is part of a message. Model Describes an OpenAI model offering that can be used with the API. ModelResponseProperties ModerationImageUrlInput An object describing an image to classify. ModerationTextInput An object describing text to classify. ModifyAssistantRequest ModifyCertificateRequest ModifyMessageRequest ModifyRunRequest ModifyThreadRequest Move A mouse move action. OpenAiFile The File object represents a document that has been uploaded to OpenAI. OtherChunkingStrategyResponseParam This is returned when the chunking strategy is unknown. Typically, this is because the file was indexed before the chunking_strategy concept was introduced in the API. OutputAudio An audio output from the model. OutputMessage An output message from the model. OutputTextContent A text output from the model. OutputTextContent2 PredictionContent Static predicted output content, such as the content of a text file that is
being regenerated. Project Represents an individual project. ProjectApiKey Represents an individual API key in a project. ProjectApiKeyDeleteResponse ProjectApiKeyListResponse ProjectCreateRequest ProjectListResponse ProjectRateLimit Represents a project rate limit config. ProjectRateLimitListResponse ProjectRateLimitUpdateRequest ProjectServiceAccount Represents an individual service account in a project. ProjectServiceAccountApiKey ProjectServiceAccountCreateRequest ProjectServiceAccountCreateResponse ProjectServiceAccountDeleteResponse ProjectServiceAccountListResponse ProjectUpdateRequest ProjectUser Represents an individual user in a project. ProjectUserCreateRequest ProjectUserDeleteResponse ProjectUserListResponse ProjectUserUpdateRequest Prompt Reference to a prompt template and its variables.
Learn more . RankingOptions RealtimeClientEventConversationItemCreate Add a new Item to the Conversation’s context, including messages, function
calls, and function call responses. This event can be used both to populate a
“history” of the conversation and to add new items mid-stream, but has the
current limitation that it cannot populate assistant audio messages. RealtimeClientEventConversationItemDelete Send this event when you want to remove any item from the conversation
history. The server will respond with a conversation.item.deleted event,
unless the item does not exist in the conversation history, in which case the
server will respond with an error. RealtimeClientEventConversationItemRetrieve Send this event when you want to retrieve the server’s representation of a specific item in the conversation history. This is useful, for example, to inspect user audio after noise cancellation and VAD.
The server will respond with a conversation.item.retrieved event,
unless the item does not exist in the conversation history, in which case the
server will respond with an error. RealtimeClientEventConversationItemTruncate Send this event to truncate a previous assistant message’s audio. The server
will produce audio faster than realtime, so this event is useful when the user
interrupts to truncate audio that has already been sent to the client but not
yet played. This will synchronize the server’s understanding of the audio with
the client’s playback. RealtimeClientEventInputAudioBufferAppend Send this event to append audio bytes to the input audio buffer. The audio
buffer is temporary storage you can write to and later commit. In Server VAD
mode, the audio buffer is used to detect speech and the server will decide
when to commit. When Server VAD is disabled, you must commit the audio buffer
manually. RealtimeClientEventInputAudioBufferClear Send this event to clear the audio bytes in the buffer. The server will
respond with an input_audio_buffer.cleared event. RealtimeClientEventInputAudioBufferCommit Send this event to commit the user input audio buffer, which will create a
new user message item in the conversation. This event will produce an error
if the input audio buffer is empty. When in Server VAD mode, the client does
not need to send this event, the server will commit the audio buffer
automatically. RealtimeClientEventOutputAudioBufferClear WebRTC Only: Emit to cut off the current audio response. This will trigger the server to
stop generating audio and emit a output_audio_buffer.cleared event. This
event should be preceded by a response.cancel client event to stop the
generation of the current response.
Learn more .RealtimeClientEventResponseCancel Send this event to cancel an in-progress response. The server will respond
with a response.done event with a status of response.status=cancelled. If
there is no response to cancel, the server will respond with an error. RealtimeClientEventResponseCreate This event instructs the server to create a Response, which means triggering
model inference. When in Server VAD mode, the server will create Responses
automatically. RealtimeClientEventSessionUpdate Send this event to update the session’s default configuration.
The client may send this event at any time to update any field,
except for voice. However, note that once a session has been
initialized with a particular model, it can’t be changed to
another model using session.update. RealtimeClientEventTranscriptionSessionUpdate Send this event to update a transcription session. RealtimeConnectParams RealtimeConversationItem The item to add to the conversation. RealtimeConversationItemContent RealtimeConversationItemWithReference The item to add to the conversation. RealtimeResponse The response resource. RealtimeResponseCreateParams Create a new Realtime response with these parameters RealtimeServerEventConversationCreated Returned when a conversation is created. Emitted right after session creation. RealtimeServerEventConversationItemCreated Returned when a conversation item is created. There are several scenarios that produce this event: RealtimeServerEventConversationItemDeleted Returned when an item in the conversation is deleted by the client with a
conversation.item.delete event. This event is used to synchronize the
server’s understanding of the conversation history with the client’s view. RealtimeServerEventConversationItemInputAudioTranscriptionCompleted This event is the output of audio transcription for user audio written to the
user audio buffer. Transcription begins when the input audio buffer is
committed by the client or server (in server_vad mode). Transcription runs
asynchronously with Response creation, so this event may come before or after
the Response events. RealtimeServerEventConversationItemInputAudioTranscriptionDelta Returned when the text value of an input audio transcription content part is updated. RealtimeServerEventConversationItemInputAudioTranscriptionFailed Returned when input audio transcription is configured, and a transcription
request for a user message failed. These events are separate from other
error events so that the client can identify the related Item. RealtimeServerEventConversationItemRetrieved Returned when a conversation item is retrieved with conversation.item.retrieve. RealtimeServerEventConversationItemTruncated Returned when an earlier assistant audio message item is truncated by the
client with a conversation.item.truncate event. This event is used to
synchronize the server’s understanding of the audio with the client’s playback. RealtimeServerEventError Returned when an error occurs, which could be a client problem or a server
problem. Most errors are recoverable and the session will stay open, we
recommend to implementors to monitor and log error messages by default. RealtimeServerEventInputAudioBufferCleared Returned when the input audio buffer is cleared by the client with a
input_audio_buffer.clear event. RealtimeServerEventInputAudioBufferCommitted Returned when an input audio buffer is committed, either by the client or
automatically in server VAD mode. The item_id property is the ID of the user
message item that will be created, thus a conversation.item.created event
will also be sent to the client. RealtimeServerEventInputAudioBufferSpeechStarted Sent by the server when in server_vad mode to indicate that speech has been
detected in the audio buffer. This can happen any time audio is added to the
buffer (unless speech is already detected). The client may want to use this
event to interrupt audio playback or provide visual feedback to the user. RealtimeServerEventInputAudioBufferSpeechStopped Returned in server_vad mode when the server detects the end of speech in
the audio buffer. The server will also send an conversation.item.created
event with the user message item that is created from the audio buffer. RealtimeServerEventOutputAudioBufferCleared WebRTC Only: Emitted when the output audio buffer is cleared. This happens either in VAD
mode when the user has interrupted (input_audio_buffer.speech_started),
or when the client has emitted the output_audio_buffer.clear event to manually
cut off the current audio response.
Learn more .RealtimeServerEventOutputAudioBufferStarted WebRTC Only: Emitted when the server begins streaming audio to the client. This event is
emitted after an audio content part has been added (response.content_part.added)
to the response.
Learn more .RealtimeServerEventOutputAudioBufferStopped WebRTC Only: Emitted when the output audio buffer has been completely drained on the server,
and no more audio is forthcoming. This event is emitted after the full response
data has been sent to the client (response.done).
Learn more .RealtimeServerEventRateLimitsUpdated Emitted at the beginning of a Response to indicate the updated rate limits.
When a Response is created some tokens will be “reserved” for the output
tokens, the rate limits shown here reflect that reservation, which is then
adjusted accordingly once the Response is completed. RealtimeServerEventResponseAudioDelta Returned when the model-generated audio is updated. RealtimeServerEventResponseAudioDone Returned when the model-generated audio is done. Also emitted when a Response
is interrupted, incomplete, or cancelled. RealtimeServerEventResponseAudioTranscriptDelta Returned when the model-generated transcription of audio output is updated. RealtimeServerEventResponseAudioTranscriptDone Returned when the model-generated transcription of audio output is done
streaming. Also emitted when a Response is interrupted, incomplete, or
cancelled. RealtimeServerEventResponseContentPartAdded Returned when a new content part is added to an assistant message item during
response generation. RealtimeServerEventResponseContentPartDone Returned when a content part is done streaming in an assistant message item.
Also emitted when a Response is interrupted, incomplete, or cancelled. RealtimeServerEventResponseCreated Returned when a new Response is created. The first event of response creation,
where the response is in an initial state of in_progress. RealtimeServerEventResponseDone Returned when a Response is done streaming. Always emitted, no matter the
final state. The Response object included in the response.done event will
include all output Items in the Response but will omit the raw audio data. RealtimeServerEventResponseFunctionCallArgumentsDelta Returned when the model-generated function call arguments are updated. RealtimeServerEventResponseFunctionCallArgumentsDone Returned when the model-generated function call arguments are done streaming.
Also emitted when a Response is interrupted, incomplete, or cancelled. RealtimeServerEventResponseOutputItemAdded Returned when a new Item is created during Response generation. RealtimeServerEventResponseOutputItemDone Returned when an Item is done streaming. Also emitted when a Response is
interrupted, incomplete, or cancelled. RealtimeServerEventResponseTextDelta Returned when the text value of a “text” content part is updated. RealtimeServerEventResponseTextDone Returned when the text value of a “text” content part is done streaming. Also
emitted when a Response is interrupted, incomplete, or cancelled. RealtimeServerEventSessionCreated Returned when a Session is created. Emitted automatically when a new
connection is established as the first server event. This event will contain
the default Session configuration. RealtimeServerEventSessionUpdated Returned when a session is updated with a session.update event, unless
there is an error. RealtimeServerEventTranscriptionSessionUpdated Returned when a transcription session is updated with a transcription_session.update event, unless
there is an error. RealtimeSession Realtime session object configuration. RealtimeSessionCreateRequest Realtime session object configuration. RealtimeSessionCreateResponse A new Realtime session configuration, with an ephemeral key. Default TTL
for keys is one minute. RealtimeTranscriptionSessionCreateRequest Realtime transcription session object configuration. RealtimeTranscriptionSessionCreateResponse A new Realtime transcription session configuration. Reasoning gpt-5 and o-series models only ReasoningItem A description of the chain of thought used by a reasoning model while generating
a response. Be sure to include these items in your input to the Responses API
for subsequent turns of a conversation if you are manually
managing context . RefusalContent A refusal from the model. RefusalContent2 Response ResponseAudioDeltaEvent Emitted when there is a partial audio response. ResponseAudioDoneEvent Emitted when the audio response is complete. ResponseAudioTranscriptDeltaEvent Emitted when there is a partial transcript of audio. ResponseAudioTranscriptDoneEvent Emitted when the full audio transcript is completed. ResponseCodeInterpreterCallCodeDeltaEvent Emitted when a partial code snippet is streamed by the code interpreter. ResponseCodeInterpreterCallCodeDoneEvent Emitted when the code snippet is finalized by the code interpreter. ResponseCodeInterpreterCallCompletedEvent Emitted when the code interpreter call is completed. ResponseCodeInterpreterCallInProgressEvent Emitted when a code interpreter call is in progress. ResponseCodeInterpreterCallInterpretingEvent Emitted when the code interpreter is actively interpreting the code snippet. ResponseCompletedEvent Emitted when the model response is complete. ResponseContentPartAddedEvent Emitted when a new content part is added. ResponseContentPartDoneEvent Emitted when a content part is done. ResponseCreatedEvent An event that is emitted when a response is created. ResponseCustomToolCallInputDeltaEvent Event representing a delta (partial update) to the input of a custom tool call. ResponseCustomToolCallInputDoneEvent Event indicating that input for a custom tool call is complete. ResponseError An error object returned when the model fails to generate a Response. ResponseErrorEvent Emitted when an error occurs. ResponseFailedEvent An event that is emitted when a response fails. ResponseFileSearchCallCompletedEvent Emitted when a file search call is completed (results found). ResponseFileSearchCallInProgressEvent Emitted when a file search call is initiated. ResponseFileSearchCallSearchingEvent Emitted when a file search is currently searching. ResponseFormatJsonObject JSON object response format. An older method of generating JSON responses.
Using json_schema is recommended for models that support it. Note that the
model will not generate JSON without a system or user message instructing it
to do so. ResponseFormatJsonSchema JSON Schema response format. Used to generate structured JSON responses.
Learn more about Structured Outputs . ResponseFormatText Default response format. Used to generate text responses. ResponseFormatTextGrammar A custom grammar for the model to follow when generating text.
Learn more in the custom grammars guide . ResponseFormatTextPython Configure the model to generate valid Python code. See the
custom grammars guide for more details. ResponseFunctionCallArgumentsDeltaEvent Emitted when there is a partial function-call arguments delta. ResponseFunctionCallArgumentsDoneEvent Emitted when function-call arguments are finalized. ResponseImageGenCallCompletedEvent Emitted when an image generation tool call has completed and the final image is available. ResponseImageGenCallGeneratingEvent Emitted when an image generation tool call is actively generating an image (intermediate state). ResponseImageGenCallInProgressEvent Emitted when an image generation tool call is in progress. ResponseImageGenCallPartialImageEvent Emitted when a partial image is available during image generation streaming. ResponseInProgressEvent Emitted when the response is in progress. ResponseIncompleteEvent An event that is emitted when a response finishes as incomplete. ResponseItemList A list of Response items. ResponseLogProb A logprob is the logarithmic probability that the model assigns to producing
a particular token at a given position in the sequence. Less-negative (higher)
logprob values indicate greater model confidence in that token choice. ResponseMcpCallArgumentsDeltaEvent Emitted when there is a delta (partial update) to the arguments of an MCP tool call. ResponseMcpCallArgumentsDoneEvent Emitted when the arguments for an MCP tool call are finalized. ResponseMcpCallCompletedEvent Emitted when an MCP tool call has completed successfully. ResponseMcpCallFailedEvent Emitted when an MCP tool call has failed. ResponseMcpCallInProgressEvent Emitted when an MCP tool call is in progress. ResponseMcpListToolsCompletedEvent Emitted when the list of available MCP tools has been successfully retrieved. ResponseMcpListToolsFailedEvent Emitted when the attempt to list available MCP tools has failed. ResponseMcpListToolsInProgressEvent Emitted when the system is in the process of retrieving the list of available MCP tools. ResponseOutputItemAddedEvent Emitted when a new output item is added. ResponseOutputItemDoneEvent Emitted when an output item is marked done. ResponseOutputTextAnnotationAddedEvent Emitted when an annotation is added to output text content. ResponseProperties ResponseQueuedEvent Emitted when a response is queued and waiting to be processed. ResponseReasoningSummaryPartAddedEvent Emitted when a new reasoning summary part is added. ResponseReasoningSummaryPartDoneEvent Emitted when a reasoning summary part is completed. ResponseReasoningSummaryTextDeltaEvent Emitted when a delta is added to a reasoning summary text. ResponseReasoningSummaryTextDoneEvent Emitted when a reasoning summary text is completed. ResponseReasoningTextDeltaEvent Emitted when a delta is added to a reasoning text. ResponseReasoningTextDoneEvent Emitted when a reasoning text is completed. ResponseRefusalDeltaEvent Emitted when there is a partial refusal text. ResponseRefusalDoneEvent Emitted when refusal text is finalized. ResponseStreamOptions Options for streaming responses. Only set this when you set stream: true. ResponseTextDeltaEvent Emitted when there is an additional text delta. ResponseTextDoneEvent Emitted when text content is finalized. ResponseUsage Represents token usage details including input tokens, output tokens,
a breakdown of output tokens, and the total tokens used. ResponseWebSearchCallCompletedEvent Emitted when a web search call is completed. ResponseWebSearchCallInProgressEvent Emitted when a web search call is initiated. ResponseWebSearchCallSearchingEvent Emitted when a web search call is executing. RunCompletionUsage Usage statistics related to the run. This value will be null if the run is not in a terminal state (i.e. in_progress, queued, etc.). RunGraderRequest RunGraderResponse RunObject Represents an execution run on a thread . RunStepCompletionUsage Usage statistics related to the run step. This value will be null while the run step’s status is in_progress. RunStepDeltaObject Represents a run step delta i.e. any changed fields on a run step during streaming. RunStepDeltaObjectDelta The delta containing the fields that have changed on the run step. RunStepDeltaStepDetailsMessageCreationObject Details of the message creation by the run step. RunStepDeltaStepDetailsToolCallsCodeObject Details of the Code Interpreter tool call the run step was involved in. RunStepDeltaStepDetailsToolCallsCodeOutputImageObject RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject Text output from the Code Interpreter tool call as part of a run step. RunStepDeltaStepDetailsToolCallsFileSearchObject RunStepDeltaStepDetailsToolCallsFunctionObject RunStepDeltaStepDetailsToolCallsObject Details of the tool call. RunStepDetailsMessageCreationObject Details of the message creation by the run step. RunStepDetailsToolCallsCodeObject Details of the Code Interpreter tool call the run step was involved in. RunStepDetailsToolCallsCodeOutputImageObject RunStepDetailsToolCallsCodeOutputLogsObject Text output from the Code Interpreter tool call as part of a run step. RunStepDetailsToolCallsFileSearchObject RunStepDetailsToolCallsFileSearchRankingOptionsObject The ranking options for the file search. RunStepDetailsToolCallsFileSearchResultObject A result instance of the file search. RunStepDetailsToolCallsFunctionObject RunStepDetailsToolCallsObject Details of the tool call. RunStepObject Represents a step in execution of a run. RunToolCallObject Tool call objects Screenshot A screenshot action. Scroll A scroll action. SpeechAudioDeltaEvent Emitted for each chunk of audio data generated during speech synthesis. SpeechAudioDoneEvent Emitted when the speech synthesis is complete and all audio has been streamed. StaticChunkingStrategy StaticChunkingStrategyRequestParam Customize your own chunking strategy by setting chunk size and chunk overlap. StaticChunkingStrategyResponseParam SubmitToolOutputsRunRequest SubmitToolOutputsRunRequestWithoutStream SummaryTextContent TextContent TextResponseFormatJsonSchema JSON Schema response format. Used to generate structured JSON responses.
Learn more about Structured Outputs . ThreadObject Represents a thread that contains messages . ToggleCertificatesRequest ToolChoiceAllowed Constrains the tools available to the model to a pre-defined set. ToolChoiceCustom Use this option to force the model to call a specific custom tool. ToolChoiceFunction Use this option to force the model to call a specific function. ToolChoiceMcp Use this option to force the model to call a specific tool on a remote MCP server. ToolChoiceTypes Indicates that the model should use a built-in tool to generate a response.
Learn more about built-in tools . TopLogProb The top log probability of a token. TopLogProb2 TranscriptTextDeltaEvent Emitted when there is an additional text delta. This is also the first event emitted when the transcription starts. Only emitted when you create a transcription with the Stream parameter set to true. TranscriptTextDoneEvent Emitted when the transcription is complete. Contains the complete transcription text. Only emitted when you create a transcription with the Stream parameter set to true. TranscriptTextUsageDuration Usage statistics for models billed by audio input duration. TranscriptTextUsageTokens Usage statistics for models billed by token usage. TranscriptionSegment TranscriptionWord TruncationObject Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run. Type An action to type in text. UpdateConversationBody UpdateVectorStoreFileAttributesRequest UpdateVectorStoreRequest Upload The Upload object can accept byte chunks in the form of Parts. UploadCertificateRequest UploadPart The upload Part represents a chunk of bytes we can add to an Upload object. UrlCitationBody A citation for a web resource used to generate a model response. UrlCitationBody2 UsageAudioSpeechesResult The aggregated audio speeches usage details of the specific time bucket. UsageAudioTranscriptionsResult The aggregated audio transcriptions usage details of the specific time bucket. UsageCodeInterpreterSessionsResult The aggregated code interpreter sessions usage details of the specific time bucket. UsageCompletionsResult The aggregated completions usage details of the specific time bucket. UsageEmbeddingsResult The aggregated embeddings usage details of the specific time bucket. UsageImagesResult The aggregated images usage details of the specific time bucket. UsageModerationsResult The aggregated moderations usage details of the specific time bucket. UsageResponse UsageTimeBucket UsageVectorStoresResult The aggregated vector stores usage details of the specific time bucket. User Represents an individual user within an organization. UserDeleteResponse UserListResponse UserRoleUpdateRequest VadConfig ValidateGraderRequest ValidateGraderResponse VectorStoreExpirationAfter The expiration policy for a vector store. VectorStoreFileBatchObject A batch of files attached to a vector store. VectorStoreFileContentResponse Represents the parsed content of a vector store file. VectorStoreFileObject A list of files attached to a vector store. VectorStoreObject A vector store is a collection of processed files can be used by the file_search tool. VectorStoreSearchRequest VectorStoreSearchResultContentObject VectorStoreSearchResultItem VectorStoreSearchResultsPage Wait A wait action. WebSearchActionFind Action type “find”: Searches for a pattern within a loaded page. WebSearchActionOpenPage Action type “open_page” - Opens a specific URL from search results. WebSearchActionSearch Action type “search” - Performs a web search query. WebSearchLocation Approximate location parameters for the search. WebSearchPreviewTool This tool searches the web for relevant results to use in a response. Learn more about the web search tool . WebSearchToolCall The results of a web search tool call. See the
web search guide for more information. WebhookBatchCancelled Sent when a batch API request has been cancelled. WebhookBatchCompleted Sent when a batch API request has been completed. WebhookBatchExpired Sent when a batch API request has expired. WebhookBatchFailed Sent when a batch API request has failed. WebhookEvalRunCanceled Sent when an eval run has been canceled. WebhookEvalRunFailed Sent when an eval run has failed. WebhookEvalRunSucceeded Sent when an eval run has succeeded. WebhookFineTuningJobCancelled Sent when a fine-tuning job has been cancelled. WebhookFineTuningJobFailed Sent when a fine-tuning job has failed. WebhookFineTuningJobSucceeded Sent when a fine-tuning job has succeeded. WebhookResponseCancelled Sent when a background response has been cancelled. WebhookResponseCompleted Sent when a background response has been completed. WebhookResponseFailed Sent when a background response has failed. WebhookResponseIncomplete Sent when a background response has been interrupted. Annotation Annotation2 AssistantStreamEvent Represents an event emitted when streaming a Run. AssistantSupportedModels AssistantTool AssistantsApiResponseFormatOption Specifies the format that the model must output. Compatible with GPT-4o , GPT-4 Turbo , and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106. AssistantsApiToolChoiceOption Controls which (if any) tool is called by the model.
none means the model will not call any tools and instead generates a message.
auto is the default value and means the model can pick between generating a message or calling one or more tools.
required means the model must call one or more tools before responding to the user.
Specifying a particular tool like {"type": "file_search"} or {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool. AudioResponseFormat The format of the output, in one of these options: json, text, srt, verbose_json, or vtt. For gpt-4o-transcribe and gpt-4o-mini-transcribe, the only supported format is json. AuditLogEventType The event type. ChatCompletionRequestAssistantMessageContentPart ChatCompletionRequestMessage ChatCompletionRequestSystemMessageContentPart ChatCompletionRequestToolMessageContentPart ChatCompletionRequestUserMessageContentPart ChatCompletionRole The role of the author of a message ChatCompletionToolChoiceOption Controls which (if any) tool is called by the model.
none means the model will not call any tool and instead generates a message.
auto means the model can pick between generating a message or calling one or more tools.
required means the model must call one or more tools.
Specifying a particular tool via {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool. ChatModel ChunkingStrategyRequestParam The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Only applicable if file_ids is non-empty. ChunkingStrategyResponse The strategy used to chunk the file. ComputerAction Content Multi-modal input and output contents. ConversationItem A single item within a conversation. The set of possible types are the same as the output type of a Response object . CreateEvalItem A chat message that makes up the prompt or context. May include variable references to the item namespace, ie {{item.name}}. CreateSpeechResponseStreamEvent CreateTranscriptionResponseStreamEvent FilePurpose The intended purpose of the uploaded file. One of: - assistants: Used in the Assistants API - batch: Used in the Batch API - fine-tune: Used for fine-tuning - vision: Images used for vision fine-tuning - user_data: Flexible file type for any purpose - evals: Used for eval data sets FileSearchRanker The ranker to use for the file search. If not specified will use the auto ranker. Filters ImageEditStreamEvent ImageGenStreamEvent ImageInputFidelity Control how much effort the model will exert to match the style and features,
especially facial features, of input images. This parameter is only supported
for gpt-image-1. Supports high and low. Defaults to low. Includable Specify additional output data to include in the model response. Currently
supported values are: InputContent InputItem Item Content item used to generate a response. ItemResource Content item used to generate a response. MessageContent MessageContentDelta MessageStreamEvent ModelIds ModelIdsResponses ModelIdsShared OutputContent OutputItem RealtimeClientEvent A realtime client event. RealtimeServerEvent A realtime server event. ReasoningEffort Constrains effort on reasoning for
reasoning models .
Currently supported values are minimal, low, medium, and high. Reducing
reasoning effort can result in faster responses and fewer tokens used
on reasoning in a response. ResponseErrorCode The error code for the response. ResponseStreamEvent RunStatus The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, incomplete, or expired. RunStepDeltaStepDetailsToolCall RunStepDetailsToolCall RunStepStreamEvent RunStreamEvent ServiceTier Specifies the processing type used for serving the request. StopConfiguration Not supported with latest reasoning models o3 and o4-mini. TextAnnotation TextAnnotationDelta TextResponseFormatConfiguration An object specifying the format that the model must output. ThreadStreamEvent Tool A tool that can be used to generate a response. ToolChoiceOptions Controls which (if any) tool is called by the model. TranscriptionChunkingStrategy Controls how the audio is cut into chunks. When set to "auto", the server first normalizes loudness and then uses voice activity detection (VAD) to choose boundaries. server_vad object can be provided to tweak VAD detection parameters manually. If unset, the audio is transcribed as a single block. TranscriptionInclude Verbosity Constrains the verbosity of the model’s response. Lower values will result in
more concise responses, while higher values will result in more verbose responses.
Currently supported values are low, medium, and high. VoiceIdsShared WebSearchContextSize High level guidance for the amount of context window space to use for the
search. One of low, medium, or high. medium is the default. ChatCompletionMessageToolCalls The tool calls generated by the model, such as function calls. ChatCompletionModalities Output types that you would like the model to generate for this request.
Most models are capable of generating text, which is the default: FunctionParameters The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format. InputMessageContentList A list of one or many input items to the model, containing different content
types. Metadata Set of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard. MetadataParam ParallelToolCalls Whether to enable parallel function calling during tool use. PartialImages The number of partial images to generate. This parameter is used for
streaming responses that return partial images. Value must be between 0 and 3.
When set to 0, the response will be a single image sent in one streaming event. ResponseFormatJsonSchemaSchema The schema for the response format, described as a JSON Schema object.
Learn how to build JSON schemas here . ResponseModalities Output types that you would like the model to generate.
Most models are capable of generating text, which is the default: ResponsePromptVariables Optional map of values to substitute in for variables in your
prompt. The substitution values can either be strings, or other
Response input types like images or files. VectorStoreFileAttributes Set of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard. Keys are strings
with a maximum length of 64 characters. Values are strings with a maximum
length of 512 characters, booleans, or numbers.