api.md

Shared Types

from openai.types import (
    AllModels,
    ChatModel,
    ComparisonFilter,
    CompoundFilter,
    CustomToolInputFormat,
    ErrorObject,
    FunctionDefinition,
    FunctionParameters,
    Metadata,
    Reasoning,
    ReasoningEffort,
    ResponseFormatJSONObject,
    ResponseFormatJSONSchema,
    ResponseFormatText,
    ResponseFormatTextGrammar,
    ResponseFormatTextPython,
    ResponsesModel,
)

Completions

Types:

from openai.types import Completion, CompletionChoice, CompletionUsage

Methods:

• client.completions.create(**params) -> Completion

Chat

Types:

from openai.types import ChatModel

Completions

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:

• 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:

from openai.types import CreateEmbeddingResponse, Embedding, EmbeddingModel

Methods:

• client.embeddings.create(**params) -> CreateEmbeddingResponse

Files

Types:

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:

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:

from openai.types import AudioModel, AudioResponseFormat

Transcriptions

Types:

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:

from openai.types.audio import Translation, TranslationVerbose, TranslationCreateResponse

Methods:

• client.audio.translations.create(**params) -> TranslationCreateResponse

Speech

Types:

from openai.types.audio import SpeechModel

Methods:

• client.audio.speech.create(**params) -> HttpxBinaryResponseContent

Moderations

Types:

from openai.types import (
    Moderation,
    ModerationImageURLInput,
    ModerationModel,
    ModerationMultiModalInput,
    ModerationTextInput,
    ModerationCreateResponse,
)

Methods:

• client.moderations.create(**params) -> ModerationCreateResponse

Models

Types:

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:

from openai.types.fine_tuning import (
    DpoHyperparameters,
    DpoMethod,
    ReinforcementHyperparameters,
    ReinforcementMethod,
    SupervisedHyperparameters,
    SupervisedMethod,
)

Jobs

Types:

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:

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:

from openai.types.fine_tuning.checkpoints import (
    PermissionCreateResponse,
    PermissionRetrieveResponse,
    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.delete(permission_id, *, fine_tuned_model_checkpoint) -> PermissionDeleteResponse

Alpha

Graders

Types:

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:

from openai.types.graders import (
    GraderInputs,
    LabelModelGrader,
    MultiGrader,
    PythonGrader,
    ScoreModelGrader,
    StringCheckGrader,
    TextSimilarityGrader,
)

VectorStores

Types:

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:

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:

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

Methods:

• client.webhooks.unwrap(payload, headers, *, secret) -> UnwrapWebhookEvent
• client.webhooks.verify_signature(payload, headers, *, secret, tolerance) -> None

Beta

Realtime

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,
)

Sessions

Types:

from openai.types.beta.realtime import Session, SessionCreateResponse

Methods:

• client.beta.realtime.sessions.create(**params) -> SessionCreateResponse

TranscriptionSessions

Types:

from openai.types.beta.realtime import TranscriptionSession

Methods:

• client.beta.realtime.transcription_sessions.create(**params) -> TranscriptionSession

Assistants

Types:

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:

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:

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:

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:

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:

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:

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:

from openai.types.uploads import UploadPart

Methods:

• client.uploads.parts.create(upload_id, **params) -> UploadPart

Responses

Realtime

Conversations

Evals

Types:

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:

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:

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:

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:

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:

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:

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:

from openai.types import (
    Video,
    VideoCreateError,
    VideoModel,
    VideoSeconds,
    VideoSize,
    VideoDeleteResponse,
)

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.download_content(video_id, **params) -> HttpxBinaryResponseContent
• client.videos.remix(video_id, **params) -> Video
• client.videos.create_and_poll(*args) -> Video