api.md
from openai.types import (
AllModels,
ChatModel,
ComparisonFilter,
CompoundFilter,
CustomToolInputFormat,
ErrorObject,
FunctionDefinition,
FunctionParameters,
Metadata,
OAuthErrorCode,
Reasoning,
ReasoningEffort,
ResponseFormatJSONObject,
ResponseFormatJSONSchema,
ResponseFormatText,
ResponseFormatTextGrammar,
ResponseFormatTextPython,
ResponsesModel,
)
Types:
from openai.types import Completion, CompletionChoice, CompletionUsage
Methods:
Types:
from openai.types import ChatModel
Types:
from openai.types.chat import (
ChatCompletion,
ChatCompletionAllowedToolChoice,
ChatCompletionAssistantMessageParam,
ChatCompletionAudio,
ChatCompletionAudioParam,
ChatCompletionChunk,
ChatCompletionContentPart,
ChatCompletionContentPartImage,
ChatCompletionContentPartInputAudio,
ChatCompletionContentPartRefusal,
ChatCompletionContentPartText,
ChatCompletionCustomTool,
ChatCompletionDeleted,
ChatCompletionDeveloperMessageParam,
ChatCompletionFunctionCallOption,
ChatCompletionFunctionMessageParam,
ChatCompletionFunctionTool,
ChatCompletionMessage,
ChatCompletionMessageCustomToolCall,
ChatCompletionMessageFunctionToolCall,
ChatCompletionMessageParam,
ChatCompletionMessageToolCallUnion,
ChatCompletionModality,
ChatCompletionNamedToolChoice,
ChatCompletionNamedToolChoiceCustom,
ChatCompletionPredictionContent,
ChatCompletionRole,
ChatCompletionStoreMessage,
ChatCompletionStreamOptions,
ChatCompletionSystemMessageParam,
ChatCompletionTokenLogprob,
ChatCompletionToolUnion,
ChatCompletionToolChoiceOption,
ChatCompletionToolMessageParam,
ChatCompletionUserMessageParam,
ChatCompletionAllowedTools,
ChatCompletionReasoningEffort,
)
Methods:
Methods:
Types:
from openai.types import CreateEmbeddingResponse, Embedding, EmbeddingModel
Methods:
Types:
from openai.types import FileContent, FileDeleted, FileObject, FilePurpose
Methods:
Types:
from openai.types import (
Image,
ImageEditCompletedEvent,
ImageEditPartialImageEvent,
ImageEditStreamEvent,
ImageGenCompletedEvent,
ImageGenPartialImageEvent,
ImageGenStreamEvent,
ImageModel,
ImagesResponse,
)
Methods:
Types:
from openai.types import AudioModel, AudioResponseFormat
Types:
from openai.types.audio import (
Transcription,
TranscriptionDiarized,
TranscriptionDiarizedSegment,
TranscriptionInclude,
TranscriptionSegment,
TranscriptionStreamEvent,
TranscriptionTextDeltaEvent,
TranscriptionTextDoneEvent,
TranscriptionTextSegmentEvent,
TranscriptionVerbose,
TranscriptionWord,
TranscriptionCreateResponse,
)
Methods:
Types:
from openai.types.audio import Translation, TranslationVerbose, TranslationCreateResponse
Methods:
Types:
from openai.types.audio import SpeechModel
Methods:
Types:
from openai.types import (
Moderation,
ModerationImageURLInput,
ModerationModel,
ModerationMultiModalInput,
ModerationTextInput,
ModerationCreateResponse,
)
Methods:
Types:
from openai.types import Model, ModelDeleted
Methods:
Types:
from openai.types.fine_tuning import (
DpoHyperparameters,
DpoMethod,
ReinforcementHyperparameters,
ReinforcementMethod,
SupervisedHyperparameters,
SupervisedMethod,
)
Types:
from openai.types.fine_tuning import (
FineTuningJob,
FineTuningJobEvent,
FineTuningJobWandbIntegration,
FineTuningJobWandbIntegrationObject,
FineTuningJobIntegration,
)
Methods:
Types:
from openai.types.fine_tuning.jobs import FineTuningJobCheckpoint
Methods:
Types:
from openai.types.fine_tuning.checkpoints import (
PermissionCreateResponse,
PermissionRetrieveResponse,
PermissionListResponse,
PermissionDeleteResponse,
)
Methods:
Types:
from openai.types.fine_tuning.alpha import GraderRunResponse, GraderValidateResponse
Methods:
Types:
from openai.types.graders import (
GraderInputs,
LabelModelGrader,
MultiGrader,
PythonGrader,
ScoreModelGrader,
StringCheckGrader,
TextSimilarityGrader,
)
Types:
from openai.types import (
AutoFileChunkingStrategyParam,
FileChunkingStrategy,
FileChunkingStrategyParam,
OtherFileChunkingStrategyObject,
StaticFileChunkingStrategy,
StaticFileChunkingStrategyObject,
StaticFileChunkingStrategyObjectParam,
VectorStore,
VectorStoreDeleted,
VectorStoreSearchResponse,
)
Methods:
Types:
from openai.types.vector_stores import VectorStoreFile, VectorStoreFileDeleted, FileContentResponse
Methods:
Types:
from openai.types.vector_stores import VectorStoreFileBatch
Methods:
Methods:
Types:
from openai.types.beta import (
BetaApplyPatchTool,
BetaCompactedResponse,
BetaComputerAction,
BetaComputerActionList,
BetaComputerTool,
BetaComputerUsePreviewTool,
BetaContainerAuto,
BetaContainerNetworkPolicyAllowlist,
BetaContainerNetworkPolicyDisabled,
BetaContainerNetworkPolicyDomainSecret,
BetaContainerReference,
BetaCustomTool,
BetaEasyInputMessage,
BetaFileSearchTool,
BetaFunctionShellTool,
BetaFunctionTool,
BetaInlineSkill,
BetaInlineSkillSource,
BetaLocalEnvironment,
BetaLocalSkill,
BetaNamespaceTool,
BetaResponse,
BetaResponseApplyPatchToolCall,
BetaResponseApplyPatchToolCallOutput,
BetaResponseAudioDeltaEvent,
BetaResponseAudioDoneEvent,
BetaResponseAudioTranscriptDeltaEvent,
BetaResponseAudioTranscriptDoneEvent,
BetaResponseCodeInterpreterCallCodeDeltaEvent,
BetaResponseCodeInterpreterCallCodeDoneEvent,
BetaResponseCodeInterpreterCallCompletedEvent,
BetaResponseCodeInterpreterCallInProgressEvent,
BetaResponseCodeInterpreterCallInterpretingEvent,
BetaResponseCodeInterpreterToolCall,
BetaResponseCompactionItem,
BetaResponseCompactionItemParam,
BetaResponseCompletedEvent,
BetaResponseComputerToolCall,
BetaResponseComputerToolCallOutputItem,
BetaResponseComputerToolCallOutputScreenshot,
BetaResponseContainerReference,
BetaResponseContent,
BetaResponseContentPartAddedEvent,
BetaResponseContentPartDoneEvent,
BetaResponseConversationParam,
BetaResponseCreatedEvent,
BetaResponseCustomToolCall,
BetaResponseCustomToolCallInputDeltaEvent,
BetaResponseCustomToolCallInputDoneEvent,
BetaResponseCustomToolCallItem,
BetaResponseCustomToolCallOutput,
BetaResponseCustomToolCallOutputItem,
BetaResponseError,
BetaResponseErrorEvent,
BetaResponseFailedEvent,
BetaResponseFileSearchCallCompletedEvent,
BetaResponseFileSearchCallInProgressEvent,
BetaResponseFileSearchCallSearchingEvent,
BetaResponseFileSearchToolCall,
BetaResponseFormatTextConfig,
BetaResponseFormatTextJSONSchemaConfig,
BetaResponseFunctionCallArgumentsDeltaEvent,
BetaResponseFunctionCallArgumentsDoneEvent,
BetaResponseFunctionCallOutputItem,
BetaResponseFunctionCallOutputItemList,
BetaResponseFunctionShellCallOutputContent,
BetaResponseFunctionShellToolCall,
BetaResponseFunctionShellToolCallOutput,
BetaResponseFunctionToolCall,
BetaResponseFunctionToolCallItem,
BetaResponseFunctionToolCallOutputItem,
BetaResponseFunctionWebSearch,
BetaResponseImageGenCallCompletedEvent,
BetaResponseImageGenCallGeneratingEvent,
BetaResponseImageGenCallInProgressEvent,
BetaResponseImageGenCallPartialImageEvent,
BetaResponseInProgressEvent,
BetaResponseIncludable,
BetaResponseIncompleteEvent,
BetaResponseInjectCreatedEvent,
BetaResponseInjectEvent,
BetaResponseInjectFailedEvent,
BetaResponseInput,
BetaResponseInputAudio,
BetaResponseInputContent,
BetaResponseInputFile,
BetaResponseInputFileContent,
BetaResponseInputImage,
BetaResponseInputImageContent,
BetaResponseInputItem,
BetaResponseInputMessageContentList,
BetaResponseInputMessageItem,
BetaResponseInputText,
BetaResponseInputTextContent,
BetaResponseItem,
BetaResponseLocalEnvironment,
BetaResponseMcpCallArgumentsDeltaEvent,
BetaResponseMcpCallArgumentsDoneEvent,
BetaResponseMcpCallCompletedEvent,
BetaResponseMcpCallFailedEvent,
BetaResponseMcpCallInProgressEvent,
BetaResponseMcpListToolsCompletedEvent,
BetaResponseMcpListToolsFailedEvent,
BetaResponseMcpListToolsInProgressEvent,
BetaResponseOutputAudio,
BetaResponseOutputItem,
BetaResponseOutputItemAddedEvent,
BetaResponseOutputItemDoneEvent,
BetaResponseOutputMessage,
BetaResponseOutputRefusal,
BetaResponseOutputText,
BetaResponseOutputTextAnnotationAddedEvent,
BetaResponsePrompt,
BetaResponseQueuedEvent,
BetaResponseReasoningItem,
BetaResponseReasoningSummaryPartAddedEvent,
BetaResponseReasoningSummaryPartDoneEvent,
BetaResponseReasoningSummaryTextDeltaEvent,
BetaResponseReasoningSummaryTextDoneEvent,
BetaResponseReasoningTextDeltaEvent,
BetaResponseReasoningTextDoneEvent,
BetaResponseRefusalDeltaEvent,
BetaResponseRefusalDoneEvent,
BetaResponseStatus,
BetaResponseStreamEvent,
BetaResponseTextConfig,
BetaResponseTextDeltaEvent,
BetaResponseTextDoneEvent,
BetaResponseToolSearchCall,
BetaResponseToolSearchOutputItem,
BetaResponseToolSearchOutputItemParam,
BetaResponseUsage,
BetaResponseWebSearchCallCompletedEvent,
BetaResponseWebSearchCallInProgressEvent,
BetaResponseWebSearchCallSearchingEvent,
BetaResponsesClientEvent,
BetaResponsesServerEvent,
BetaSkillReference,
BetaTool,
BetaToolChoiceAllowed,
BetaToolChoiceApplyPatch,
BetaToolChoiceCustom,
BetaToolChoiceFunction,
BetaToolChoiceMcp,
BetaToolChoiceOptions,
BetaToolChoiceShell,
BetaToolChoiceTypes,
BetaToolSearchTool,
BetaWebSearchPreviewTool,
BetaWebSearchTool,
)
Methods:
Types:
from openai.types.beta.responses import BetaResponseItemList
Methods:
Types:
from openai.types.beta.responses import InputTokenCountResponse
Methods:
Types:
from openai.types.beta.realtime import (
ConversationCreatedEvent,
ConversationItem,
ConversationItemContent,
ConversationItemCreateEvent,
ConversationItemCreatedEvent,
ConversationItemDeleteEvent,
ConversationItemDeletedEvent,
ConversationItemInputAudioTranscriptionCompletedEvent,
ConversationItemInputAudioTranscriptionDeltaEvent,
ConversationItemInputAudioTranscriptionFailedEvent,
ConversationItemRetrieveEvent,
ConversationItemTruncateEvent,
ConversationItemTruncatedEvent,
ConversationItemWithReference,
ErrorEvent,
InputAudioBufferAppendEvent,
InputAudioBufferClearEvent,
InputAudioBufferClearedEvent,
InputAudioBufferCommitEvent,
InputAudioBufferCommittedEvent,
InputAudioBufferSpeechStartedEvent,
InputAudioBufferSpeechStoppedEvent,
RateLimitsUpdatedEvent,
RealtimeClientEvent,
RealtimeResponse,
RealtimeResponseStatus,
RealtimeResponseUsage,
RealtimeServerEvent,
ResponseAudioDeltaEvent,
ResponseAudioDoneEvent,
ResponseAudioTranscriptDeltaEvent,
ResponseAudioTranscriptDoneEvent,
ResponseCancelEvent,
ResponseContentPartAddedEvent,
ResponseContentPartDoneEvent,
ResponseCreateEvent,
ResponseCreatedEvent,
ResponseDoneEvent,
ResponseFunctionCallArgumentsDeltaEvent,
ResponseFunctionCallArgumentsDoneEvent,
ResponseOutputItemAddedEvent,
ResponseOutputItemDoneEvent,
ResponseTextDeltaEvent,
ResponseTextDoneEvent,
SessionCreatedEvent,
SessionUpdateEvent,
SessionUpdatedEvent,
TranscriptionSessionUpdate,
TranscriptionSessionUpdatedEvent,
)
Types:
from openai.types.beta.realtime import Session, SessionCreateResponse
Methods:
Types:
from openai.types.beta.realtime import TranscriptionSession
Methods:
Types:
from openai.types.beta import (
Assistant,
AssistantDeleted,
AssistantStreamEvent,
AssistantTool,
CodeInterpreterTool,
FileSearchTool,
FunctionTool,
MessageStreamEvent,
RunStepStreamEvent,
RunStreamEvent,
ThreadStreamEvent,
)
Methods:
Types:
from openai.types.beta import (
AssistantResponseFormatOption,
AssistantToolChoice,
AssistantToolChoiceFunction,
AssistantToolChoiceOption,
Thread,
ThreadDeleted,
)
Methods:
Types:
from openai.types.beta.threads import RequiredActionFunctionToolCall, Run, RunStatus
Methods:
Types:
from openai.types.beta.threads.runs import (
CodeInterpreterLogs,
CodeInterpreterOutputImage,
CodeInterpreterToolCall,
CodeInterpreterToolCallDelta,
FileSearchToolCall,
FileSearchToolCallDelta,
FunctionToolCall,
FunctionToolCallDelta,
MessageCreationStepDetails,
RunStep,
RunStepDelta,
RunStepDeltaEvent,
RunStepDeltaMessageDelta,
RunStepInclude,
ToolCall,
ToolCallDelta,
ToolCallDeltaObject,
ToolCallsStepDetails,
)
Methods:
Types:
from openai.types.beta.threads import (
Annotation,
AnnotationDelta,
FileCitationAnnotation,
FileCitationDeltaAnnotation,
FilePathAnnotation,
FilePathDeltaAnnotation,
ImageFile,
ImageFileContentBlock,
ImageFileDelta,
ImageFileDeltaBlock,
ImageURL,
ImageURLContentBlock,
ImageURLDelta,
ImageURLDeltaBlock,
Message,
MessageContent,
MessageContentDelta,
MessageContentPartParam,
MessageDeleted,
MessageDelta,
MessageDeltaEvent,
RefusalContentBlock,
RefusalDeltaBlock,
Text,
TextContentBlock,
TextContentBlockParam,
TextDelta,
TextDeltaBlock,
)
Methods:
Types:
from openai.types import Batch, BatchError, BatchRequestCounts, BatchUsage
Methods:
Types:
from openai.types import Upload
Methods:
Types:
from openai.types.uploads import UploadPart
Methods:
Types:
from openai.types.admin.organization import AuditLogListResponse
Methods:
Types:
from openai.types.admin.organization import (
AdminAPIKey,
AdminAPIKeyCreateResponse,
AdminAPIKeyDeleteResponse,
)
Methods:
Types:
from openai.types.admin.organization import (
UsageAudioSpeechesResponse,
UsageAudioTranscriptionsResponse,
UsageCodeInterpreterSessionsResponse,
UsageCompletionsResponse,
UsageCostsResponse,
UsageEmbeddingsResponse,
UsageFileSearchCallsResponse,
UsageImagesResponse,
UsageModerationsResponse,
UsageVectorStoresResponse,
UsageWebSearchCallsResponse,
)
Methods:
Types:
from openai.types.admin.organization import Invite, InviteDeleteResponse
Methods:
Types:
from openai.types.admin.organization import OrganizationUser, UserDeleteResponse
Methods:
Types:
from openai.types.admin.organization.users import (
RoleCreateResponse,
RoleRetrieveResponse,
RoleListResponse,
RoleDeleteResponse,
)
Methods:
Types:
from openai.types.admin.organization import Group, GroupUpdateResponse, GroupDeleteResponse
Methods:
Types:
from openai.types.admin.organization.groups import (
OrganizationGroupUser,
UserCreateResponse,
UserRetrieveResponse,
UserDeleteResponse,
)
Methods:
Types:
from openai.types.admin.organization.groups import (
RoleCreateResponse,
RoleRetrieveResponse,
RoleListResponse,
RoleDeleteResponse,
)
Methods:
Types:
from openai.types.admin.organization import Role, RoleDeleteResponse
Methods:
Types:
from openai.types.admin.organization import OrganizationDataRetention
Methods:
Types:
from openai.types.admin.organization import OrganizationSpendAlert, OrganizationSpendAlertDeleted
Methods:
Types:
from openai.types.admin.organization import (
Certificate,
CertificateListResponse,
CertificateDeleteResponse,
CertificateActivateResponse,
CertificateDeactivateResponse,
)
Methods:
Types:
from openai.types.admin.organization import Project
Methods:
Types:
from openai.types.admin.organization.projects import ProjectUser, UserDeleteResponse
Methods:
Types:
from openai.types.admin.organization.projects.users import (
RoleCreateResponse,
RoleRetrieveResponse,
RoleListResponse,
RoleDeleteResponse,
)
Methods:
Types:
from openai.types.admin.organization.projects import (
ProjectServiceAccount,
ServiceAccountCreateResponse,
ServiceAccountDeleteResponse,
)
Methods:
Types:
from openai.types.admin.organization.projects import ProjectAPIKey, APIKeyDeleteResponse
Methods:
Types:
from openai.types.admin.organization.projects import ProjectRateLimit
Methods:
Types:
from openai.types.admin.organization.projects import (
ProjectModelPermissions,
ProjectModelPermissionsDeleted,
)
Methods:
Types:
from openai.types.admin.organization.projects import ProjectHostedToolPermissions
Methods:
Types:
from openai.types.admin.organization.projects import ProjectGroup, GroupDeleteResponse
Methods:
Types:
from openai.types.admin.organization.projects.groups import (
RoleCreateResponse,
RoleRetrieveResponse,
RoleListResponse,
RoleDeleteResponse,
)
Methods:
Types:
from openai.types.admin.organization.projects import RoleDeleteResponse
Methods:
Types:
from openai.types.admin.organization.projects import ProjectDataRetention
Methods:
Types:
from openai.types.admin.organization.projects import ProjectSpendAlert, ProjectSpendAlertDeleted
Methods:
Types:
from openai.types.admin.organization.projects import (
CertificateListResponse,
CertificateActivateResponse,
CertificateDeactivateResponse,
)
Methods:
Types:
from openai.types import (
EvalCustomDataSourceConfig,
EvalStoredCompletionsDataSourceConfig,
EvalCreateResponse,
EvalRetrieveResponse,
EvalUpdateResponse,
EvalListResponse,
EvalDeleteResponse,
)
Methods:
Types:
from openai.types.evals import (
CreateEvalCompletionsRunDataSource,
CreateEvalJSONLRunDataSource,
EvalAPIError,
RunCreateResponse,
RunRetrieveResponse,
RunListResponse,
RunDeleteResponse,
RunCancelResponse,
)
Methods:
Types:
from openai.types.evals.runs import OutputItemRetrieveResponse, OutputItemListResponse
Methods:
Types:
from openai.types import ContainerCreateResponse, ContainerRetrieveResponse, ContainerListResponse
Methods:
Types:
from openai.types.containers import FileCreateResponse, FileRetrieveResponse, FileListResponse
Methods:
Methods:
Types:
from openai.types import DeletedSkill, Skill, SkillList
Methods:
Methods:
Types:
from openai.types.skills import DeletedSkillVersion, SkillVersion, SkillVersionList
Methods:
Methods:
Types:
from openai.types import (
ImageInputReferenceParam,
Video,
VideoCreateError,
VideoModel,
VideoSeconds,
VideoSize,
VideoDeleteResponse,
VideoCreateCharacterResponse,
VideoGetCharacterResponse,
)
Methods: