sdkagent

openai-python API reference

400 public APIs from openai-python (openai/openai-python) — 346 classes, 16 functions, 38 methods. Signatures extracted by static analysis of the actual source.

Repository: openai/openai-python

KindCount
Classes346
Functions16
Methods38

API list

classsrc.openai._base_client.BasePage
Defines the core interface for pagination.
methodsrc.openai._client.OpenAI.conversations() -> Conversations
Manage conversations and conversation items.
methodsrc.openai._client.OpenAI.evals() -> Evals
Manage and run evals in the OpenAI platform.
methodsrc.openai._client.OpenAI.models() -> Models
List and describe the various models available in the API.
methodsrc.openai._client.OpenAI.uploads() -> Uploads
Use Uploads to upload large files in multiple parts.
classsrc.openai._event_handler.EventHandlerRegistry
Thread-safe (optional) registry of event handlers.
funcsrc.openai._files.deepcopy_with_paths(item:_T, paths:Sequence[Sequence[str]]) -> _T
Copy only the containers along the given paths.
funcsrc.openai._models.build(base_model_cls:Callable[P, _BaseModelT], *args:P.args, **kwargs:P.kwargs) -> _BaseModelT
Construct a BaseModel class without validation.
funcsrc.openai._models.set_pydantic_config(typ:Any, config:pydantic.ConfigDict) -> None
Add a pydantic config for the given type.
funcsrc.openai._models.validate_type(*type_:type[_T], *value:object) -> _T
Strict validation that the given value matches the expected type
classsrc.openai._send_queue.SendQueue
Bounded byte-size queue for outgoing WebSocket messages.
methodsrc.openai._send_queue.SendQueue.drain() -> list[str]
Remove and return all queued messages.
methodsrc.openai._send_queue.SendQueue.enqueue(data:str) -> None
Append *data* to the queue.
methodsrc.openai._send_queue.SendQueue.flush_async(send:typing.Callable[[str], typing.Awaitable[object]]) -> None
Async variant of :meth:`flush_sync`.
methodsrc.openai._send_queue.SendQueue.flush_sync(send:typing.Callable[[str], object]) -> None
Send every queued message via *send*.
methodsrc.openai._streaming.Stream.close() -> None
Close the response and release the connection.
funcsrc.openai._utils._datetime_parse.parse_date(value:Union[date, StrBytesIntFloat]) -> date
Parse a date/int/float/string and return a datetime.date.
funcsrc.openai._utils._json.openapi_dumps(obj:Any) -> bytes
Serialize an object to UTF-8 encoded JSON bytes.
funcsrc.openai._utils._path.path_template(template:str, **kwargs:Any) -> str
Interpolate {name} placeholders in `template` from keyword arguments.
classsrc.openai._utils._resources_proxy.ResourcesProxy
A proxy for the `openai.resources` module.
funcsrc.openai._utils._transform.async_maybe_transform(data:object, expected_type:object) -> Any | None
Wrapper over `async_transform()` that allows `None` to be passed.
funcsrc.openai._utils._transform.maybe_transform(data:object, expected_type:object) -> Any | None
Wrapper over `transform()` that allows `None` to be passed.
funcsrc.openai._utils._typing.is_iterable_type(typ:type) -> bool
If the given type is `typing.Iterable[T]`
funcsrc.openai._utils._utils.quote(string:str) -> str
Add single quotation marks around the given string.
funcsrc.openai._utils._utils.removeprefix(string:str, prefix:str) -> str
Remove a prefix from a string.
funcsrc.openai._utils._utils.removesuffix(string:str, suffix:str) -> str
Remove a suffix from a string.
classsrc.openai.auth._workload.WorkloadIdentity
Identity provider resource id in WIFAPI.
funcsrc.openai.lib._pydantic.is_dataclass_like_type(typ:type) -> bool
Returns True if the given type likely used `@pydantic.dataclass`
funcsrc.openai.lib._validators.estimate_fine_tuning_time(df:pd.DataFrame) -> None
Estimate the time it'll take to fine-tune the dataset
funcsrc.openai.lib._validators.infer_task_type(df:pd.DataFrame) -> str
Infer the likely fine-tuning task type from the data
methodsrc.openai.resources.audio.audio.Audio.speech() -> Speech
Turn audio into text or text into audio.
methodsrc.openai.resources.audio.audio.Audio.transcriptions() -> Transcriptions
Turn audio into text or text into audio.
methodsrc.openai.resources.audio.audio.Audio.translations() -> Translations
Turn audio into text or text into audio.
classsrc.openai.resources.audio.speech.AsyncSpeech
Turn audio into text or text into audio.
classsrc.openai.resources.audio.speech.Speech
Turn audio into text or text into audio.
classsrc.openai.resources.audio.transcriptions.AsyncTranscriptions
Turn audio into text or text into audio.
classsrc.openai.resources.audio.transcriptions.Transcriptions
Turn audio into text or text into audio.
classsrc.openai.resources.audio.translations.AsyncTranslations
Turn audio into text or text into audio.
classsrc.openai.resources.audio.translations.Translations
Turn audio into text or text into audio.
methodsrc.openai.resources.batches.AsyncBatches.retrieve(batch_id:str, *extra_headers:Headers | None=None, *extra_query:Query | None=None, *extra_body:Body | None=None, *timeout:float | httpx.Timeout | None | NotGiven=not_given) -> Batch
Retrieves a batch.
classsrc.openai.resources.batches.Batches
Create large batches of API requests to run asynchronously.
methodsrc.openai.resources.batches.Batches.retrieve(batch_id:str, *extra_headers:Headers | None=None, *extra_query:Query | None=None, *extra_body:Body | None=None, *timeout:float | httpx.Timeout | None | NotGiven=not_given) -> Batch
Retrieves a batch.
classsrc.openai.resources.beta.assistants.Assistants
Build Assistants that can call models and use tools.
methodsrc.openai.resources.beta.assistants.Assistants.delete(assistant_id:str, *extra_headers:Headers | None=None, *extra_query:Query | None=None, *extra_body:Body | None=None, *timeout:float | httpx.Timeout | None | NotGiven=not_given) -> AssistantDeleted
Delete an assistant.
classsrc.openai.resources.beta.assistants.AsyncAssistants
Build Assistants that can call models and use tools.
methodsrc.openai.resources.beta.beta.Beta.assistants() -> Assistants
Build Assistants that can call models and use tools.
methodsrc.openai.resources.beta.beta.Beta.threads() -> Threads
Build Assistants that can call models and use tools.
classsrc.openai.resources.beta.threads.messages.AsyncMessages
Build Assistants that can call models and use tools.
classsrc.openai.resources.beta.threads.messages.Messages
Build Assistants that can call models and use tools.
classsrc.openai.resources.beta.threads.runs.runs.AsyncRuns
Build Assistants that can call models and use tools.
methodsrc.openai.resources.beta.threads.runs.runs.AsyncRuns.retrieve(run_id:str, *thread_id:str, *extra_headers:Headers | None=None, *extra_query:Query | None=None, *extra_body:Body | None=None, *timeout:float | httpx.Timeout | None | NotGiven=not_given) -> Run
Retrieves a run.
classsrc.openai.resources.beta.threads.runs.runs.Runs
Build Assistants that can call models and use tools.
methodsrc.openai.resources.beta.threads.runs.runs.Runs.retrieve(run_id:str, *thread_id:str, *extra_headers:Headers | None=None, *extra_query:Query | None=None, *extra_body:Body | None=None, *timeout:float | httpx.Timeout | None | NotGiven=not_given) -> Run
Retrieves a run.
classsrc.openai.resources.beta.threads.runs.steps.AsyncSteps
Build Assistants that can call models and use tools.
classsrc.openai.resources.beta.threads.runs.steps.Steps
Build Assistants that can call models and use tools.
classsrc.openai.resources.beta.threads.threads.AsyncThreads
Build Assistants that can call models and use tools.
methodsrc.openai.resources.beta.threads.threads.AsyncThreads.delete(thread_id:str, *extra_headers:Headers | None=None, *extra_query:Query | None=None, *extra_body:Body | None=None, *timeout:float | httpx.Timeout | None | NotGiven=not_given) -> ThreadDeleted
Delete a thread.
methodsrc.openai.resources.beta.threads.threads.AsyncThreads.retrieve(thread_id:str, *extra_headers:Headers | None=None, *extra_query:Query | None=None, *extra_body:Body | None=None, *timeout:float | httpx.Timeout | None | NotGiven=not_given) -> Thread
Retrieves a thread.
classsrc.openai.resources.beta.threads.threads.Threads
Build Assistants that can call models and use tools.
methodsrc.openai.resources.beta.threads.threads.Threads.delete(thread_id:str, *extra_headers:Headers | None=None, *extra_query:Query | None=None, *extra_body:Body | None=None, *timeout:float | httpx.Timeout | None | NotGiven=not_given) -> ThreadDeleted
Delete a thread.
methodsrc.openai.resources.beta.threads.threads.Threads.retrieve(thread_id:str, *extra_headers:Headers | None=None, *extra_query:Query | None=None, *extra_body:Body | None=None, *timeout:float | httpx.Timeout | None | NotGiven=not_given) -> Thread
Retrieves a thread.
classsrc.openai.resources.conversations.conversations.AsyncConversations
Manage conversations and conversation items.
classsrc.openai.resources.conversations.conversations.Conversations
Manage conversations and conversation items.
methodsrc.openai.resources.conversations.conversations.Conversations.items() -> Items
Manage conversations and conversation items.
classsrc.openai.resources.conversations.items.AsyncItems
Manage conversations and conversation items.
classsrc.openai.resources.conversations.items.Items
Manage conversations and conversation items.
classsrc.openai.resources.evals.evals.AsyncEvals
Manage and run evals in the OpenAI platform.
methodsrc.openai.resources.evals.evals.AsyncEvals.delete(eval_id:str, *extra_headers:Headers | None=None, *extra_query:Query | None=None, *extra_body:Body | None=None, *timeout:float | httpx.Timeout | None | NotGiven=not_given) -> EvalDeleteResponse
Delete an evaluation.
methodsrc.openai.resources.evals.evals.AsyncEvals.runs() -> AsyncRuns
Manage and run evals in the OpenAI platform.
classsrc.openai.resources.evals.evals.Evals
Manage and run evals in the OpenAI platform.
methodsrc.openai.resources.evals.evals.Evals.delete(eval_id:str, *extra_headers:Headers | None=None, *extra_query:Query | None=None, *extra_body:Body | None=None, *timeout:float | httpx.Timeout | None | NotGiven=not_given) -> EvalDeleteResponse
Delete an evaluation.
methodsrc.openai.resources.evals.evals.Evals.runs() -> Runs
Manage and run evals in the OpenAI platform.
classsrc.openai.resources.evals.runs.output_items.AsyncOutputItems
Manage and run evals in the OpenAI platform.
classsrc.openai.resources.evals.runs.output_items.OutputItems
Manage and run evals in the OpenAI platform.
classsrc.openai.resources.evals.runs.runs.AsyncRuns
Manage and run evals in the OpenAI platform.
methodsrc.openai.resources.evals.runs.runs.AsyncRuns.output_items() -> AsyncOutputItems
Manage and run evals in the OpenAI platform.
classsrc.openai.resources.evals.runs.runs.Runs
Manage and run evals in the OpenAI platform.
methodsrc.openai.resources.evals.runs.runs.Runs.delete(run_id:str, *eval_id:str, *extra_headers:Headers | None=None, *extra_query:Query | None=None, *extra_body:Body | None=None, *timeout:float | httpx.Timeout | None | NotGiven=not_given) -> RunDeleteResponse
Delete an eval run.
methodsrc.openai.resources.evals.runs.runs.Runs.output_items() -> OutputItems
Manage and run evals in the OpenAI platform.
classsrc.openai.resources.models.Models
List and describe the various models available in the API.
methodsrc.openai.resources.models.Models.delete(model:str, *extra_headers:Headers | None=None, *extra_query:Query | None=None, *extra_body:Body | None=None, *timeout:float | httpx.Timeout | None | NotGiven=not_given) -> ModelDeleted
Delete a fine-tuned model.
methodsrc.openai.resources.realtime.realtime.RealtimeConnection.off(event_type:str, handler:Callable[..., Any]) -> RealtimeConnection
Remove a previously registered event handler.
methodsrc.openai.resources.skills.skills.AsyncSkills.retrieve(skill_id:str, *extra_headers:Headers | None=None, *extra_query:Query | None=None, *extra_body:Body | None=None, *timeout:float | httpx.Timeout | None | NotGiven=not_given) -> Skill
Get a skill by its ID.
methodsrc.openai.resources.skills.skills.Skills.retrieve(skill_id:str, *extra_headers:Headers | None=None, *extra_query:Query | None=None, *extra_body:Body | None=None, *timeout:float | httpx.Timeout | None | NotGiven=not_given) -> Skill
Get a skill by its ID.
classsrc.openai.resources.uploads.parts.AsyncParts
Use Uploads to upload large files in multiple parts.
classsrc.openai.resources.uploads.parts.Parts
Use Uploads to upload large files in multiple parts.
classsrc.openai.resources.uploads.uploads.AsyncUploads
Use Uploads to upload large files in multiple parts.
methodsrc.openai.resources.uploads.uploads.AsyncUploads.cancel(upload_id:str, *extra_headers:Headers | None=None, *extra_query:Query | None=None, *extra_body:Body | None=None, *timeout:float | httpx.Timeout | None | NotGiven=not_given) -> Upload
Cancels the Upload.
classsrc.openai.resources.uploads.uploads.Uploads
Use Uploads to upload large files in multiple parts.
methodsrc.openai.resources.uploads.uploads.Uploads.cancel(upload_id:str, *extra_headers:Headers | None=None, *extra_query:Query | None=None, *extra_body:Body | None=None, *timeout:float | httpx.Timeout | None | NotGiven=not_given) -> Upload
Cancels the Upload.
methodsrc.openai.resources.uploads.uploads.Uploads.parts() -> Parts
Use Uploads to upload large files in multiple parts.
classsrc.openai.types.admin.organization.admin_api_key.AdminAPIKey
Represents an individual Admin API key in an org.
classsrc.openai.types.admin.organization.audit_log_list_response.APIKeyCreated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.APIKeyCreatedData
The payload used to create the API key.
classsrc.openai.types.admin.organization.audit_log_list_response.APIKeyDeleted
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.APIKeyUpdated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.APIKeyUpdatedChangesRequested
The payload used to update the API key.
classsrc.openai.types.admin.organization.audit_log_list_response.Actor
The actor who performed the audit logged action.
classsrc.openai.types.admin.organization.audit_log_list_response.CertificateCreated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.CertificateDeleted
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.CertificateUpdated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.CertificatesActivated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.CertificatesDeactivated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.CheckpointPermissionDeleted
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.ExternalKeyRegistered
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.ExternalKeyRemoved
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.GroupCreated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.GroupCreatedData
Information about the created group.
classsrc.openai.types.admin.organization.audit_log_list_response.GroupDeleted
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.GroupUpdated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.GroupUpdatedChangesRequested
The payload used to update the group.
classsrc.openai.types.admin.organization.audit_log_list_response.IPAllowlistConfigActivated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.IPAllowlistConfigDeactivated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.IPAllowlistCreated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.IPAllowlistDeleted
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.IPAllowlistUpdated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.InviteAccepted
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.InviteDeleted
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.InviteSent
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.InviteSentData
The payload used to create the invite.
classsrc.openai.types.admin.organization.audit_log_list_response.LoginFailed
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.LogoutFailed
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.OrganizationUpdated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.Project
The project that the action was scoped to.
classsrc.openai.types.admin.organization.audit_log_list_response.ProjectArchived
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.ProjectCreated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.ProjectCreatedData
The payload used to create the project.
classsrc.openai.types.admin.organization.audit_log_list_response.ProjectDeleted
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.ProjectUpdated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.ProjectUpdatedChangesRequested
The payload used to update the project.
classsrc.openai.types.admin.organization.audit_log_list_response.RateLimitDeleted
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.RateLimitUpdated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.RoleAssignmentCreated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.RoleAssignmentDeleted
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.RoleBoundToResource
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.RoleCreated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.RoleDeleted
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.RoleUnboundFromResource
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.RoleUpdated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.RoleUpdatedChangesRequested
The payload used to update the role.
classsrc.openai.types.admin.organization.audit_log_list_response.ScimDisabled
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.ScimEnabled
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.ServiceAccountCreated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.ServiceAccountDeleted
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.ServiceAccountUpdated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.UserAdded
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.UserDeleted
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.UserUpdated
The details for events with this `type`.
classsrc.openai.types.admin.organization.audit_log_list_response.UserUpdatedChangesRequested
The payload used to update the user.
classsrc.openai.types.admin.organization.group.Group
Details about an organization group.
classsrc.openai.types.admin.organization.group_update_response.GroupUpdateResponse
Response returned after updating a group.
classsrc.openai.types.admin.organization.groups.role_create_response.RoleCreateResponse
Role assignment linking a group to a role.
classsrc.openai.types.admin.organization.invite.Invite
Represents an individual `invite` to the organization.
classsrc.openai.types.admin.organization.organization_user.Projects
Projects associated with the user, if included.
classsrc.openai.types.admin.organization.organization_user.User
Nested user details.
classsrc.openai.types.admin.organization.project.Project
Represents an individual project.
classsrc.openai.types.admin.organization.projects.hosted_tool_permission_update_params.FileSearch
The file search permission update.
classsrc.openai.types.admin.organization.projects.hosted_tool_permission_update_params.Mcp
The MCP permission update.
classsrc.openai.types.admin.organization.projects.hosted_tool_permission_update_params.WebSearch
The web search permission update.
classsrc.openai.types.admin.organization.projects.project_api_key.OwnerUser
The user that owns a project API key.
classsrc.openai.types.admin.organization.projects.project_rate_limit.ProjectRateLimit
Represents a project rate limit config.
classsrc.openai.types.admin.organization.projects.project_user.ProjectUser
Represents an individual user in a project.
classsrc.openai.types.admin.organization.users.role_create_response.RoleCreateResponse
Role assignment linking a user to a role.
classsrc.openai.types.audio.speech_create_params.VoiceID
Custom voice reference.
classsrc.openai.types.audio.transcription.UsageTokens
Usage statistics for models billed by token usage.
classsrc.openai.types.audio.transcription_diarized.UsageTokens
Usage statistics for models billed by token usage.
classsrc.openai.types.audio.transcription_language.TranscriptionLanguage
A language detected in transcribed audio.
classsrc.openai.types.audio.transcription_text_done_event.TranscriptionTextDoneEvent
Emitted when the transcription is complete.
classsrc.openai.types.audio.transcription_text_done_event.Usage
Usage statistics for models billed by token usage.
classsrc.openai.types.auto_file_chunking_strategy_param.AutoFileChunkingStrategyParam
The default strategy.
classsrc.openai.types.batch_usage.InputTokensDetails
A detailed breakdown of the input tokens.
classsrc.openai.types.batch_usage.OutputTokensDetails
A detailed breakdown of the output tokens.
classsrc.openai.types.beta.assistant_create_params.ToolResourcesFileSearchVectorStoreChunkingStrategyAuto
The default strategy.
classsrc.openai.types.beta.assistant_tool_choice.AssistantToolChoice
Specifies a tool the model should use.
classsrc.openai.types.beta.assistant_tool_choice_param.AssistantToolChoiceParam
Specifies a tool the model should use.
classsrc.openai.types.beta.beta_computer_action.Click
A click action.
classsrc.openai.types.beta.beta_computer_action.DoubleClick
A double click action.
classsrc.openai.types.beta.beta_computer_action.Drag
A drag action.
classsrc.openai.types.beta.beta_computer_action.DragPath
An x/y coordinate pair, e.g.
classsrc.openai.types.beta.beta_computer_action.Move
A mouse move action.
classsrc.openai.types.beta.beta_computer_action.Screenshot
A screenshot action.
classsrc.openai.types.beta.beta_computer_action.Scroll
A scroll action.
classsrc.openai.types.beta.beta_computer_action.Type
An action to type in text.
classsrc.openai.types.beta.beta_computer_action.Wait
A wait action.
classsrc.openai.types.beta.beta_computer_action_list_param.Click
A click action.
classsrc.openai.types.beta.beta_computer_action_list_param.DoubleClick
A double click action.
classsrc.openai.types.beta.beta_computer_action_list_param.Drag
A drag action.
classsrc.openai.types.beta.beta_computer_action_list_param.DragPath
An x/y coordinate pair, e.g.
classsrc.openai.types.beta.beta_computer_action_list_param.Move
A mouse move action.
classsrc.openai.types.beta.beta_computer_action_list_param.Screenshot
A screenshot action.
classsrc.openai.types.beta.beta_computer_action_list_param.Scroll
A scroll action.
classsrc.openai.types.beta.beta_computer_action_list_param.Type
An action to type in text.
classsrc.openai.types.beta.beta_computer_action_list_param.Wait
A wait action.
classsrc.openai.types.beta.beta_computer_action_param.Click
A click action.
classsrc.openai.types.beta.beta_computer_action_param.DoubleClick
A double click action.
classsrc.openai.types.beta.beta_computer_action_param.Drag
A drag action.
classsrc.openai.types.beta.beta_computer_action_param.DragPath
An x/y coordinate pair, e.g.
classsrc.openai.types.beta.beta_computer_action_param.Move
A mouse move action.
classsrc.openai.types.beta.beta_computer_action_param.Screenshot
A screenshot action.
classsrc.openai.types.beta.beta_computer_action_param.Scroll
A scroll action.
classsrc.openai.types.beta.beta_computer_action_param.Type
An action to type in text.
classsrc.openai.types.beta.beta_computer_action_param.Wait
A wait action.
classsrc.openai.types.beta.beta_computer_tool.BetaComputerTool
A tool that controls a virtual computer.
classsrc.openai.types.beta.beta_computer_tool_param.BetaComputerToolParam
A tool that controls a virtual computer.
classsrc.openai.types.beta.beta_computer_use_preview_tool.BetaComputerUsePreviewTool
A tool that controls a virtual computer.
classsrc.openai.types.beta.beta_custom_tool.FormatGrammar
A grammar defined by the user.
classsrc.openai.types.beta.beta_custom_tool.FormatText
Unconstrained free-form text.
classsrc.openai.types.beta.beta_custom_tool_param.FormatGrammar
A grammar defined by the user.
classsrc.openai.types.beta.beta_custom_tool_param.FormatText
Unconstrained free-form text.
classsrc.openai.types.beta.beta_file_search_tool.FiltersCompoundFilter
Combine multiple filters using `and` or `or`.
classsrc.openai.types.beta.beta_file_search_tool.RankingOptions
Ranking options for search.
classsrc.openai.types.beta.beta_file_search_tool_param.FiltersCompoundFilter
Combine multiple filters using `and` or `or`.
classsrc.openai.types.beta.beta_file_search_tool_param.RankingOptions
Ranking options for search.
classsrc.openai.types.beta.beta_inline_skill_source.BetaInlineSkillSource
Inline skill payload
classsrc.openai.types.beta.beta_inline_skill_source_param.BetaInlineSkillSourceParam
Inline skill payload
classsrc.openai.types.beta.beta_response.Conversation
The conversation that this response belonged to.
classsrc.openai.types.beta.beta_response.IncompleteDetails
Details about why the response is incomplete.
classsrc.openai.types.beta.beta_response_apply_patch_tool_call.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_apply_patch_tool_call_output.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_code_interpreter_tool_call.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_code_interpreter_tool_call.BetaResponseCodeInterpreterToolCall
A tool call to run code.
classsrc.openai.types.beta.beta_response_code_interpreter_tool_call.OutputImage
The image output from the code interpreter.
classsrc.openai.types.beta.beta_response_code_interpreter_tool_call.OutputLogs
The logs output from the code interpreter.
classsrc.openai.types.beta.beta_response_code_interpreter_tool_call_param.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_code_interpreter_tool_call_param.BetaResponseCodeInterpreterToolCallParam
A tool call to run code.
classsrc.openai.types.beta.beta_response_code_interpreter_tool_call_param.OutputImage
The image output from the code interpreter.
classsrc.openai.types.beta.beta_response_code_interpreter_tool_call_param.OutputLogs
The logs output from the code interpreter.
classsrc.openai.types.beta.beta_response_compaction_item.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_compaction_item_param.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_compaction_item_param_param.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_completed_event.BetaResponseCompletedEvent
Emitted when the model response is complete.
classsrc.openai.types.beta.beta_response_computer_tool_call.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_computer_tool_call.BetaResponseComputerToolCall
A tool call to a computer use tool.
classsrc.openai.types.beta.beta_response_computer_tool_call.PendingSafetyCheck
A pending safety check for the computer call.
classsrc.openai.types.beta.beta_response_computer_tool_call_output_item.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_computer_tool_call_param.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_computer_tool_call_param.BetaResponseComputerToolCallParam
A tool call to a computer use tool.
classsrc.openai.types.beta.beta_response_content_part_added_event.PartReasoningText
Reasoning text from the model.
classsrc.openai.types.beta.beta_response_content_part_done_event.BetaResponseContentPartDoneEvent
Emitted when a content part is done.
classsrc.openai.types.beta.beta_response_content_part_done_event.PartReasoningText
Reasoning text from the model.
classsrc.openai.types.beta.beta_response_custom_tool_call.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_custom_tool_call_output.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_custom_tool_call_output_param.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_custom_tool_call_param.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_error_event.BetaResponseErrorEvent
Emitted when an error occurs.
classsrc.openai.types.beta.beta_response_file_search_tool_call.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_file_search_tool_call.BetaResponseFileSearchToolCall
The results of a file search tool call.
classsrc.openai.types.beta.beta_response_file_search_tool_call_param.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_format_text_config.JSONObject
JSON object response format.
classsrc.openai.types.beta.beta_response_format_text_config.Text
Default response format.
classsrc.openai.types.beta.beta_response_format_text_config_param.JSONObject
JSON object response format.
classsrc.openai.types.beta.beta_response_format_text_config_param.Text
Default response format.
classsrc.openai.types.beta.beta_response_format_text_json_schema_config.BetaResponseFormatTextJSONSchemaConfig
JSON Schema response format.
classsrc.openai.types.beta.beta_response_format_text_json_schema_config_param.BetaResponseFormatTextJSONSchemaConfigParam
JSON Schema response format.
classsrc.openai.types.beta.beta_response_function_shell_tool_call.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_function_shell_tool_call_output.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_function_tool_call.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_function_tool_call.BetaResponseFunctionToolCall
A tool call to run a function.
classsrc.openai.types.beta.beta_response_function_tool_call_item.BetaResponseFunctionToolCallItem
A tool call to run a function.
classsrc.openai.types.beta.beta_response_function_tool_call_output_item.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_function_tool_call_param.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_function_tool_call_param.BetaResponseFunctionToolCallParam
A tool call to run a function.
classsrc.openai.types.beta.beta_response_function_web_search.ActionSearchSource
A source used in the search.
classsrc.openai.types.beta.beta_response_function_web_search.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_function_web_search.BetaResponseFunctionWebSearch
The results of a web search tool call.
classsrc.openai.types.beta.beta_response_function_web_search_param.ActionSearchSource
A source used in the search.
classsrc.openai.types.beta.beta_response_function_web_search_param.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_in_progress_event.BetaResponseInProgressEvent
Emitted when the response is in progress.
classsrc.openai.types.beta.beta_response_inject_failed_event.Error
Information about why the input was not committed.
classsrc.openai.types.beta.beta_response_input_file.BetaResponseInputFile
A file input to the model.
classsrc.openai.types.beta.beta_response_input_file_content.BetaResponseInputFileContent
A file input to the model.
classsrc.openai.types.beta.beta_response_input_file_content_param.BetaResponseInputFileContentParam
A file input to the model.
classsrc.openai.types.beta.beta_response_input_file_param.BetaResponseInputFileParam
A file input to the model.
classsrc.openai.types.beta.beta_response_input_image.BetaResponseInputImage
An image input to the model.
classsrc.openai.types.beta.beta_response_input_image_content.BetaResponseInputImageContent
An image input to the model.
classsrc.openai.types.beta.beta_response_input_image_content_param.BetaResponseInputImageContentParam
An image input to the model.
classsrc.openai.types.beta.beta_response_input_image_param.BetaResponseInputImageParam
An image input to the model.
classsrc.openai.types.beta.beta_response_input_item.AdditionalToolsAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.AgentMessage
A message routed between agents.
classsrc.openai.types.beta.beta_response_input_item.AgentMessageAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.ApplyPatchCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.ApplyPatchCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.CompactionTrigger
Compacts the current context.
classsrc.openai.types.beta.beta_response_input_item.CompactionTriggerAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.ComputerCallOutput
The output of a computer tool call.
classsrc.openai.types.beta.beta_response_input_item.ComputerCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.FunctionCallOutput
The output of a function tool call.
classsrc.openai.types.beta.beta_response_input_item.FunctionCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.ImageGenerationCall
An image generation request made by the model.
classsrc.openai.types.beta.beta_response_input_item.ImageGenerationCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.ItemReference
An internal identifier for an item to reference.
classsrc.openai.types.beta.beta_response_input_item.ItemReferenceAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.LocalShellCall
A tool call to run a command on the local shell.
classsrc.openai.types.beta.beta_response_input_item.LocalShellCallAction
Execute a shell command on the server.
classsrc.openai.types.beta.beta_response_input_item.LocalShellCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.LocalShellCallOutput
The output of a local shell tool call.
classsrc.openai.types.beta.beta_response_input_item.LocalShellCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.McpApprovalRequestAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.McpApprovalResponse
A response to an MCP approval request.
classsrc.openai.types.beta.beta_response_input_item.McpApprovalResponseAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.McpCall
An invocation of a tool on an MCP server.
classsrc.openai.types.beta.beta_response_input_item.McpCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.McpListTools
A list of tools available on an MCP server.
classsrc.openai.types.beta.beta_response_input_item.McpListToolsAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.McpListToolsTool
A tool available on an MCP server.
classsrc.openai.types.beta.beta_response_input_item.MessageAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.MultiAgentCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.MultiAgentCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.ProgramAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.ProgramOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.ShellCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.ShellCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item.ToolSearchCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.AdditionalToolsAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.AgentMessage
A message routed between agents.
classsrc.openai.types.beta.beta_response_input_item_param.AgentMessageAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.ApplyPatchCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.ApplyPatchCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.CompactionTrigger
Compacts the current context.
classsrc.openai.types.beta.beta_response_input_item_param.CompactionTriggerAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.ComputerCallOutput
The output of a computer tool call.
classsrc.openai.types.beta.beta_response_input_item_param.ComputerCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.FunctionCallOutput
The output of a function tool call.
classsrc.openai.types.beta.beta_response_input_item_param.FunctionCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.ImageGenerationCall
An image generation request made by the model.
classsrc.openai.types.beta.beta_response_input_item_param.ImageGenerationCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.ItemReference
An internal identifier for an item to reference.
classsrc.openai.types.beta.beta_response_input_item_param.ItemReferenceAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.LocalShellCall
A tool call to run a command on the local shell.
classsrc.openai.types.beta.beta_response_input_item_param.LocalShellCallAction
Execute a shell command on the server.
classsrc.openai.types.beta.beta_response_input_item_param.LocalShellCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.LocalShellCallOutput
The output of a local shell tool call.
classsrc.openai.types.beta.beta_response_input_item_param.LocalShellCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.McpApprovalRequestAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.McpApprovalResponse
A response to an MCP approval request.
classsrc.openai.types.beta.beta_response_input_item_param.McpApprovalResponseAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.McpCall
An invocation of a tool on an MCP server.
classsrc.openai.types.beta.beta_response_input_item_param.McpCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.McpListTools
A list of tools available on an MCP server.
classsrc.openai.types.beta.beta_response_input_item_param.McpListToolsAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.McpListToolsTool
A tool available on an MCP server.
classsrc.openai.types.beta.beta_response_input_item_param.MessageAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.MultiAgentCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.MultiAgentCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.ProgramAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.ProgramOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.ShellCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.ShellCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_item_param.ToolSearchCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_message_item.Agent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.AdditionalToolsAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.AgentMessage
A message routed between agents.
classsrc.openai.types.beta.beta_response_input_param.AgentMessageAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.ApplyPatchCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.ApplyPatchCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.CompactionTrigger
Compacts the current context.
classsrc.openai.types.beta.beta_response_input_param.CompactionTriggerAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.ComputerCallOutput
The output of a computer tool call.
classsrc.openai.types.beta.beta_response_input_param.ComputerCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.FunctionCallOutput
The output of a function tool call.
classsrc.openai.types.beta.beta_response_input_param.FunctionCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.ImageGenerationCall
An image generation request made by the model.
classsrc.openai.types.beta.beta_response_input_param.ImageGenerationCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.ItemReference
An internal identifier for an item to reference.
classsrc.openai.types.beta.beta_response_input_param.ItemReferenceAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.LocalShellCall
A tool call to run a command on the local shell.
classsrc.openai.types.beta.beta_response_input_param.LocalShellCallAction
Execute a shell command on the server.
classsrc.openai.types.beta.beta_response_input_param.LocalShellCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.LocalShellCallOutput
The output of a local shell tool call.
classsrc.openai.types.beta.beta_response_input_param.LocalShellCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.McpApprovalRequestAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.McpApprovalResponse
A response to an MCP approval request.
classsrc.openai.types.beta.beta_response_input_param.McpApprovalResponseAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.McpCall
An invocation of a tool on an MCP server.
classsrc.openai.types.beta.beta_response_input_param.McpCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.McpListTools
A list of tools available on an MCP server.
classsrc.openai.types.beta.beta_response_input_param.McpListToolsAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.McpListToolsTool
A tool available on an MCP server.
classsrc.openai.types.beta.beta_response_input_param.MessageAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.MultiAgentCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.MultiAgentCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.ProgramAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.ProgramOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.ShellCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.ShellCallOutputAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_param.ToolSearchCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_input_text.BetaResponseInputText
A text input to the model.
classsrc.openai.types.beta.beta_response_input_text_content.BetaResponseInputTextContent
A text input to the model.
classsrc.openai.types.beta.beta_response_input_text_content_param.BetaResponseInputTextContentParam
A text input to the model.
classsrc.openai.types.beta.beta_response_input_text_param.BetaResponseInputTextParam
A text input to the model.
classsrc.openai.types.beta.beta_response_item.AdditionalToolsAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_item.AgentMessageAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_item.AgentMessageContentComputerScreenshot
A screenshot of a computer.
classsrc.openai.types.beta.beta_response_item.AgentMessageContentReasoningText
Reasoning text from the model.
classsrc.openai.types.beta.beta_response_item.AgentMessageContentSummaryText
A summary text from the model.
classsrc.openai.types.beta.beta_response_item.AgentMessageContentText
A text content.
classsrc.openai.types.beta.beta_response_item.ImageGenerationCall
An image generation request made by the model.
classsrc.openai.types.beta.beta_response_item.ImageGenerationCallAgent
The agent that produced this item.
classsrc.openai.types.beta.beta_response_item.LocalShellCall
A tool call to run a command on the local shell.
classsrc.openai.types.beta.beta_response_item.LocalShellCallAction
Execute a shell command on the server.

About this data

These signatures were extracted from the public source of openai/openai-python using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries