# Shared Types
```python
from openai.types import (
AllModels,
ChatModel,
ComparisonFilter,
CompoundFilter,
CustomToolInputFormat,
ErrorObject,
FunctionDefinition,
FunctionParameters,
Metadata,
OAuthErrorCode,
Reasoning,
ReasoningEffort,
ResponseFormatJSONObject,
ResponseFormatJSONSchema,
ResponseFormatText,
ResponseFormatTextGrammar,
ResponseFormatTextPython,
ResponsesModel,
)
```
# Completions
Types:
```python
from openai.types import Completion, CompletionChoice, CompletionUsage
```
Methods:
- client.completions.create(\*\*params) -> Completion
# Chat
Types:
```python
from openai.types import ChatModel
```
## Completions
Types:
```python
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:
- client.chat.completions.create(\*\*params) -> ChatCompletion
- client.chat.completions.retrieve(completion_id) -> ChatCompletion
- client.chat.completions.update(completion_id, \*\*params) -> ChatCompletion
- client.chat.completions.list(\*\*params) -> SyncCursorPage[ChatCompletion]
- client.chat.completions.delete(completion_id) -> ChatCompletionDeleted
### Messages
Methods:
- client.chat.completions.messages.list(completion_id, \*\*params) -> SyncCursorPage[ChatCompletionStoreMessage]
# Embeddings
Types:
```python
from openai.types import CreateEmbeddingResponse, Embedding, EmbeddingModel
```
Methods:
- client.embeddings.create(\*\*params) -> CreateEmbeddingResponse
# Files
Types:
```python
from openai.types import FileContent, FileDeleted, FileObject, FilePurpose
```
Methods:
- client.files.create(\*\*params) -> FileObject
- client.files.retrieve(file_id) -> FileObject
- client.files.list(\*\*params) -> SyncCursorPage[FileObject]
- client.files.delete(file_id) -> FileDeleted
- client.files.content(file_id) -> HttpxBinaryResponseContent
- client.files.retrieve_content(file_id) -> str
- client.files.wait_for_processing(\*args) -> FileObject
# Images
Types:
```python
from openai.types import (
Image,
ImageEditCompletedEvent,
ImageEditPartialImageEvent,
ImageEditStreamEvent,
ImageGenCompletedEvent,
ImageGenPartialImageEvent,
ImageGenStreamEvent,
ImageModel,
ImagesResponse,
)
```
Methods:
- client.images.create_variation(\*\*params) -> ImagesResponse
- client.images.edit(\*\*params) -> ImagesResponse
- client.images.generate(\*\*params) -> ImagesResponse
# Audio
Types:
```python
from openai.types import AudioModel, AudioResponseFormat
```
## Transcriptions
Types:
```python
from openai.types.audio import (
Transcription,
TranscriptionDiarized,
TranscriptionDiarizedSegment,
TranscriptionInclude,
TranscriptionSegment,
TranscriptionStreamEvent,
TranscriptionTextDeltaEvent,
TranscriptionTextDoneEvent,
TranscriptionTextSegmentEvent,
TranscriptionVerbose,
TranscriptionWord,
TranscriptionCreateResponse,
)
```
Methods:
- client.audio.transcriptions.create(\*\*params) -> TranscriptionCreateResponse
## Translations
Types:
```python
from openai.types.audio import Translation, TranslationVerbose, TranslationCreateResponse
```
Methods:
- client.audio.translations.create(\*\*params) -> TranslationCreateResponse
## Speech
Types:
```python
from openai.types.audio import SpeechModel
```
Methods:
- client.audio.speech.create(\*\*params) -> HttpxBinaryResponseContent
# Moderations
Types:
```python
from openai.types import (
Moderation,
ModerationImageURLInput,
ModerationModel,
ModerationMultiModalInput,
ModerationTextInput,
ModerationCreateResponse,
)
```
Methods:
- client.moderations.create(\*\*params) -> ModerationCreateResponse
# Models
Types:
```python
from openai.types import Model, ModelDeleted
```
Methods:
- client.models.retrieve(model) -> Model
- client.models.list() -> SyncPage[Model]
- client.models.delete(model) -> ModelDeleted
# FineTuning
## Methods
Types:
```python
from openai.types.fine_tuning import (
DpoHyperparameters,
DpoMethod,
ReinforcementHyperparameters,
ReinforcementMethod,
SupervisedHyperparameters,
SupervisedMethod,
)
```
## Jobs
Types:
```python
from openai.types.fine_tuning import (
FineTuningJob,
FineTuningJobEvent,
FineTuningJobWandbIntegration,
FineTuningJobWandbIntegrationObject,
FineTuningJobIntegration,
)
```
Methods:
- client.fine_tuning.jobs.create(\*\*params) -> FineTuningJob
- client.fine_tuning.jobs.retrieve(fine_tuning_job_id) -> FineTuningJob
- client.fine_tuning.jobs.list(\*\*params) -> SyncCursorPage[FineTuningJob]
- client.fine_tuning.jobs.cancel(fine_tuning_job_id) -> FineTuningJob
- client.fine_tuning.jobs.list_events(fine_tuning_job_id, \*\*params) -> SyncCursorPage[FineTuningJobEvent]
- client.fine_tuning.jobs.pause(fine_tuning_job_id) -> FineTuningJob
- client.fine_tuning.jobs.resume(fine_tuning_job_id) -> FineTuningJob
### Checkpoints
Types:
```python
from openai.types.fine_tuning.jobs import FineTuningJobCheckpoint
```
Methods:
- client.fine_tuning.jobs.checkpoints.list(fine_tuning_job_id, \*\*params) -> SyncCursorPage[FineTuningJobCheckpoint]
## Checkpoints
### Permissions
Types:
```python
from openai.types.fine_tuning.checkpoints import (
PermissionCreateResponse,
PermissionRetrieveResponse,
PermissionListResponse,
PermissionDeleteResponse,
)
```
Methods:
- client.fine_tuning.checkpoints.permissions.create(fine_tuned_model_checkpoint, \*\*params) -> SyncPage[PermissionCreateResponse]
- client.fine_tuning.checkpoints.permissions.retrieve(fine_tuned_model_checkpoint, \*\*params) -> PermissionRetrieveResponse
- client.fine_tuning.checkpoints.permissions.list(fine_tuned_model_checkpoint, \*\*params) -> SyncConversationCursorPage[PermissionListResponse]
- client.fine_tuning.checkpoints.permissions.delete(permission_id, \*, fine_tuned_model_checkpoint) -> PermissionDeleteResponse
## Alpha
### Graders
Types:
```python
from openai.types.fine_tuning.alpha import GraderRunResponse, GraderValidateResponse
```
Methods:
- client.fine_tuning.alpha.graders.run(\*\*params) -> GraderRunResponse
- client.fine_tuning.alpha.graders.validate(\*\*params) -> GraderValidateResponse
# Graders
## GraderModels
Types:
```python
from openai.types.graders import (
GraderInputs,
LabelModelGrader,
MultiGrader,
PythonGrader,
ScoreModelGrader,
StringCheckGrader,
TextSimilarityGrader,
)
```
# VectorStores
Types:
```python
from openai.types import (
AutoFileChunkingStrategyParam,
FileChunkingStrategy,
FileChunkingStrategyParam,
OtherFileChunkingStrategyObject,
StaticFileChunkingStrategy,
StaticFileChunkingStrategyObject,
StaticFileChunkingStrategyObjectParam,
VectorStore,
VectorStoreDeleted,
VectorStoreSearchResponse,
)
```
Methods:
- client.vector_stores.create(\*\*params) -> VectorStore
- client.vector_stores.retrieve(vector_store_id) -> VectorStore
- client.vector_stores.update(vector_store_id, \*\*params) -> VectorStore
- client.vector_stores.list(\*\*params) -> SyncCursorPage[VectorStore]
- client.vector_stores.delete(vector_store_id) -> VectorStoreDeleted
- client.vector_stores.search(vector_store_id, \*\*params) -> SyncPage[VectorStoreSearchResponse]
## Files
Types:
```python
from openai.types.vector_stores import VectorStoreFile, VectorStoreFileDeleted, FileContentResponse
```
Methods:
- client.vector_stores.files.create(vector_store_id, \*\*params) -> VectorStoreFile
- client.vector_stores.files.retrieve(file_id, \*, vector_store_id) -> VectorStoreFile
- client.vector_stores.files.update(file_id, \*, vector_store_id, \*\*params) -> VectorStoreFile
- client.vector_stores.files.list(vector_store_id, \*\*params) -> SyncCursorPage[VectorStoreFile]
- client.vector_stores.files.delete(file_id, \*, vector_store_id) -> VectorStoreFileDeleted
- client.vector_stores.files.content(file_id, \*, vector_store_id) -> SyncPage[FileContentResponse]
- client.vector_stores.files.create_and_poll(\*args) -> VectorStoreFile
- client.vector_stores.files.poll(\*args) -> VectorStoreFile
- client.vector_stores.files.upload(\*args) -> VectorStoreFile
- client.vector_stores.files.upload_and_poll(\*args) -> VectorStoreFile
## FileBatches
Types:
```python
from openai.types.vector_stores import VectorStoreFileBatch
```
Methods:
- client.vector_stores.file_batches.create(vector_store_id, \*\*params) -> VectorStoreFileBatch
- client.vector_stores.file_batches.retrieve(batch_id, \*, vector_store_id) -> VectorStoreFileBatch
- client.vector_stores.file_batches.cancel(batch_id, \*, vector_store_id) -> VectorStoreFileBatch
- client.vector_stores.file_batches.list_files(batch_id, \*, vector_store_id, \*\*params) -> SyncCursorPage[VectorStoreFile]
- client.vector_stores.file_batches.create_and_poll(\*args) -> VectorStoreFileBatch
- client.vector_stores.file_batches.poll(\*args) -> VectorStoreFileBatch
- client.vector_stores.file_batches.upload_and_poll(\*args) -> VectorStoreFileBatch
# [Webhooks](src/openai/resources/webhooks/api.md)
Methods:
- client.webhooks.unwrap(payload, headers, \*, secret) -> UnwrapWebhookEvent
- client.webhooks.verify_signature(payload, headers, \*, secret, tolerance) -> None
# Beta
## Responses
Types:
```python
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:
- client.beta.responses.create(\*\*params) -> BetaResponse
- client.beta.responses.retrieve(response_id, \*\*params) -> BetaResponse
- client.beta.responses.delete(response_id) -> None
- client.beta.responses.cancel(response_id) -> BetaResponse
- client.beta.responses.compact(\*\*params) -> BetaCompactedResponse
### InputItems
Types:
```python
from openai.types.beta.responses import BetaResponseItemList
```
Methods:
- client.beta.responses.input_items.list(response_id, \*\*params) -> SyncCursorPage[BetaResponseItem]
### InputTokens
Types:
```python
from openai.types.beta.responses import InputTokenCountResponse
```
Methods:
- client.beta.responses.input_tokens.count(\*\*params) -> InputTokenCountResponse
## Realtime
Types:
```python
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,
)
```
### Sessions
Types:
```python
from openai.types.beta.realtime import Session, SessionCreateResponse
```
Methods:
- client.beta.realtime.sessions.create(\*\*params) -> SessionCreateResponse
### TranscriptionSessions
Types:
```python
from openai.types.beta.realtime import TranscriptionSession
```
Methods:
- client.beta.realtime.transcription_sessions.create(\*\*params) -> TranscriptionSession
## Assistants
Types:
```python
from openai.types.beta import (
Assistant,
AssistantDeleted,
AssistantStreamEvent,
AssistantTool,
CodeInterpreterTool,
FileSearchTool,
FunctionTool,
MessageStreamEvent,
RunStepStreamEvent,
RunStreamEvent,
ThreadStreamEvent,
)
```
Methods:
- client.beta.assistants.create(\*\*params) -> Assistant
- client.beta.assistants.retrieve(assistant_id) -> Assistant
- client.beta.assistants.update(assistant_id, \*\*params) -> Assistant
- client.beta.assistants.list(\*\*params) -> SyncCursorPage[Assistant]
- client.beta.assistants.delete(assistant_id) -> AssistantDeleted
## Threads
Types:
```python
from openai.types.beta import (
AssistantResponseFormatOption,
AssistantToolChoice,
AssistantToolChoiceFunction,
AssistantToolChoiceOption,
Thread,
ThreadDeleted,
)
```
Methods:
- client.beta.threads.create(\*\*params) -> Thread
- client.beta.threads.retrieve(thread_id) -> Thread
- client.beta.threads.update(thread_id, \*\*params) -> Thread
- client.beta.threads.delete(thread_id) -> ThreadDeleted
- client.beta.threads.create_and_run(\*\*params) -> Run
- client.beta.threads.create_and_run_poll(\*args) -> Run
- client.beta.threads.create_and_run_stream(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]
### Runs
Types:
```python
from openai.types.beta.threads import RequiredActionFunctionToolCall, Run, RunStatus
```
Methods:
- client.beta.threads.runs.create(thread_id, \*\*params) -> Run
- client.beta.threads.runs.retrieve(run_id, \*, thread_id) -> Run
- client.beta.threads.runs.update(run_id, \*, thread_id, \*\*params) -> Run
- client.beta.threads.runs.list(thread_id, \*\*params) -> SyncCursorPage[Run]
- client.beta.threads.runs.cancel(run_id, \*, thread_id) -> Run
- client.beta.threads.runs.submit_tool_outputs(run_id, \*, thread_id, \*\*params) -> Run
- client.beta.threads.runs.create_and_poll(\*args) -> Run
- client.beta.threads.runs.create_and_stream(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]
- client.beta.threads.runs.poll(\*args) -> Run
- client.beta.threads.runs.stream(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]
- client.beta.threads.runs.submit_tool_outputs_and_poll(\*args) -> Run
- client.beta.threads.runs.submit_tool_outputs_stream(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]
#### Steps
Types:
```python
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:
- client.beta.threads.runs.steps.retrieve(step_id, \*, thread_id, run_id, \*\*params) -> RunStep
- client.beta.threads.runs.steps.list(run_id, \*, thread_id, \*\*params) -> SyncCursorPage[RunStep]
### Messages
Types:
```python
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:
- client.beta.threads.messages.create(thread_id, \*\*params) -> Message
- client.beta.threads.messages.retrieve(message_id, \*, thread_id) -> Message
- client.beta.threads.messages.update(message_id, \*, thread_id, \*\*params) -> Message
- client.beta.threads.messages.list(thread_id, \*\*params) -> SyncCursorPage[Message]
- client.beta.threads.messages.delete(message_id, \*, thread_id) -> MessageDeleted
# Batches
Types:
```python
from openai.types import Batch, BatchError, BatchRequestCounts, BatchUsage
```
Methods:
- client.batches.create(\*\*params) -> Batch
- client.batches.retrieve(batch_id) -> Batch
- client.batches.list(\*\*params) -> SyncCursorPage[Batch]
- client.batches.cancel(batch_id) -> Batch
# Uploads
Types:
```python
from openai.types import Upload
```
Methods:
- client.uploads.create(\*\*params) -> Upload
- client.uploads.cancel(upload_id) -> Upload
- client.uploads.complete(upload_id, \*\*params) -> Upload
## Parts
Types:
```python
from openai.types.uploads import UploadPart
```
Methods:
- client.uploads.parts.create(upload_id, \*\*params) -> UploadPart
# Admin
## Organization
### AuditLogs
Types:
```python
from openai.types.admin.organization import AuditLogListResponse
```
Methods:
- client.admin.organization.audit_logs.list(\*\*params) -> SyncConversationCursorPage[AuditLogListResponse]
### AdminAPIKeys
Types:
```python
from openai.types.admin.organization import (
AdminAPIKey,
AdminAPIKeyCreateResponse,
AdminAPIKeyDeleteResponse,
)
```
Methods:
- client.admin.organization.admin_api_keys.create(\*\*params) -> AdminAPIKeyCreateResponse
- client.admin.organization.admin_api_keys.retrieve(key_id) -> AdminAPIKey
- client.admin.organization.admin_api_keys.list(\*\*params) -> SyncCursorPage[AdminAPIKey]
- client.admin.organization.admin_api_keys.delete(key_id) -> AdminAPIKeyDeleteResponse
### Usage
Types:
```python
from openai.types.admin.organization import (
UsageAudioSpeechesResponse,
UsageAudioTranscriptionsResponse,
UsageCodeInterpreterSessionsResponse,
UsageCompletionsResponse,
UsageCostsResponse,
UsageEmbeddingsResponse,
UsageFileSearchCallsResponse,
UsageImagesResponse,
UsageModerationsResponse,
UsageVectorStoresResponse,
UsageWebSearchCallsResponse,
)
```
Methods:
- client.admin.organization.usage.audio_speeches(\*\*params) -> UsageAudioSpeechesResponse
- client.admin.organization.usage.audio_transcriptions(\*\*params) -> UsageAudioTranscriptionsResponse
- client.admin.organization.usage.code_interpreter_sessions(\*\*params) -> UsageCodeInterpreterSessionsResponse
- client.admin.organization.usage.completions(\*\*params) -> UsageCompletionsResponse
- client.admin.organization.usage.costs(\*\*params) -> UsageCostsResponse
- client.admin.organization.usage.embeddings(\*\*params) -> UsageEmbeddingsResponse
- client.admin.organization.usage.file_search_calls(\*\*params) -> UsageFileSearchCallsResponse
- client.admin.organization.usage.images(\*\*params) -> UsageImagesResponse
- client.admin.organization.usage.moderations(\*\*params) -> UsageModerationsResponse
- client.admin.organization.usage.vector_stores(\*\*params) -> UsageVectorStoresResponse
- client.admin.organization.usage.web_search_calls(\*\*params) -> UsageWebSearchCallsResponse
### Invites
Types:
```python
from openai.types.admin.organization import Invite, InviteDeleteResponse
```
Methods:
- client.admin.organization.invites.create(\*\*params) -> Invite
- client.admin.organization.invites.retrieve(invite_id) -> Invite
- client.admin.organization.invites.list(\*\*params) -> SyncConversationCursorPage[Invite]
- client.admin.organization.invites.delete(invite_id) -> InviteDeleteResponse
### Users
Types:
```python
from openai.types.admin.organization import OrganizationUser, UserDeleteResponse
```
Methods:
- client.admin.organization.users.retrieve(user_id) -> OrganizationUser
- client.admin.organization.users.update(user_id, \*\*params) -> OrganizationUser
- client.admin.organization.users.list(\*\*params) -> SyncConversationCursorPage[OrganizationUser]
- client.admin.organization.users.delete(user_id) -> UserDeleteResponse
#### Roles
Types:
```python
from openai.types.admin.organization.users import (
RoleCreateResponse,
RoleRetrieveResponse,
RoleListResponse,
RoleDeleteResponse,
)
```
Methods:
- client.admin.organization.users.roles.create(user_id, \*\*params) -> RoleCreateResponse
- client.admin.organization.users.roles.retrieve(role_id, \*, user_id) -> RoleRetrieveResponse
- client.admin.organization.users.roles.list(user_id, \*\*params) -> SyncNextCursorPage[RoleListResponse]
- client.admin.organization.users.roles.delete(role_id, \*, user_id) -> RoleDeleteResponse
### Groups
Types:
```python
from openai.types.admin.organization import Group, GroupUpdateResponse, GroupDeleteResponse
```
Methods:
- client.admin.organization.groups.create(\*\*params) -> Group
- client.admin.organization.groups.retrieve(group_id) -> Group
- client.admin.organization.groups.update(group_id, \*\*params) -> GroupUpdateResponse
- client.admin.organization.groups.list(\*\*params) -> SyncNextCursorPage[Group]
- client.admin.organization.groups.delete(group_id) -> GroupDeleteResponse
#### Users
Types:
```python
from openai.types.admin.organization.groups import (
OrganizationGroupUser,
UserCreateResponse,
UserRetrieveResponse,
UserDeleteResponse,
)
```
Methods:
- client.admin.organization.groups.users.create(group_id, \*\*params) -> UserCreateResponse
- client.admin.organization.groups.users.retrieve(user_id, \*, group_id) -> UserRetrieveResponse
- client.admin.organization.groups.users.list(group_id, \*\*params) -> SyncNextCursorPage[OrganizationGroupUser]
- client.admin.organization.groups.users.delete(user_id, \*, group_id) -> UserDeleteResponse
#### Roles
Types:
```python
from openai.types.admin.organization.groups import (
RoleCreateResponse,
RoleRetrieveResponse,
RoleListResponse,
RoleDeleteResponse,
)
```
Methods:
- client.admin.organization.groups.roles.create(group_id, \*\*params) -> RoleCreateResponse
- client.admin.organization.groups.roles.retrieve(role_id, \*, group_id) -> RoleRetrieveResponse
- client.admin.organization.groups.roles.list(group_id, \*\*params) -> SyncNextCursorPage[RoleListResponse]
- client.admin.organization.groups.roles.delete(role_id, \*, group_id) -> RoleDeleteResponse
### Roles
Types:
```python
from openai.types.admin.organization import Role, RoleDeleteResponse
```
Methods:
- client.admin.organization.roles.create(\*\*params) -> Role
- client.admin.organization.roles.retrieve(role_id) -> Role
- client.admin.organization.roles.update(role_id, \*\*params) -> Role
- client.admin.organization.roles.list(\*\*params) -> SyncNextCursorPage[Role]
- client.admin.organization.roles.delete(role_id) -> RoleDeleteResponse
### DataRetention
Types:
```python
from openai.types.admin.organization import OrganizationDataRetention
```
Methods:
- client.admin.organization.data_retention.retrieve() -> OrganizationDataRetention
- client.admin.organization.data_retention.update(\*\*params) -> OrganizationDataRetention
### SpendAlerts
Types:
```python
from openai.types.admin.organization import OrganizationSpendAlert, OrganizationSpendAlertDeleted
```
Methods:
- client.admin.organization.spend_alerts.create(\*\*params) -> OrganizationSpendAlert
- client.admin.organization.spend_alerts.retrieve(alert_id) -> OrganizationSpendAlert
- client.admin.organization.spend_alerts.update(alert_id, \*\*params) -> OrganizationSpendAlert
- client.admin.organization.spend_alerts.list(\*\*params) -> SyncConversationCursorPage[OrganizationSpendAlert]
- client.admin.organization.spend_alerts.delete(alert_id) -> OrganizationSpendAlertDeleted
### Certificates
Types:
```python
from openai.types.admin.organization import (
Certificate,
CertificateListResponse,
CertificateDeleteResponse,
CertificateActivateResponse,
CertificateDeactivateResponse,
)
```
Methods:
- client.admin.organization.certificates.create(\*\*params) -> Certificate
- client.admin.organization.certificates.retrieve(certificate_id, \*\*params) -> Certificate
- client.admin.organization.certificates.update(certificate_id, \*\*params) -> Certificate
- client.admin.organization.certificates.list(\*\*params) -> SyncConversationCursorPage[CertificateListResponse]
- client.admin.organization.certificates.delete(certificate_id) -> CertificateDeleteResponse
- client.admin.organization.certificates.activate(\*\*params) -> SyncPage[CertificateActivateResponse]
- client.admin.organization.certificates.deactivate(\*\*params) -> SyncPage[CertificateDeactivateResponse]
### Projects
Types:
```python
from openai.types.admin.organization import Project
```
Methods:
- client.admin.organization.projects.create(\*\*params) -> Project
- client.admin.organization.projects.retrieve(project_id) -> Project
- client.admin.organization.projects.update(project_id, \*\*params) -> Project
- client.admin.organization.projects.list(\*\*params) -> SyncConversationCursorPage[Project]
- client.admin.organization.projects.archive(project_id) -> Project
#### Users
Types:
```python
from openai.types.admin.organization.projects import ProjectUser, UserDeleteResponse
```
Methods:
- client.admin.organization.projects.users.create(project_id, \*\*params) -> ProjectUser
- client.admin.organization.projects.users.retrieve(user_id, \*, project_id) -> ProjectUser
- client.admin.organization.projects.users.update(user_id, \*, project_id, \*\*params) -> ProjectUser
- client.admin.organization.projects.users.list(project_id, \*\*params) -> SyncConversationCursorPage[ProjectUser]
- client.admin.organization.projects.users.delete(user_id, \*, project_id) -> UserDeleteResponse
##### Roles
Types:
```python
from openai.types.admin.organization.projects.users import (
RoleCreateResponse,
RoleRetrieveResponse,
RoleListResponse,
RoleDeleteResponse,
)
```
Methods:
- client.admin.organization.projects.users.roles.create(user_id, \*, project_id, \*\*params) -> RoleCreateResponse
- client.admin.organization.projects.users.roles.retrieve(role_id, \*, project_id, user_id) -> RoleRetrieveResponse
- client.admin.organization.projects.users.roles.list(user_id, \*, project_id, \*\*params) -> SyncNextCursorPage[RoleListResponse]
- client.admin.organization.projects.users.roles.delete(role_id, \*, project_id, user_id) -> RoleDeleteResponse
#### ServiceAccounts
Types:
```python
from openai.types.admin.organization.projects import (
ProjectServiceAccount,
ServiceAccountCreateResponse,
ServiceAccountDeleteResponse,
)
```
Methods:
- client.admin.organization.projects.service_accounts.create(project_id, \*\*params) -> ServiceAccountCreateResponse
- client.admin.organization.projects.service_accounts.retrieve(service_account_id, \*, project_id) -> ProjectServiceAccount
- client.admin.organization.projects.service_accounts.update(service_account_id, \*, project_id, \*\*params) -> ProjectServiceAccount
- client.admin.organization.projects.service_accounts.list(project_id, \*\*params) -> SyncConversationCursorPage[ProjectServiceAccount]
- client.admin.organization.projects.service_accounts.delete(service_account_id, \*, project_id) -> ServiceAccountDeleteResponse
##### APIKeys
Types:
```python
from openai.types.admin.organization.projects.service_accounts import APIKeyCreateResponse
```
Methods:
- client.admin.organization.projects.service_accounts.api_keys.create(service_account_id, \*, project_id, \*\*params) -> APIKeyCreateResponse
#### APIKeys
Types:
```python
from openai.types.admin.organization.projects import ProjectAPIKey, APIKeyDeleteResponse
```
Methods:
- client.admin.organization.projects.api_keys.retrieve(api_key_id, \*, project_id) -> ProjectAPIKey
- client.admin.organization.projects.api_keys.list(project_id, \*\*params) -> SyncConversationCursorPage[ProjectAPIKey]
- client.admin.organization.projects.api_keys.delete(api_key_id, \*, project_id) -> APIKeyDeleteResponse
#### RateLimits
Types:
```python
from openai.types.admin.organization.projects import ProjectRateLimit
```
Methods:
- client.admin.organization.projects.rate_limits.list_rate_limits(project_id, \*\*params) -> SyncConversationCursorPage[ProjectRateLimit]
- client.admin.organization.projects.rate_limits.update_rate_limit(rate_limit_id, \*, project_id, \*\*params) -> ProjectRateLimit
#### ModelPermissions
Types:
```python
from openai.types.admin.organization.projects import (
ProjectModelPermissions,
ProjectModelPermissionsDeleted,
)
```
Methods:
- client.admin.organization.projects.model_permissions.retrieve(project_id) -> ProjectModelPermissions
- client.admin.organization.projects.model_permissions.update(project_id, \*\*params) -> ProjectModelPermissions
- client.admin.organization.projects.model_permissions.delete(project_id) -> ProjectModelPermissionsDeleted
#### HostedToolPermissions
Types:
```python
from openai.types.admin.organization.projects import ProjectHostedToolPermissions
```
Methods:
- client.admin.organization.projects.hosted_tool_permissions.retrieve(project_id) -> ProjectHostedToolPermissions
- client.admin.organization.projects.hosted_tool_permissions.update(project_id, \*\*params) -> ProjectHostedToolPermissions
#### Groups
Types:
```python
from openai.types.admin.organization.projects import ProjectGroup, GroupDeleteResponse
```
Methods:
- client.admin.organization.projects.groups.create(project_id, \*\*params) -> ProjectGroup
- client.admin.organization.projects.groups.retrieve(group_id, \*, project_id, \*\*params) -> ProjectGroup
- client.admin.organization.projects.groups.list(project_id, \*\*params) -> SyncNextCursorPage[ProjectGroup]
- client.admin.organization.projects.groups.delete(group_id, \*, project_id) -> GroupDeleteResponse
##### Roles
Types:
```python
from openai.types.admin.organization.projects.groups import (
RoleCreateResponse,
RoleRetrieveResponse,
RoleListResponse,
RoleDeleteResponse,
)
```
Methods:
- client.admin.organization.projects.groups.roles.create(group_id, \*, project_id, \*\*params) -> RoleCreateResponse
- client.admin.organization.projects.groups.roles.retrieve(role_id, \*, project_id, group_id) -> RoleRetrieveResponse
- client.admin.organization.projects.groups.roles.list(group_id, \*, project_id, \*\*params) -> SyncNextCursorPage[RoleListResponse]
- client.admin.organization.projects.groups.roles.delete(role_id, \*, project_id, group_id) -> RoleDeleteResponse
#### Roles
Types:
```python
from openai.types.admin.organization.projects import RoleDeleteResponse
```
Methods:
- client.admin.organization.projects.roles.create(project_id, \*\*params) -> Role
- client.admin.organization.projects.roles.retrieve(role_id, \*, project_id) -> Role
- client.admin.organization.projects.roles.update(role_id, \*, project_id, \*\*params) -> Role
- client.admin.organization.projects.roles.list(project_id, \*\*params) -> SyncNextCursorPage[Role]
- client.admin.organization.projects.roles.delete(role_id, \*, project_id) -> RoleDeleteResponse
#### DataRetention
Types:
```python
from openai.types.admin.organization.projects import ProjectDataRetention
```
Methods:
- client.admin.organization.projects.data_retention.retrieve(project_id) -> ProjectDataRetention
- client.admin.organization.projects.data_retention.update(project_id, \*\*params) -> ProjectDataRetention
#### SpendAlerts
Types:
```python
from openai.types.admin.organization.projects import ProjectSpendAlert, ProjectSpendAlertDeleted
```
Methods:
- client.admin.organization.projects.spend_alerts.create(project_id, \*\*params) -> ProjectSpendAlert
- client.admin.organization.projects.spend_alerts.retrieve(alert_id, \*, project_id) -> ProjectSpendAlert
- client.admin.organization.projects.spend_alerts.update(alert_id, \*, project_id, \*\*params) -> ProjectSpendAlert
- client.admin.organization.projects.spend_alerts.list(project_id, \*\*params) -> SyncConversationCursorPage[ProjectSpendAlert]
- client.admin.organization.projects.spend_alerts.delete(alert_id, \*, project_id) -> ProjectSpendAlertDeleted
#### Certificates
Types:
```python
from openai.types.admin.organization.projects import (
CertificateListResponse,
CertificateActivateResponse,
CertificateDeactivateResponse,
)
```
Methods:
- client.admin.organization.projects.certificates.list(project_id, \*\*params) -> SyncConversationCursorPage[CertificateListResponse]
- client.admin.organization.projects.certificates.activate(project_id, \*\*params) -> SyncPage[CertificateActivateResponse]
- client.admin.organization.projects.certificates.deactivate(project_id, \*\*params) -> SyncPage[CertificateDeactivateResponse]
# [Responses](src/openai/resources/responses/api.md)
# [Realtime](src/openai/resources/realtime/api.md)
# [Conversations](src/openai/resources/conversations/api.md)
# Evals
Types:
```python
from openai.types import (
EvalCustomDataSourceConfig,
EvalStoredCompletionsDataSourceConfig,
EvalCreateResponse,
EvalRetrieveResponse,
EvalUpdateResponse,
EvalListResponse,
EvalDeleteResponse,
)
```
Methods:
- client.evals.create(\*\*params) -> EvalCreateResponse
- client.evals.retrieve(eval_id) -> EvalRetrieveResponse
- client.evals.update(eval_id, \*\*params) -> EvalUpdateResponse
- client.evals.list(\*\*params) -> SyncCursorPage[EvalListResponse]
- client.evals.delete(eval_id) -> EvalDeleteResponse
## Runs
Types:
```python
from openai.types.evals import (
CreateEvalCompletionsRunDataSource,
CreateEvalJSONLRunDataSource,
EvalAPIError,
RunCreateResponse,
RunRetrieveResponse,
RunListResponse,
RunDeleteResponse,
RunCancelResponse,
)
```
Methods:
- client.evals.runs.create(eval_id, \*\*params) -> RunCreateResponse
- client.evals.runs.retrieve(run_id, \*, eval_id) -> RunRetrieveResponse
- client.evals.runs.list(eval_id, \*\*params) -> SyncCursorPage[RunListResponse]
- client.evals.runs.delete(run_id, \*, eval_id) -> RunDeleteResponse
- client.evals.runs.cancel(run_id, \*, eval_id) -> RunCancelResponse
### OutputItems
Types:
```python
from openai.types.evals.runs import OutputItemRetrieveResponse, OutputItemListResponse
```
Methods:
- client.evals.runs.output_items.retrieve(output_item_id, \*, eval_id, run_id) -> OutputItemRetrieveResponse
- client.evals.runs.output_items.list(run_id, \*, eval_id, \*\*params) -> SyncCursorPage[OutputItemListResponse]
# Containers
Types:
```python
from openai.types import ContainerCreateResponse, ContainerRetrieveResponse, ContainerListResponse
```
Methods:
- client.containers.create(\*\*params) -> ContainerCreateResponse
- client.containers.retrieve(container_id) -> ContainerRetrieveResponse
- client.containers.list(\*\*params) -> SyncCursorPage[ContainerListResponse]
- client.containers.delete(container_id) -> None
## Files
Types:
```python
from openai.types.containers import FileCreateResponse, FileRetrieveResponse, FileListResponse
```
Methods:
- client.containers.files.create(container_id, \*\*params) -> FileCreateResponse
- client.containers.files.retrieve(file_id, \*, container_id) -> FileRetrieveResponse
- client.containers.files.list(container_id, \*\*params) -> SyncCursorPage[FileListResponse]
- client.containers.files.delete(file_id, \*, container_id) -> None
### Content
Methods:
- client.containers.files.content.retrieve(file_id, \*, container_id) -> HttpxBinaryResponseContent
# Skills
Types:
```python
from openai.types import DeletedSkill, Skill, SkillList
```
Methods:
- client.skills.create(\*\*params) -> Skill
- client.skills.retrieve(skill_id) -> Skill
- client.skills.update(skill_id, \*\*params) -> Skill
- client.skills.list(\*\*params) -> SyncCursorPage[Skill]
- client.skills.delete(skill_id) -> DeletedSkill
## Content
Methods:
- client.skills.content.retrieve(skill_id) -> HttpxBinaryResponseContent
## Versions
Types:
```python
from openai.types.skills import DeletedSkillVersion, SkillVersion, SkillVersionList
```
Methods:
- client.skills.versions.create(skill_id, \*\*params) -> SkillVersion
- client.skills.versions.retrieve(version, \*, skill_id) -> SkillVersion
- client.skills.versions.list(skill_id, \*\*params) -> SyncCursorPage[SkillVersion]
- client.skills.versions.delete(version, \*, skill_id) -> DeletedSkillVersion
### Content
Methods:
- client.skills.versions.content.retrieve(version, \*, skill_id) -> HttpxBinaryResponseContent
# Videos
Types:
```python
from openai.types import (
ImageInputReferenceParam,
Video,
VideoCreateError,
VideoModel,
VideoSeconds,
VideoSize,
VideoDeleteResponse,
VideoCreateCharacterResponse,
VideoGetCharacterResponse,
)
```
Methods:
- client.videos.create(\*\*params) -> Video
- client.videos.retrieve(video_id) -> Video
- client.videos.list(\*\*params) -> SyncConversationCursorPage[Video]
- client.videos.delete(video_id) -> VideoDeleteResponse
- client.videos.create_character(\*\*params) -> VideoCreateCharacterResponse
- client.videos.download_content(video_id, \*\*params) -> HttpxBinaryResponseContent
- client.videos.edit(\*\*params) -> Video
- client.videos.extend(\*\*params) -> Video
- client.videos.get_character(character_id) -> VideoGetCharacterResponse
- client.videos.remix(video_id, \*\*params) -> Video
- client.videos.create_and_poll(\*args) -> Video
- client.videos.poll(\*args) -> Video