{"owner":"openai","repo":"openai-python","hasSkills":true,"totalSkillsCount":1,"totalTokensCount":13014,"categories":["project-spec"],"hasMcp":false,"mcpConfig":null,"found":["api.md"],"skills":{"api.md":"# Shared Types\n\n```python\nfrom openai.types import (\n AllModels,\n ChatModel,\n ComparisonFilter,\n CompoundFilter,\n CustomToolInputFormat,\n DecisionInputJSON,\n DecisionQuestionInputImage,\n DecisionQuestionInputPart,\n DecisionQuestionInputText,\n ErrorObject,\n FunctionDefinition,\n FunctionParameters,\n Metadata,\n OAuthErrorCode,\n Reasoning,\n ReasoningEffort,\n ResponseFormatJSONObject,\n ResponseFormatJSONSchema,\n ResponseFormatText,\n ResponseFormatTextGrammar,\n ResponseFormatTextPython,\n ResponsesModel,\n)\n```\n\n# Decisions\n\nTypes:\n\n```python\nfrom openai.types import (\n Decision,\n DecisionInputImageParam,\n DecisionInputMessageParam,\n DecisionInputPartUnionParam,\n DecisionInputTextParam,\n DecisionPromptCacheBreakpointParam,\n)\n```\n\nMethods:\n\n- client.decisions.create(\\*\\*params) -> Decision\n\n# Completions\n\nTypes:\n\n```python\nfrom openai.types import Completion, CompletionChoice, CompletionUsage\n```\n\nMethods:\n\n- client.completions.create(\\*\\*params) -> Completion\n\n# Chat\n\nTypes:\n\n```python\nfrom openai.types import ChatModel\n```\n\n## Completions\n\nTypes:\n\n```python\nfrom openai.types.chat import (\n ChatCompletionAllowedToolsParam,\n ChatCompletion,\n ChatCompletionAllowedToolChoiceParam,\n ChatCompletionAssistantMessageParam,\n ChatCompletionAudio,\n ChatCompletionAudioParam,\n ChatCompletionChunk,\n ChatCompletionContentPartParam,\n ChatCompletionContentPartImage,\n ChatCompletionContentPartInputAudioParam,\n ChatCompletionContentPartRefusalParam,\n ChatCompletionContentPartText,\n ChatCompletionCustomToolParam,\n ChatCompletionDeleted,\n ChatCompletionDeveloperMessageParam,\n ChatCompletionFunctionCallOptionParam,\n ChatCompletionFunctionMessageParam,\n ChatCompletionFunctionTool,\n ChatCompletionMessage,\n ChatCompletionMessageCustomToolCall,\n ChatCompletionMessageFunctionToolCall,\n ChatCompletionMessageParam,\n ChatCompletionMessageToolCallUnion,\n ChatCompletionModality,\n ChatCompletionNamedToolChoiceParam,\n ChatCompletionNamedToolChoiceCustomParam,\n ChatCompletionPredictionContentParam,\n ChatCompletionRole,\n ChatCompletionStoreMessage,\n ChatCompletionStreamOptionsParam,\n ChatCompletionSystemMessageParam,\n ChatCompletionTokenLogprob,\n ChatCompletionToolUnionParam,\n ChatCompletionToolChoiceOptionParam,\n ChatCompletionToolMessageParam,\n ChatCompletionUserMessageParam,\n ChatCompletionReasoningEffort,\n)\n```\n\nMethods:\n\n- client.chat.completions.create(\\*\\*params) -> ChatCompletion\n- client.chat.completions.retrieve(completion_id) -> ChatCompletion\n- client.chat.completions.update(completion_id, \\*\\*params) -> ChatCompletion\n- client.chat.completions.list(\\*\\*params) -> SyncCursorPage[ChatCompletion]\n- client.chat.completions.delete(completion_id) -> ChatCompletionDeleted\n\n### Messages\n\nMethods:\n\n- client.chat.completions.messages.list(completion_id, \\*\\*params) -> SyncCursorPage[ChatCompletionStoreMessage]\n\n# Embeddings\n\nTypes:\n\n```python\nfrom openai.types import CreateEmbeddingResponse, Embedding, EmbeddingModel\n```\n\nMethods:\n\n- client.embeddings.create(\\*\\*params) -> CreateEmbeddingResponse\n\n# Files\n\nTypes:\n\n```python\nfrom openai.types import FileContent, FileDeleted, FileObject, FilePurpose\n```\n\nMethods:\n\n- client.files.create(\\*\\*params) -> FileObject\n- client.files.retrieve(file_id) -> FileObject\n- client.files.list(\\*\\*params) -> SyncCursorPage[FileObject]\n- client.files.delete(file_id) -> FileDeleted\n- client.files.content(file_id) -> HttpxBinaryResponseContent\n- client.files.retrieve_content(file_id) -> str\n- client.files.wait_for_processing(\\*args) -> FileObject\n\n# Images\n\nTypes:\n\n```python\nfrom openai.types import (\n Image,\n ImageEditCompletedEvent,\n ImageEditPartialImageEvent,\n ImageEditStreamEvent,\n ImageGenCompletedEvent,\n ImageGenPartialImageEvent,\n ImageGenStreamEvent,\n ImageModel,\n ImagesResponse,\n)\n```\n\nMethods:\n\n- client.images.create_variation(\\*\\*params) -> ImagesResponse\n- client.images.edit(\\*\\*params) -> ImagesResponse\n- client.images.generate(\\*\\*params) -> ImagesResponse\n\n# ContentProvenanceChecks\n\nTypes:\n\n```python\nfrom openai.types import ContentProvenanceCheck\n```\n\nMethods:\n\n- client.content_provenance_checks.create(\\*\\*params) -> ContentProvenanceCheck\n\n# Audio\n\nTypes:\n\n```python\nfrom openai.types import AudioModel, AudioResponseFormat\n```\n\n## Transcriptions\n\nTypes:\n\n```python\nfrom openai.types.audio import (\n Transcription,\n TranscriptionDiarized,\n TranscriptionDiarizedSegment,\n TranscriptionInclude,\n TranscriptionLanguage,\n TranscriptionSegment,\n TranscriptionStreamEvent,\n TranscriptionTextDeltaEvent,\n TranscriptionTextDoneEvent,\n TranscriptionTextSegmentEvent,\n TranscriptionVerbose,\n TranscriptionWord,\n TranscriptionCreateResponse,\n)\n```\n\nMethods:\n\n- client.audio.transcriptions.create(\\*\\*params) -> TranscriptionCreateResponse\n\n## Translations\n\nTypes:\n\n```python\nfrom openai.types.audio import Translation, TranslationVerbose, TranslationCreateResponse\n```\n\nMethods:\n\n- client.audio.translations.create(\\*\\*params) -> TranslationCreateResponse\n\n## Speech\n\nTypes:\n\n```python\nfrom openai.types.audio import SpeechModel\n```\n\nMethods:\n\n- client.audio.speech.create(\\*\\*params) -> HttpxBinaryResponseContent\n\n## Voices\n\nTypes:\n\n```python\nfrom openai.types.audio import Voice\n```\n\nMethods:\n\n- client.audio.voices.create(\\*\\*params) -> Voice\n\n## VoiceConsents\n\nTypes:\n\n```python\nfrom openai.types.audio import VoiceConsent, VoiceConsentDeleted\n```\n\nMethods:\n\n- client.audio.voice_consents.create(\\*\\*params) -> VoiceConsent\n- client.audio.voice_consents.retrieve(consent_id) -> VoiceConsent\n- client.audio.voice_consents.update(consent_id, \\*\\*params) -> VoiceConsent\n- client.audio.voice_consents.list(\\*\\*params) -> SyncCursorPage[VoiceConsent]\n- client.audio.voice_consents.delete(consent_id) -> VoiceConsentDeleted\n\n# Moderations\n\nTypes:\n\n```python\nfrom openai.types import (\n Moderation,\n ModerationImageURLInputParam,\n ModerationModel,\n ModerationMultiModalInputParam,\n ModerationTextInputParam,\n ModerationCreateResponse,\n)\n```\n\nMethods:\n\n- client.moderations.create(\\*\\*params) -> ModerationCreateResponse\n\n# Models\n\nTypes:\n\n```python\nfrom openai.types import Model, ModelDeleted\n```\n\nMethods:\n\n- client.models.retrieve(model) -> Model\n- client.models.list() -> SyncPage[Model]\n- client.models.delete(model) -> ModelDeleted\n\n# FineTuning\n\n## Methods\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning import (\n DpoHyperparameters,\n DpoMethod,\n ReinforcementHyperparameters,\n ReinforcementMethod,\n SupervisedHyperparameters,\n SupervisedMethod,\n)\n```\n\n## Jobs\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning import (\n FineTuningJob,\n FineTuningJobEvent,\n FineTuningJobWandbIntegration,\n FineTuningJobWandbIntegrationObject,\n FineTuningJobIntegration,\n)\n```\n\nMethods:\n\n- client.fine_tuning.jobs.create(\\*\\*params) -> FineTuningJob\n- client.fine_tuning.jobs.retrieve(fine_tuning_job_id) -> FineTuningJob\n- client.fine_tuning.jobs.list(\\*\\*params) -> SyncCursorPage[FineTuningJob]\n- client.fine_tuning.jobs.cancel(fine_tuning_job_id) -> FineTuningJob\n- client.fine_tuning.jobs.list_events(fine_tuning_job_id, \\*\\*params) -> SyncCursorPage[FineTuningJobEvent]\n- client.fine_tuning.jobs.pause(fine_tuning_job_id) -> FineTuningJob\n- client.fine_tuning.jobs.resume(fine_tuning_job_id) -> FineTuningJob\n\n### Checkpoints\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning.jobs import FineTuningJobCheckpoint\n```\n\nMethods:\n\n- client.fine_tuning.jobs.checkpoints.list(fine_tuning_job_id, \\*\\*params) -> SyncCursorPage[FineTuningJobCheckpoint]\n\n## Checkpoints\n\n### Permissions\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning.checkpoints import (\n PermissionCreateResponse,\n PermissionRetrieveResponse,\n PermissionListResponse,\n PermissionDeleteResponse,\n)\n```\n\nMethods:\n\n- client.fine_tuning.checkpoints.permissions.create(fine_tuned_model_checkpoint, \\*\\*params) -> SyncPage[PermissionCreateResponse]\n- client.fine_tuning.checkpoints.permissions.retrieve(fine_tuned_model_checkpoint, \\*\\*params) -> PermissionRetrieveResponse\n- client.fine_tuning.checkpoints.permissions.list(fine_tuned_model_checkpoint, \\*\\*params) -> SyncConversationCursorPage[PermissionListResponse]\n- client.fine_tuning.checkpoints.permissions.delete(permission_id, \\*, fine_tuned_model_checkpoint) -> PermissionDeleteResponse\n\n## Alpha\n\n### Graders\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning.alpha import GraderRunResponse, GraderValidateResponse\n```\n\nMethods:\n\n- client.fine_tuning.alpha.graders.run(\\*\\*params) -> GraderRunResponse\n- client.fine_tuning.alpha.graders.validate(\\*\\*params) -> GraderValidateResponse\n\n# Graders\n\n## GraderModels\n\nTypes:\n\n```python\nfrom openai.types.graders import (\n GraderInputs,\n LabelModelGrader,\n MultiGrader,\n PythonGrader,\n ScoreModelGrader,\n StringCheckGrader,\n TextSimilarityGrader,\n)\n```\n\n# VectorStores\n\nTypes:\n\n```python\nfrom openai.types import (\n AutoFileChunkingStrategyParam,\n FileChunkingStrategy,\n FileChunkingStrategyParam,\n OtherFileChunkingStrategyObject,\n StaticFileChunkingStrategy,\n StaticFileChunkingStrategyObject,\n StaticFileChunkingStrategyObjectParam,\n VectorStore,\n VectorStoreDeleted,\n VectorStoreSearchResponse,\n)\n```\n\nMethods:\n\n- client.vector_stores.create(\\*\\*params) -> VectorStore\n- client.vector_stores.retrieve(vector_store_id) -> VectorStore\n- client.vector_stores.update(vector_store_id, \\*\\*params) -> VectorStore\n- client.vector_stores.list(\\*\\*params) -> SyncCursorPage[VectorStore]\n- client.vector_stores.delete(vector_store_id) -> VectorStoreDeleted\n- client.vector_stores.search(vector_store_id, \\*\\*params) -> SyncPage[VectorStoreSearchResponse]\n\n## Files\n\nTypes:\n\n```python\nfrom openai.types.vector_stores import VectorStoreFile, VectorStoreFileDeleted, FileContentResponse\n```\n\nMethods:\n\n- client.vector_stores.files.create(vector_store_id, \\*\\*params) -> VectorStoreFile\n- client.vector_stores.files.retrieve(file_id, \\*, vector_store_id) -> VectorStoreFile\n- client.vector_stores.files.update(file_id, \\*, vector_store_id, \\*\\*params) -> VectorStoreFile\n- client.vector_stores.files.list(vector_store_id, \\*\\*params) -> SyncCursorPage[VectorStoreFile]\n- client.vector_stores.files.delete(file_id, \\*, vector_store_id) -> VectorStoreFileDeleted\n- client.vector_stores.files.content(file_id, \\*, vector_store_id) -> SyncPage[FileContentResponse]\n- client.vector_stores.files.create_and_poll(\\*args) -> VectorStoreFile\n- client.vector_stores.files.poll(\\*args) -> VectorStoreFile\n- client.vector_stores.files.upload(\\*args) -> VectorStoreFile\n- client.vector_stores.files.upload_and_poll(\\*args) -> VectorStoreFile\n\n## FileBatches\n\nTypes:\n\n```python\nfrom openai.types.vector_stores import VectorStoreFileBatch\n```\n\nMethods:\n\n- client.vector_stores.file_batches.create(vector_store_id, \\*\\*params) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.retrieve(batch_id, \\*, vector_store_id) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.cancel(batch_id, \\*, vector_store_id) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.list_files(batch_id, \\*, vector_store_id, \\*\\*params) -> SyncCursorPage[VectorStoreFile]\n- client.vector_stores.file_batches.create_and_poll(\\*args) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.poll(\\*args) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.upload_and_poll(\\*args) -> VectorStoreFileBatch\n\n# Safety\n\n## Alerts\n\nTypes:\n\n```python\nfrom openai.types.safety import SafetyAlert\n```\n\nMethods:\n\n- client.safety.alerts.retrieve(id) -> SafetyAlert\n\n# Safety\n\n## Cases\n\nTypes:\n\n```python\nfrom openai.types.safety import SafetyCase\n```\n\nMethods:\n\n- client.safety.cases.retrieve(id) -> SafetyCase\n\n## Alerts\n\nTypes:\n\n```python\nfrom openai.types.safety import SafetyAlert\n```\n\nMethods:\n\n- client.safety.alerts.retrieve(id) -> SafetyAlert\n\n# [Webhooks](src/openai/resources/webhooks/api.md)\n\nMethods:\n\n- client.webhooks.unwrap(payload, headers, \\*, secret) -> UnwrapWebhookEvent\n- client.webhooks.verify_signature(payload, headers, \\*, secret, tolerance) -> None\n\n# Beta\n\n## Agents\n\nTypes:\n\n```python\nfrom openai.types.beta import (\n Agent,\n AgentBrowserAuthenticationCancelParam,\n AgentBrowserAuthenticationSubmitParam,\n AgentBrowserOriginAccessParam,\n AgentCloseSubagentCallItem,\n AgentCommandExecutionItem,\n AgentContent,\n AgentCreateSubagentCallItem,\n AgentDeleted,\n AgentFunctionCallItem,\n AgentFunctionCallOutput,\n AgentFunctionCallOutputParam,\n AgentFunctionCallStatus,\n AgentInterruptSubagentCallItem,\n AgentMcpCallItem,\n AgentOutputCommandExecutionOutputDeltaEvent,\n AgentOutputItem,\n AgentOutputItemStatus,\n AgentReasoning,\n AgentReasoningItem,\n AgentReasoningParam,\n AgentResumeSubagentCallItem,\n AgentSendSubagentInputCallItem,\n AgentSession,\n AgentSessionAssistantMessage,\n AgentSessionCreatedEvent,\n AgentSessionDeleted,\n AgentSessionEnvironmentConnectedEvent,\n AgentSessionEnvironmentDisconnectedEvent,\n AgentSessionEnvironmentExpiredEvent,\n AgentSessionEnvironmentFailedEvent,\n AgentSessionEnvironmentPendingEvent,\n AgentSessionEnvironmentReadyEvent,\n AgentSessionEnvironmentResetEvent,\n AgentSessionEnvironmentState,\n AgentSessionEnvironmentSuspendedEvent,\n AgentSessionErrorEvent,\n AgentSessionEvent,\n AgentSessionFailedEvent,\n AgentSessionIdleEvent,\n AgentSessionInProgressEvent,\n AgentSessionInputMessageParam,\n AgentSessionInputParam,\n AgentSessionItem,\n AgentSessionMessage,\n AgentSessionMessageContent,\n AgentSessionRequiresActionEvent,\n AgentSessionSubagentActiveEvent,\n AgentSessionSubagentClosedEvent,\n AgentSessionSubagentCreatedEvent,\n AgentSessionTurnCancelledEvent,\n AgentSessionTurnCompletedEvent,\n AgentSessionTurnContentPartAddedEvent,\n AgentSessionTurnContentPartDoneEvent,\n AgentSessionTurnCreatedEvent,\n AgentSessionTurnFailedEvent,\n AgentSessionTurnInProgressEvent,\n AgentSessionTurnItemAddedEvent,\n AgentSessionTurnItemDoneEvent,\n AgentSessionTurnOutputTextDeltaEvent,\n AgentSessionTurnOutputTextDoneEvent,\n AgentSessionTurnReasoningSummaryPartAddedEvent,\n AgentSessionTurnReasoningSummaryPartDoneEvent,\n AgentSessionTurnReasoningSummaryTextDeltaEvent,\n AgentSessionTurnReasoningSummaryTextDoneEvent,\n AgentText,\n AgentTextParam,\n AgentTool,\n AgentToolParam,\n AgentWaitForSubagentsCallItem,\n AgentWebSearchCallItem,\n Environment,\n EnvironmentParam,\n HostedEnvironmentFile,\n HostedEnvironmentFileID,\n HostedEnvironmentFileParam,\n HostedPlugin,\n HostedPluginParam,\n HostedSkill,\n HostedSkillParam,\n HostedSkillReference,\n InlineCapabilitySourceParam,\n InputContent,\n InputContentParam,\n McpTransport,\n McpTransportParam,\n MultiAgentConfig,\n MultiAgentConfigParam,\n OutputText,\n PersistedAgentTool,\n PersistedAgentToolParam,\n PersistedMcpTransport,\n PersistedMcpTransportParam,\n SessionError,\n SessionTurnError,\n SetupCommandParam,\n Subagent,\n SummaryText,\n TextFormat,\n TextFormatParam,\n TokenUsage,\n WebSearchAction,\n)\n```\n\nMethods:\n\n- client.beta.agents.create(\\*\\*params) -> Agent\n- client.beta.agents.retrieve(agent_id) -> Agent\n- client.beta.agents.update(agent_id, \\*\\*params) -> Agent\n- client.beta.agents.list(\\*\\*params) -> SyncCursorPage[Agent]\n- client.beta.agents.delete(agent_id) -> AgentDeleted\n\n### Environments\n\nTypes:\n\n```python\nfrom openai.types.beta.agents import EnvironmentInfo\n```\n\nMethods:\n\n- client.beta.agents.environments.create(\\*\\*params) -> EnvironmentInfo\n- client.beta.agents.environments.retrieve(environment_id) -> EnvironmentInfo\n- client.beta.agents.environments.list(\\*\\*params) -> SyncCursorPage[EnvironmentInfo]\n\n#### Files\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.environments import EnvironmentFile\n```\n\nMethods:\n\n- client.beta.agents.environments.files.create(environment_id, \\*\\*params) -> EnvironmentFile\n- client.beta.agents.environments.files.list(environment_id, \\*\\*params) -> SyncTokenPage[EnvironmentFile]\n\n#### Templates\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.environments import EnvironmentTemplate, EnvironmentTemplateDeleted\n```\n\nMethods:\n\n- client.beta.agents.environments.templates.create(\\*\\*params) -> EnvironmentTemplate\n- client.beta.agents.environments.templates.retrieve(environment_template_id) -> EnvironmentTemplate\n- client.beta.agents.environments.templates.update(environment_template_id, \\*\\*params) -> EnvironmentTemplate\n- client.beta.agents.environments.templates.list(\\*\\*params) -> SyncCursorPage[EnvironmentTemplate]\n- client.beta.agents.environments.templates.delete(environment_template_id) -> EnvironmentTemplateDeleted\n\n### Vaults\n\nTypes:\n\n```python\nfrom openai.types.beta.agents import Vault, VaultDeleted, VaultStatus, VaultStatusFilterParam\n```\n\nMethods:\n\n- client.beta.agents.vaults.create(\\*\\*params) -> Vault\n- client.beta.agents.vaults.retrieve(vault_id) -> Vault\n- client.beta.agents.vaults.update(vault_id, \\*\\*params) -> Vault\n- client.beta.agents.vaults.list(\\*\\*params) -> SyncCursorPage[Vault]\n- client.beta.agents.vaults.delete(vault_id) -> VaultDeleted\n\n#### Credentials\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.vaults import (\n Credential,\n CredentialAuth,\n CredentialAuthCreateParam,\n CredentialAuthRotateParam,\n CredentialDeleted,\n CredentialNetworking,\n CredentialNetworkingParam,\n McpOauthTokenEndpointAuth,\n McpOauthTokenEndpointAuthCreateParam,\n McpOauthTokenEndpointAuthRotateParam,\n)\n```\n\nMethods:\n\n- client.beta.agents.vaults.credentials.create(vault_id, \\*\\*params) -> Credential\n- client.beta.agents.vaults.credentials.retrieve(credential_id, \\*, vault_id) -> Credential\n- client.beta.agents.vaults.credentials.update(credential_id, \\*, vault_id, \\*\\*params) -> Credential\n- client.beta.agents.vaults.credentials.list(vault_id, \\*\\*params) -> SyncCursorPage[Credential]\n- client.beta.agents.vaults.credentials.delete(credential_id, \\*, vault_id) -> CredentialDeleted\n\n### Sessions\n\nMethods:\n\n- client.beta.agents.sessions.create(\\*\\*params) -> AgentSession\n- client.beta.agents.sessions.retrieve(session_id) -> AgentSession\n- client.beta.agents.sessions.update(session_id, \\*\\*params) -> AgentSession\n- client.beta.agents.sessions.list(\\*\\*params) -> SyncCursorPage[AgentSession]\n- client.beta.agents.sessions.delete(session_id) -> AgentSessionDeleted\n\n#### Subagents\n\nMethods:\n\n- client.beta.agents.sessions.subagents.retrieve(subagent_id, \\*, session_id) -> Subagent\n- client.beta.agents.sessions.subagents.list(session_id, \\*\\*params) -> SyncCursorPage[Subagent]\n\n##### Items\n\nMethods:\n\n- client.beta.agents.sessions.subagents.items.list(subagent_id, \\*, session_id, \\*\\*params) -> SyncCursorPage[AgentSessionItem]\n\n##### Turns\n\nMethods:\n\n- client.beta.agents.sessions.subagents.turns.retrieve(turn_id, \\*, session_id, subagent_id) -> Turn\n- client.beta.agents.sessions.subagents.turns.list(subagent_id, \\*, session_id, \\*\\*params) -> SyncCursorPage[Turn]\n\n###### Items\n\nMethods:\n\n- client.beta.agents.sessions.subagents.turns.items.list(turn_id, \\*, session_id, subagent_id, \\*\\*params) -> SyncCursorPage[AgentSessionItem]\n\n#### Artifacts\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.sessions import SessionArtifact, SessionArtifactDeleted\n```\n\nMethods:\n\n- client.beta.agents.sessions.artifacts.retrieve(artifact_id, \\*, session_id) -> SessionArtifact\n- client.beta.agents.sessions.artifacts.list(session_id, \\*\\*params) -> SyncCursorPage[SessionArtifact]\n- client.beta.agents.sessions.artifacts.delete(artifact_id, \\*, session_id) -> SessionArtifactDeleted\n- client.beta.agents.sessions.artifacts.content(artifact_id, \\*, session_id) -> HttpxBinaryResponseContent\n\n#### Items\n\nMethods:\n\n- client.beta.agents.sessions.items.list(session_id, \\*\\*params) -> SyncCursorPage[AgentSessionItem]\n\n#### Events\n\nMethods:\n\n- client.beta.agents.sessions.events.create(session_id, \\*\\*params) -> None\n- client.beta.agents.sessions.events.stream(session_id) -> AgentSessionEvent\n\n#### Traces\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.sessions import SessionTrace\n```\n\nMethods:\n\n- client.beta.agents.sessions.traces.list(session_id, \\*\\*params) -> SyncCursorPage[SessionTrace]\n\n#### Turns\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.sessions import Turn\n```\n\nMethods:\n\n- client.beta.agents.sessions.turns.retrieve(turn_id, \\*, session_id) -> Turn\n- client.beta.agents.sessions.turns.list(session_id, \\*\\*params) -> SyncCursorPage[Turn]\n\n##### Items\n\nMethods:\n\n- client.beta.agents.sessions.turns.items.list(turn_id, \\*, session_id, \\*\\*params) -> SyncConversationCursorPage[AgentSessionItem]\n\n## Responses\n\nTypes:\n\n```python\nfrom openai.types.beta import (\n BetaApplyPatchTool,\n BetaCompactedResponse,\n BetaComputerAction,\n BetaComputerActionList,\n BetaComputerTool,\n BetaComputerUsePreviewTool,\n BetaContainerAuto,\n BetaContainerNetworkPolicyAllowlist,\n BetaContainerNetworkPolicyDisabled,\n BetaContainerNetworkPolicyDomainSecret,\n BetaContainerReference,\n BetaCustomTool,\n BetaEasyInputMessage,\n BetaFileSearchTool,\n BetaFunctionShellTool,\n BetaFunctionTool,\n BetaImageDetail,\n BetaInlineSkill,\n BetaInlineSkillSource,\n BetaLocalEnvironment,\n BetaLocalSkill,\n BetaMcpToolCallError,\n BetaNamespaceTool,\n BetaResponse,\n BetaResponseApplyPatchToolCall,\n BetaResponseApplyPatchToolCallOutput,\n BetaResponseAudioDeltaEvent,\n BetaResponseAudioDoneEvent,\n BetaResponseAudioTranscriptDeltaEvent,\n BetaResponseAudioTranscriptDoneEvent,\n BetaResponseCodeInterpreterCallCodeDeltaEvent,\n BetaResponseCodeInterpreterCallCodeDoneEvent,\n BetaResponseCodeInterpreterCallCompletedEvent,\n BetaResponseCodeInterpreterCallInProgressEvent,\n BetaResponseCodeInterpreterCallInterpretingEvent,\n BetaResponseCodeInterpreterToolCall,\n BetaResponseCompactionCompactingEvent,\n BetaResponseCompactionItem,\n BetaResponseCompactionItemParam,\n BetaResponseCompletedEvent,\n BetaResponseComputerToolCall,\n BetaResponseComputerToolCallOutputItem,\n BetaResponseComputerToolCallOutputScreenshot,\n BetaResponseConfigurationUpdateItem,\n BetaResponseConfigurationUpdateItemParam,\n BetaResponseContainerReference,\n BetaResponseContent,\n BetaResponseContentPartAddedEvent,\n BetaResponseContentPartDoneEvent,\n BetaResponseConversationParam,\n BetaResponseCreatedEvent,\n BetaResponseCustomToolCall,\n BetaResponseCustomToolCallInputDeltaEvent,\n BetaResponseCustomToolCallInputDoneEvent,\n BetaResponseCustomToolCallItem,\n BetaResponseCustomToolCallOutput,\n BetaResponseCustomToolCallOutputItem,\n BetaResponseError,\n BetaResponseErrorEvent,\n BetaResponseFailedEvent,\n BetaResponseFileSearchCallCompletedEvent,\n BetaResponseFileSearchCallInProgressEvent,\n BetaResponseFileSearchCallSearchingEvent,\n BetaResponseFileSearchToolCall,\n BetaResponseFormatTextConfig,\n BetaResponseFormatTextJSONSchemaConfig,\n BetaResponseFunctionCallArgumentsDeltaEvent,\n BetaResponseFunctionCallArgumentsDoneEvent,\n BetaResponseFunctionCallOutputItem,\n BetaResponseFunctionCallOutputItemList,\n BetaResponseFunctionShellCallOutputContent,\n BetaResponseFunctionShellToolCall,\n BetaResponseFunctionShellToolCallOutput,\n BetaResponseFunctionToolCall,\n BetaResponseFunctionToolCallItem,\n BetaResponseFunctionToolCallOutputItem,\n BetaResponseFunctionWebSearch,\n BetaResponseImageGenCallCompletedEvent,\n BetaResponseImageGenCallGeneratingEvent,\n BetaResponseImageGenCallInProgressEvent,\n BetaResponseImageGenCallPartialImageEvent,\n BetaResponseInProgressEvent,\n BetaResponseIn"},"files":{"api.md":"# Shared Types\n\n```python\nfrom openai.types import (\n AllModels,\n ChatModel,\n ComparisonFilter,\n CompoundFilter,\n CustomToolInputFormat,\n DecisionInputJSON,\n DecisionQuestionInputImage,\n DecisionQuestionInputPart,\n DecisionQuestionInputText,\n ErrorObject,\n FunctionDefinition,\n FunctionParameters,\n Metadata,\n OAuthErrorCode,\n Reasoning,\n ReasoningEffort,\n ResponseFormatJSONObject,\n ResponseFormatJSONSchema,\n ResponseFormatText,\n ResponseFormatTextGrammar,\n ResponseFormatTextPython,\n ResponsesModel,\n)\n```\n\n# Decisions\n\nTypes:\n\n```python\nfrom openai.types import (\n Decision,\n DecisionInputImageParam,\n DecisionInputMessageParam,\n DecisionInputPartUnionParam,\n DecisionInputTextParam,\n DecisionPromptCacheBreakpointParam,\n)\n```\n\nMethods:\n\n- client.decisions.create(\\*\\*params) -> Decision\n\n# Completions\n\nTypes:\n\n```python\nfrom openai.types import Completion, CompletionChoice, CompletionUsage\n```\n\nMethods:\n\n- client.completions.create(\\*\\*params) -> Completion\n\n# Chat\n\nTypes:\n\n```python\nfrom openai.types import ChatModel\n```\n\n## Completions\n\nTypes:\n\n```python\nfrom openai.types.chat import (\n ChatCompletionAllowedToolsParam,\n ChatCompletion,\n ChatCompletionAllowedToolChoiceParam,\n ChatCompletionAssistantMessageParam,\n ChatCompletionAudio,\n ChatCompletionAudioParam,\n ChatCompletionChunk,\n ChatCompletionContentPartParam,\n ChatCompletionContentPartImage,\n ChatCompletionContentPartInputAudioParam,\n ChatCompletionContentPartRefusalParam,\n ChatCompletionContentPartText,\n ChatCompletionCustomToolParam,\n ChatCompletionDeleted,\n ChatCompletionDeveloperMessageParam,\n ChatCompletionFunctionCallOptionParam,\n ChatCompletionFunctionMessageParam,\n ChatCompletionFunctionTool,\n ChatCompletionMessage,\n ChatCompletionMessageCustomToolCall,\n ChatCompletionMessageFunctionToolCall,\n ChatCompletionMessageParam,\n ChatCompletionMessageToolCallUnion,\n ChatCompletionModality,\n ChatCompletionNamedToolChoiceParam,\n ChatCompletionNamedToolChoiceCustomParam,\n ChatCompletionPredictionContentParam,\n ChatCompletionRole,\n ChatCompletionStoreMessage,\n ChatCompletionStreamOptionsParam,\n ChatCompletionSystemMessageParam,\n ChatCompletionTokenLogprob,\n ChatCompletionToolUnionParam,\n ChatCompletionToolChoiceOptionParam,\n ChatCompletionToolMessageParam,\n ChatCompletionUserMessageParam,\n ChatCompletionReasoningEffort,\n)\n```\n\nMethods:\n\n- client.chat.completions.create(\\*\\*params) -> ChatCompletion\n- client.chat.completions.retrieve(completion_id) -> ChatCompletion\n- client.chat.completions.update(completion_id, \\*\\*params) -> ChatCompletion\n- client.chat.completions.list(\\*\\*params) -> SyncCursorPage[ChatCompletion]\n- client.chat.completions.delete(completion_id) -> ChatCompletionDeleted\n\n### Messages\n\nMethods:\n\n- client.chat.completions.messages.list(completion_id, \\*\\*params) -> SyncCursorPage[ChatCompletionStoreMessage]\n\n# Embeddings\n\nTypes:\n\n```python\nfrom openai.types import CreateEmbeddingResponse, Embedding, EmbeddingModel\n```\n\nMethods:\n\n- client.embeddings.create(\\*\\*params) -> CreateEmbeddingResponse\n\n# Files\n\nTypes:\n\n```python\nfrom openai.types import FileContent, FileDeleted, FileObject, FilePurpose\n```\n\nMethods:\n\n- client.files.create(\\*\\*params) -> FileObject\n- client.files.retrieve(file_id) -> FileObject\n- client.files.list(\\*\\*params) -> SyncCursorPage[FileObject]\n- client.files.delete(file_id) -> FileDeleted\n- client.files.content(file_id) -> HttpxBinaryResponseContent\n- client.files.retrieve_content(file_id) -> str\n- client.files.wait_for_processing(\\*args) -> FileObject\n\n# Images\n\nTypes:\n\n```python\nfrom openai.types import (\n Image,\n ImageEditCompletedEvent,\n ImageEditPartialImageEvent,\n ImageEditStreamEvent,\n ImageGenCompletedEvent,\n ImageGenPartialImageEvent,\n ImageGenStreamEvent,\n ImageModel,\n ImagesResponse,\n)\n```\n\nMethods:\n\n- client.images.create_variation(\\*\\*params) -> ImagesResponse\n- client.images.edit(\\*\\*params) -> ImagesResponse\n- client.images.generate(\\*\\*params) -> ImagesResponse\n\n# ContentProvenanceChecks\n\nTypes:\n\n```python\nfrom openai.types import ContentProvenanceCheck\n```\n\nMethods:\n\n- client.content_provenance_checks.create(\\*\\*params) -> ContentProvenanceCheck\n\n# Audio\n\nTypes:\n\n```python\nfrom openai.types import AudioModel, AudioResponseFormat\n```\n\n## Transcriptions\n\nTypes:\n\n```python\nfrom openai.types.audio import (\n Transcription,\n TranscriptionDiarized,\n TranscriptionDiarizedSegment,\n TranscriptionInclude,\n TranscriptionLanguage,\n TranscriptionSegment,\n TranscriptionStreamEvent,\n TranscriptionTextDeltaEvent,\n TranscriptionTextDoneEvent,\n TranscriptionTextSegmentEvent,\n TranscriptionVerbose,\n TranscriptionWord,\n TranscriptionCreateResponse,\n)\n```\n\nMethods:\n\n- client.audio.transcriptions.create(\\*\\*params) -> TranscriptionCreateResponse\n\n## Translations\n\nTypes:\n\n```python\nfrom openai.types.audio import Translation, TranslationVerbose, TranslationCreateResponse\n```\n\nMethods:\n\n- client.audio.translations.create(\\*\\*params) -> TranslationCreateResponse\n\n## Speech\n\nTypes:\n\n```python\nfrom openai.types.audio import SpeechModel\n```\n\nMethods:\n\n- client.audio.speech.create(\\*\\*params) -> HttpxBinaryResponseContent\n\n## Voices\n\nTypes:\n\n```python\nfrom openai.types.audio import Voice\n```\n\nMethods:\n\n- client.audio.voices.create(\\*\\*params) -> Voice\n\n## VoiceConsents\n\nTypes:\n\n```python\nfrom openai.types.audio import VoiceConsent, VoiceConsentDeleted\n```\n\nMethods:\n\n- client.audio.voice_consents.create(\\*\\*params) -> VoiceConsent\n- client.audio.voice_consents.retrieve(consent_id) -> VoiceConsent\n- client.audio.voice_consents.update(consent_id, \\*\\*params) -> VoiceConsent\n- client.audio.voice_consents.list(\\*\\*params) -> SyncCursorPage[VoiceConsent]\n- client.audio.voice_consents.delete(consent_id) -> VoiceConsentDeleted\n\n# Moderations\n\nTypes:\n\n```python\nfrom openai.types import (\n Moderation,\n ModerationImageURLInputParam,\n ModerationModel,\n ModerationMultiModalInputParam,\n ModerationTextInputParam,\n ModerationCreateResponse,\n)\n```\n\nMethods:\n\n- client.moderations.create(\\*\\*params) -> ModerationCreateResponse\n\n# Models\n\nTypes:\n\n```python\nfrom openai.types import Model, ModelDeleted\n```\n\nMethods:\n\n- client.models.retrieve(model) -> Model\n- client.models.list() -> SyncPage[Model]\n- client.models.delete(model) -> ModelDeleted\n\n# FineTuning\n\n## Methods\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning import (\n DpoHyperparameters,\n DpoMethod,\n ReinforcementHyperparameters,\n ReinforcementMethod,\n SupervisedHyperparameters,\n SupervisedMethod,\n)\n```\n\n## Jobs\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning import (\n FineTuningJob,\n FineTuningJobEvent,\n FineTuningJobWandbIntegration,\n FineTuningJobWandbIntegrationObject,\n FineTuningJobIntegration,\n)\n```\n\nMethods:\n\n- client.fine_tuning.jobs.create(\\*\\*params) -> FineTuningJob\n- client.fine_tuning.jobs.retrieve(fine_tuning_job_id) -> FineTuningJob\n- client.fine_tuning.jobs.list(\\*\\*params) -> SyncCursorPage[FineTuningJob]\n- client.fine_tuning.jobs.cancel(fine_tuning_job_id) -> FineTuningJob\n- client.fine_tuning.jobs.list_events(fine_tuning_job_id, \\*\\*params) -> SyncCursorPage[FineTuningJobEvent]\n- client.fine_tuning.jobs.pause(fine_tuning_job_id) -> FineTuningJob\n- client.fine_tuning.jobs.resume(fine_tuning_job_id) -> FineTuningJob\n\n### Checkpoints\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning.jobs import FineTuningJobCheckpoint\n```\n\nMethods:\n\n- client.fine_tuning.jobs.checkpoints.list(fine_tuning_job_id, \\*\\*params) -> SyncCursorPage[FineTuningJobCheckpoint]\n\n## Checkpoints\n\n### Permissions\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning.checkpoints import (\n PermissionCreateResponse,\n PermissionRetrieveResponse,\n PermissionListResponse,\n PermissionDeleteResponse,\n)\n```\n\nMethods:\n\n- client.fine_tuning.checkpoints.permissions.create(fine_tuned_model_checkpoint, \\*\\*params) -> SyncPage[PermissionCreateResponse]\n- client.fine_tuning.checkpoints.permissions.retrieve(fine_tuned_model_checkpoint, \\*\\*params) -> PermissionRetrieveResponse\n- client.fine_tuning.checkpoints.permissions.list(fine_tuned_model_checkpoint, \\*\\*params) -> SyncConversationCursorPage[PermissionListResponse]\n- client.fine_tuning.checkpoints.permissions.delete(permission_id, \\*, fine_tuned_model_checkpoint) -> PermissionDeleteResponse\n\n## Alpha\n\n### Graders\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning.alpha import GraderRunResponse, GraderValidateResponse\n```\n\nMethods:\n\n- client.fine_tuning.alpha.graders.run(\\*\\*params) -> GraderRunResponse\n- client.fine_tuning.alpha.graders.validate(\\*\\*params) -> GraderValidateResponse\n\n# Graders\n\n## GraderModels\n\nTypes:\n\n```python\nfrom openai.types.graders import (\n GraderInputs,\n LabelModelGrader,\n MultiGrader,\n PythonGrader,\n ScoreModelGrader,\n StringCheckGrader,\n TextSimilarityGrader,\n)\n```\n\n# VectorStores\n\nTypes:\n\n```python\nfrom openai.types import (\n AutoFileChunkingStrategyParam,\n FileChunkingStrategy,\n FileChunkingStrategyParam,\n OtherFileChunkingStrategyObject,\n StaticFileChunkingStrategy,\n StaticFileChunkingStrategyObject,\n StaticFileChunkingStrategyObjectParam,\n VectorStore,\n VectorStoreDeleted,\n VectorStoreSearchResponse,\n)\n```\n\nMethods:\n\n- client.vector_stores.create(\\*\\*params) -> VectorStore\n- client.vector_stores.retrieve(vector_store_id) -> VectorStore\n- client.vector_stores.update(vector_store_id, \\*\\*params) -> VectorStore\n- client.vector_stores.list(\\*\\*params) -> SyncCursorPage[VectorStore]\n- client.vector_stores.delete(vector_store_id) -> VectorStoreDeleted\n- client.vector_stores.search(vector_store_id, \\*\\*params) -> SyncPage[VectorStoreSearchResponse]\n\n## Files\n\nTypes:\n\n```python\nfrom openai.types.vector_stores import VectorStoreFile, VectorStoreFileDeleted, FileContentResponse\n```\n\nMethods:\n\n- client.vector_stores.files.create(vector_store_id, \\*\\*params) -> VectorStoreFile\n- client.vector_stores.files.retrieve(file_id, \\*, vector_store_id) -> VectorStoreFile\n- client.vector_stores.files.update(file_id, \\*, vector_store_id, \\*\\*params) -> VectorStoreFile\n- client.vector_stores.files.list(vector_store_id, \\*\\*params) -> SyncCursorPage[VectorStoreFile]\n- client.vector_stores.files.delete(file_id, \\*, vector_store_id) -> VectorStoreFileDeleted\n- client.vector_stores.files.content(file_id, \\*, vector_store_id) -> SyncPage[FileContentResponse]\n- client.vector_stores.files.create_and_poll(\\*args) -> VectorStoreFile\n- client.vector_stores.files.poll(\\*args) -> VectorStoreFile\n- client.vector_stores.files.upload(\\*args) -> VectorStoreFile\n- client.vector_stores.files.upload_and_poll(\\*args) -> VectorStoreFile\n\n## FileBatches\n\nTypes:\n\n```python\nfrom openai.types.vector_stores import VectorStoreFileBatch\n```\n\nMethods:\n\n- client.vector_stores.file_batches.create(vector_store_id, \\*\\*params) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.retrieve(batch_id, \\*, vector_store_id) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.cancel(batch_id, \\*, vector_store_id) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.list_files(batch_id, \\*, vector_store_id, \\*\\*params) -> SyncCursorPage[VectorStoreFile]\n- client.vector_stores.file_batches.create_and_poll(\\*args) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.poll(\\*args) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.upload_and_poll(\\*args) -> VectorStoreFileBatch\n\n# Safety\n\n## Alerts\n\nTypes:\n\n```python\nfrom openai.types.safety import SafetyAlert\n```\n\nMethods:\n\n- client.safety.alerts.retrieve(id) -> SafetyAlert\n\n# Safety\n\n## Cases\n\nTypes:\n\n```python\nfrom openai.types.safety import SafetyCase\n```\n\nMethods:\n\n- client.safety.cases.retrieve(id) -> SafetyCase\n\n## Alerts\n\nTypes:\n\n```python\nfrom openai.types.safety import SafetyAlert\n```\n\nMethods:\n\n- client.safety.alerts.retrieve(id) -> SafetyAlert\n\n# [Webhooks](src/openai/resources/webhooks/api.md)\n\nMethods:\n\n- client.webhooks.unwrap(payload, headers, \\*, secret) -> UnwrapWebhookEvent\n- client.webhooks.verify_signature(payload, headers, \\*, secret, tolerance) -> None\n\n# Beta\n\n## Agents\n\nTypes:\n\n```python\nfrom openai.types.beta import (\n Agent,\n AgentBrowserAuthenticationCancelParam,\n AgentBrowserAuthenticationSubmitParam,\n AgentBrowserOriginAccessParam,\n AgentCloseSubagentCallItem,\n AgentCommandExecutionItem,\n AgentContent,\n AgentCreateSubagentCallItem,\n AgentDeleted,\n AgentFunctionCallItem,\n AgentFunctionCallOutput,\n AgentFunctionCallOutputParam,\n AgentFunctionCallStatus,\n AgentInterruptSubagentCallItem,\n AgentMcpCallItem,\n AgentOutputCommandExecutionOutputDeltaEvent,\n AgentOutputItem,\n AgentOutputItemStatus,\n AgentReasoning,\n AgentReasoningItem,\n AgentReasoningParam,\n AgentResumeSubagentCallItem,\n AgentSendSubagentInputCallItem,\n AgentSession,\n AgentSessionAssistantMessage,\n AgentSessionCreatedEvent,\n AgentSessionDeleted,\n AgentSessionEnvironmentConnectedEvent,\n AgentSessionEnvironmentDisconnectedEvent,\n AgentSessionEnvironmentExpiredEvent,\n AgentSessionEnvironmentFailedEvent,\n AgentSessionEnvironmentPendingEvent,\n AgentSessionEnvironmentReadyEvent,\n AgentSessionEnvironmentResetEvent,\n AgentSessionEnvironmentState,\n AgentSessionEnvironmentSuspendedEvent,\n AgentSessionErrorEvent,\n AgentSessionEvent,\n AgentSessionFailedEvent,\n AgentSessionIdleEvent,\n AgentSessionInProgressEvent,\n AgentSessionInputMessageParam,\n AgentSessionInputParam,\n AgentSessionItem,\n AgentSessionMessage,\n AgentSessionMessageContent,\n AgentSessionRequiresActionEvent,\n AgentSessionSubagentActiveEvent,\n AgentSessionSubagentClosedEvent,\n AgentSessionSubagentCreatedEvent,\n AgentSessionTurnCancelledEvent,\n AgentSessionTurnCompletedEvent,\n AgentSessionTurnContentPartAddedEvent,\n AgentSessionTurnContentPartDoneEvent,\n AgentSessionTurnCreatedEvent,\n AgentSessionTurnFailedEvent,\n AgentSessionTurnInProgressEvent,\n AgentSessionTurnItemAddedEvent,\n AgentSessionTurnItemDoneEvent,\n AgentSessionTurnOutputTextDeltaEvent,\n AgentSessionTurnOutputTextDoneEvent,\n AgentSessionTurnReasoningSummaryPartAddedEvent,\n AgentSessionTurnReasoningSummaryPartDoneEvent,\n AgentSessionTurnReasoningSummaryTextDeltaEvent,\n AgentSessionTurnReasoningSummaryTextDoneEvent,\n AgentText,\n AgentTextParam,\n AgentTool,\n AgentToolParam,\n AgentWaitForSubagentsCallItem,\n AgentWebSearchCallItem,\n Environment,\n EnvironmentParam,\n HostedEnvironmentFile,\n HostedEnvironmentFileID,\n HostedEnvironmentFileParam,\n HostedPlugin,\n HostedPluginParam,\n HostedSkill,\n HostedSkillParam,\n HostedSkillReference,\n InlineCapabilitySourceParam,\n InputContent,\n InputContentParam,\n McpTransport,\n McpTransportParam,\n MultiAgentConfig,\n MultiAgentConfigParam,\n OutputText,\n PersistedAgentTool,\n PersistedAgentToolParam,\n PersistedMcpTransport,\n PersistedMcpTransportParam,\n SessionError,\n SessionTurnError,\n SetupCommandParam,\n Subagent,\n SummaryText,\n TextFormat,\n TextFormatParam,\n TokenUsage,\n WebSearchAction,\n)\n```\n\nMethods:\n\n- client.beta.agents.create(\\*\\*params) -> Agent\n- client.beta.agents.retrieve(agent_id) -> Agent\n- client.beta.agents.update(agent_id, \\*\\*params) -> Agent\n- client.beta.agents.list(\\*\\*params) -> SyncCursorPage[Agent]\n- client.beta.agents.delete(agent_id) -> AgentDeleted\n\n### Environments\n\nTypes:\n\n```python\nfrom openai.types.beta.agents import EnvironmentInfo\n```\n\nMethods:\n\n- client.beta.agents.environments.create(\\*\\*params) -> EnvironmentInfo\n- client.beta.agents.environments.retrieve(environment_id) -> EnvironmentInfo\n- client.beta.agents.environments.list(\\*\\*params) -> SyncCursorPage[EnvironmentInfo]\n\n#### Files\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.environments import EnvironmentFile\n```\n\nMethods:\n\n- client.beta.agents.environments.files.create(environment_id, \\*\\*params) -> EnvironmentFile\n- client.beta.agents.environments.files.list(environment_id, \\*\\*params) -> SyncTokenPage[EnvironmentFile]\n\n#### Templates\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.environments import EnvironmentTemplate, EnvironmentTemplateDeleted\n```\n\nMethods:\n\n- client.beta.agents.environments.templates.create(\\*\\*params) -> EnvironmentTemplate\n- client.beta.agents.environments.templates.retrieve(environment_template_id) -> EnvironmentTemplate\n- client.beta.agents.environments.templates.update(environment_template_id, \\*\\*params) -> EnvironmentTemplate\n- client.beta.agents.environments.templates.list(\\*\\*params) -> SyncCursorPage[EnvironmentTemplate]\n- client.beta.agents.environments.templates.delete(environment_template_id) -> EnvironmentTemplateDeleted\n\n### Vaults\n\nTypes:\n\n```python\nfrom openai.types.beta.agents import Vault, VaultDeleted, VaultStatus, VaultStatusFilterParam\n```\n\nMethods:\n\n- client.beta.agents.vaults.create(\\*\\*params) -> Vault\n- client.beta.agents.vaults.retrieve(vault_id) -> Vault\n- client.beta.agents.vaults.update(vault_id, \\*\\*params) -> Vault\n- client.beta.agents.vaults.list(\\*\\*params) -> SyncCursorPage[Vault]\n- client.beta.agents.vaults.delete(vault_id) -> VaultDeleted\n\n#### Credentials\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.vaults import (\n Credential,\n CredentialAuth,\n CredentialAuthCreateParam,\n CredentialAuthRotateParam,\n CredentialDeleted,\n CredentialNetworking,\n CredentialNetworkingParam,\n McpOauthTokenEndpointAuth,\n McpOauthTokenEndpointAuthCreateParam,\n McpOauthTokenEndpointAuthRotateParam,\n)\n```\n\nMethods:\n\n- client.beta.agents.vaults.credentials.create(vault_id, \\*\\*params) -> Credential\n- client.beta.agents.vaults.credentials.retrieve(credential_id, \\*, vault_id) -> Credential\n- client.beta.agents.vaults.credentials.update(credential_id, \\*, vault_id, \\*\\*params) -> Credential\n- client.beta.agents.vaults.credentials.list(vault_id, \\*\\*params) -> SyncCursorPage[Credential]\n- client.beta.agents.vaults.credentials.delete(credential_id, \\*, vault_id) -> CredentialDeleted\n\n### Sessions\n\nMethods:\n\n- client.beta.agents.sessions.create(\\*\\*params) -> AgentSession\n- client.beta.agents.sessions.retrieve(session_id) -> AgentSession\n- client.beta.agents.sessions.update(session_id, \\*\\*params) -> AgentSession\n- client.beta.agents.sessions.list(\\*\\*params) -> SyncCursorPage[AgentSession]\n- client.beta.agents.sessions.delete(session_id) -> AgentSessionDeleted\n\n#### Subagents\n\nMethods:\n\n- client.beta.agents.sessions.subagents.retrieve(subagent_id, \\*, session_id) -> Subagent\n- client.beta.agents.sessions.subagents.list(session_id, \\*\\*params) -> SyncCursorPage[Subagent]\n\n##### Items\n\nMethods:\n\n- client.beta.agents.sessions.subagents.items.list(subagent_id, \\*, session_id, \\*\\*params) -> SyncCursorPage[AgentSessionItem]\n\n##### Turns\n\nMethods:\n\n- client.beta.agents.sessions.subagents.turns.retrieve(turn_id, \\*, session_id, subagent_id) -> Turn\n- client.beta.agents.sessions.subagents.turns.list(subagent_id, \\*, session_id, \\*\\*params) -> SyncCursorPage[Turn]\n\n###### Items\n\nMethods:\n\n- client.beta.agents.sessions.subagents.turns.items.list(turn_id, \\*, session_id, subagent_id, \\*\\*params) -> SyncCursorPage[AgentSessionItem]\n\n#### Artifacts\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.sessions import SessionArtifact, SessionArtifactDeleted\n```\n\nMethods:\n\n- client.beta.agents.sessions.artifacts.retrieve(artifact_id, \\*, session_id) -> SessionArtifact\n- client.beta.agents.sessions.artifacts.list(session_id, \\*\\*params) -> SyncCursorPage[SessionArtifact]\n- client.beta.agents.sessions.artifacts.delete(artifact_id, \\*, session_id) -> SessionArtifactDeleted\n- client.beta.agents.sessions.artifacts.content(artifact_id, \\*, session_id) -> HttpxBinaryResponseContent\n\n#### Items\n\nMethods:\n\n- client.beta.agents.sessions.items.list(session_id, \\*\\*params) -> SyncCursorPage[AgentSessionItem]\n\n#### Events\n\nMethods:\n\n- client.beta.agents.sessions.events.create(session_id, \\*\\*params) -> None\n- client.beta.agents.sessions.events.stream(session_id) -> AgentSessionEvent\n\n#### Traces\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.sessions import SessionTrace\n```\n\nMethods:\n\n- client.beta.agents.sessions.traces.list(session_id, \\*\\*params) -> SyncCursorPage[SessionTrace]\n\n#### Turns\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.sessions import Turn\n```\n\nMethods:\n\n- client.beta.agents.sessions.turns.retrieve(turn_id, \\*, session_id) -> Turn\n- client.beta.agents.sessions.turns.list(session_id, \\*\\*params) -> SyncCursorPage[Turn]\n\n##### Items\n\nMethods:\n\n- client.beta.agents.sessions.turns.items.list(turn_id, \\*, session_id, \\*\\*params) -> SyncConversationCursorPage[AgentSessionItem]\n\n## Responses\n\nTypes:\n\n```python\nfrom openai.types.beta import (\n BetaApplyPatchTool,\n BetaCompactedResponse,\n BetaComputerAction,\n BetaComputerActionList,\n BetaComputerTool,\n BetaComputerUsePreviewTool,\n BetaContainerAuto,\n BetaContainerNetworkPolicyAllowlist,\n BetaContainerNetworkPolicyDisabled,\n BetaContainerNetworkPolicyDomainSecret,\n BetaContainerReference,\n BetaCustomTool,\n BetaEasyInputMessage,\n BetaFileSearchTool,\n BetaFunctionShellTool,\n BetaFunctionTool,\n BetaImageDetail,\n BetaInlineSkill,\n BetaInlineSkillSource,\n BetaLocalEnvironment,\n BetaLocalSkill,\n BetaMcpToolCallError,\n BetaNamespaceTool,\n BetaResponse,\n BetaResponseApplyPatchToolCall,\n BetaResponseApplyPatchToolCallOutput,\n BetaResponseAudioDeltaEvent,\n BetaResponseAudioDoneEvent,\n BetaResponseAudioTranscriptDeltaEvent,\n BetaResponseAudioTranscriptDoneEvent,\n BetaResponseCodeInterpreterCallCodeDeltaEvent,\n BetaResponseCodeInterpreterCallCodeDoneEvent,\n BetaResponseCodeInterpreterCallCompletedEvent,\n BetaResponseCodeInterpreterCallInProgressEvent,\n BetaResponseCodeInterpreterCallInterpretingEvent,\n BetaResponseCodeInterpreterToolCall,\n BetaResponseCompactionCompactingEvent,\n BetaResponseCompactionItem,\n BetaResponseCompactionItemParam,\n BetaResponseCompletedEvent,\n BetaResponseComputerToolCall,\n BetaResponseComputerToolCallOutputItem,\n BetaResponseComputerToolCallOutputScreenshot,\n BetaResponseConfigurationUpdateItem,\n BetaResponseConfigurationUpdateItemParam,\n BetaResponseContainerReference,\n BetaResponseContent,\n BetaResponseContentPartAddedEvent,\n BetaResponseContentPartDoneEvent,\n BetaResponseConversationParam,\n BetaResponseCreatedEvent,\n BetaResponseCustomToolCall,\n BetaResponseCustomToolCallInputDeltaEvent,\n BetaResponseCustomToolCallInputDoneEvent,\n BetaResponseCustomToolCallItem,\n BetaResponseCustomToolCallOutput,\n BetaResponseCustomToolCallOutputItem,\n BetaResponseError,\n BetaResponseErrorEvent,\n BetaResponseFailedEvent,\n BetaResponseFileSearchCallCompletedEvent,\n BetaResponseFileSearchCallInProgressEvent,\n BetaResponseFileSearchCallSearchingEvent,\n BetaResponseFileSearchToolCall,\n BetaResponseFormatTextConfig,\n BetaResponseFormatTextJSONSchemaConfig,\n BetaResponseFunctionCallArgumentsDeltaEvent,\n BetaResponseFunctionCallArgumentsDoneEvent,\n BetaResponseFunctionCallOutputItem,\n BetaResponseFunctionCallOutputItemList,\n BetaResponseFunctionShellCallOutputContent,\n BetaResponseFunctionShellToolCall,\n BetaResponseFunctionShellToolCallOutput,\n BetaResponseFunctionToolCall,\n BetaResponseFunctionToolCallItem,\n BetaResponseFunctionToolCallOutputItem,\n BetaResponseFunctionWebSearch,\n BetaResponseImageGenCallCompletedEvent,\n BetaResponseImageGenCallGeneratingEvent,\n BetaResponseImageGenCallInProgressEvent,\n BetaResponseImageGenCallPartialImageEvent,\n BetaResponseInProgressEvent,\n BetaResponseIn"},"items":[{"name":"api.md","path":"api.md","rawUrl":"https://raw.githubusercontent.com/openai/openai-python/HEAD/api.md","title":"API Interface Contract & Specifications","category":"project-spec","format":"markdown","content":"# Shared Types\n\n```python\nfrom openai.types import (\n AllModels,\n ChatModel,\n ComparisonFilter,\n CompoundFilter,\n CustomToolInputFormat,\n DecisionInputJSON,\n DecisionQuestionInputImage,\n DecisionQuestionInputPart,\n DecisionQuestionInputText,\n ErrorObject,\n FunctionDefinition,\n FunctionParameters,\n Metadata,\n OAuthErrorCode,\n Reasoning,\n ReasoningEffort,\n ResponseFormatJSONObject,\n ResponseFormatJSONSchema,\n ResponseFormatText,\n ResponseFormatTextGrammar,\n ResponseFormatTextPython,\n ResponsesModel,\n)\n```\n\n# Decisions\n\nTypes:\n\n```python\nfrom openai.types import (\n Decision,\n DecisionInputImageParam,\n DecisionInputMessageParam,\n DecisionInputPartUnionParam,\n DecisionInputTextParam,\n DecisionPromptCacheBreakpointParam,\n)\n```\n\nMethods:\n\n- client.decisions.create(\\*\\*params) -> Decision\n\n# Completions\n\nTypes:\n\n```python\nfrom openai.types import Completion, CompletionChoice, CompletionUsage\n```\n\nMethods:\n\n- client.completions.create(\\*\\*params) -> Completion\n\n# Chat\n\nTypes:\n\n```python\nfrom openai.types import ChatModel\n```\n\n## Completions\n\nTypes:\n\n```python\nfrom openai.types.chat import (\n ChatCompletionAllowedToolsParam,\n ChatCompletion,\n ChatCompletionAllowedToolChoiceParam,\n ChatCompletionAssistantMessageParam,\n ChatCompletionAudio,\n ChatCompletionAudioParam,\n ChatCompletionChunk,\n ChatCompletionContentPartParam,\n ChatCompletionContentPartImage,\n ChatCompletionContentPartInputAudioParam,\n ChatCompletionContentPartRefusalParam,\n ChatCompletionContentPartText,\n ChatCompletionCustomToolParam,\n ChatCompletionDeleted,\n ChatCompletionDeveloperMessageParam,\n ChatCompletionFunctionCallOptionParam,\n ChatCompletionFunctionMessageParam,\n ChatCompletionFunctionTool,\n ChatCompletionMessage,\n ChatCompletionMessageCustomToolCall,\n ChatCompletionMessageFunctionToolCall,\n ChatCompletionMessageParam,\n ChatCompletionMessageToolCallUnion,\n ChatCompletionModality,\n ChatCompletionNamedToolChoiceParam,\n ChatCompletionNamedToolChoiceCustomParam,\n ChatCompletionPredictionContentParam,\n ChatCompletionRole,\n ChatCompletionStoreMessage,\n ChatCompletionStreamOptionsParam,\n ChatCompletionSystemMessageParam,\n ChatCompletionTokenLogprob,\n ChatCompletionToolUnionParam,\n ChatCompletionToolChoiceOptionParam,\n ChatCompletionToolMessageParam,\n ChatCompletionUserMessageParam,\n ChatCompletionReasoningEffort,\n)\n```\n\nMethods:\n\n- client.chat.completions.create(\\*\\*params) -> ChatCompletion\n- client.chat.completions.retrieve(completion_id) -> ChatCompletion\n- client.chat.completions.update(completion_id, \\*\\*params) -> ChatCompletion\n- client.chat.completions.list(\\*\\*params) -> SyncCursorPage[ChatCompletion]\n- client.chat.completions.delete(completion_id) -> ChatCompletionDeleted\n\n### Messages\n\nMethods:\n\n- client.chat.completions.messages.list(completion_id, \\*\\*params) -> SyncCursorPage[ChatCompletionStoreMessage]\n\n# Embeddings\n\nTypes:\n\n```python\nfrom openai.types import CreateEmbeddingResponse, Embedding, EmbeddingModel\n```\n\nMethods:\n\n- client.embeddings.create(\\*\\*params) -> CreateEmbeddingResponse\n\n# Files\n\nTypes:\n\n```python\nfrom openai.types import FileContent, FileDeleted, FileObject, FilePurpose\n```\n\nMethods:\n\n- client.files.create(\\*\\*params) -> FileObject\n- client.files.retrieve(file_id) -> FileObject\n- client.files.list(\\*\\*params) -> SyncCursorPage[FileObject]\n- client.files.delete(file_id) -> FileDeleted\n- client.files.content(file_id) -> HttpxBinaryResponseContent\n- client.files.retrieve_content(file_id) -> str\n- client.files.wait_for_processing(\\*args) -> FileObject\n\n# Images\n\nTypes:\n\n```python\nfrom openai.types import (\n Image,\n ImageEditCompletedEvent,\n ImageEditPartialImageEvent,\n ImageEditStreamEvent,\n ImageGenCompletedEvent,\n ImageGenPartialImageEvent,\n ImageGenStreamEvent,\n ImageModel,\n ImagesResponse,\n)\n```\n\nMethods:\n\n- client.images.create_variation(\\*\\*params) -> ImagesResponse\n- client.images.edit(\\*\\*params) -> ImagesResponse\n- client.images.generate(\\*\\*params) -> ImagesResponse\n\n# ContentProvenanceChecks\n\nTypes:\n\n```python\nfrom openai.types import ContentProvenanceCheck\n```\n\nMethods:\n\n- client.content_provenance_checks.create(\\*\\*params) -> ContentProvenanceCheck\n\n# Audio\n\nTypes:\n\n```python\nfrom openai.types import AudioModel, AudioResponseFormat\n```\n\n## Transcriptions\n\nTypes:\n\n```python\nfrom openai.types.audio import (\n Transcription,\n TranscriptionDiarized,\n TranscriptionDiarizedSegment,\n TranscriptionInclude,\n TranscriptionLanguage,\n TranscriptionSegment,\n TranscriptionStreamEvent,\n TranscriptionTextDeltaEvent,\n TranscriptionTextDoneEvent,\n TranscriptionTextSegmentEvent,\n TranscriptionVerbose,\n TranscriptionWord,\n TranscriptionCreateResponse,\n)\n```\n\nMethods:\n\n- client.audio.transcriptions.create(\\*\\*params) -> TranscriptionCreateResponse\n\n## Translations\n\nTypes:\n\n```python\nfrom openai.types.audio import Translation, TranslationVerbose, TranslationCreateResponse\n```\n\nMethods:\n\n- client.audio.translations.create(\\*\\*params) -> TranslationCreateResponse\n\n## Speech\n\nTypes:\n\n```python\nfrom openai.types.audio import SpeechModel\n```\n\nMethods:\n\n- client.audio.speech.create(\\*\\*params) -> HttpxBinaryResponseContent\n\n## Voices\n\nTypes:\n\n```python\nfrom openai.types.audio import Voice\n```\n\nMethods:\n\n- client.audio.voices.create(\\*\\*params) -> Voice\n\n## VoiceConsents\n\nTypes:\n\n```python\nfrom openai.types.audio import VoiceConsent, VoiceConsentDeleted\n```\n\nMethods:\n\n- client.audio.voice_consents.create(\\*\\*params) -> VoiceConsent\n- client.audio.voice_consents.retrieve(consent_id) -> VoiceConsent\n- client.audio.voice_consents.update(consent_id, \\*\\*params) -> VoiceConsent\n- client.audio.voice_consents.list(\\*\\*params) -> SyncCursorPage[VoiceConsent]\n- client.audio.voice_consents.delete(consent_id) -> VoiceConsentDeleted\n\n# Moderations\n\nTypes:\n\n```python\nfrom openai.types import (\n Moderation,\n ModerationImageURLInputParam,\n ModerationModel,\n ModerationMultiModalInputParam,\n ModerationTextInputParam,\n ModerationCreateResponse,\n)\n```\n\nMethods:\n\n- client.moderations.create(\\*\\*params) -> ModerationCreateResponse\n\n# Models\n\nTypes:\n\n```python\nfrom openai.types import Model, ModelDeleted\n```\n\nMethods:\n\n- client.models.retrieve(model) -> Model\n- client.models.list() -> SyncPage[Model]\n- client.models.delete(model) -> ModelDeleted\n\n# FineTuning\n\n## Methods\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning import (\n DpoHyperparameters,\n DpoMethod,\n ReinforcementHyperparameters,\n ReinforcementMethod,\n SupervisedHyperparameters,\n SupervisedMethod,\n)\n```\n\n## Jobs\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning import (\n FineTuningJob,\n FineTuningJobEvent,\n FineTuningJobWandbIntegration,\n FineTuningJobWandbIntegrationObject,\n FineTuningJobIntegration,\n)\n```\n\nMethods:\n\n- client.fine_tuning.jobs.create(\\*\\*params) -> FineTuningJob\n- client.fine_tuning.jobs.retrieve(fine_tuning_job_id) -> FineTuningJob\n- client.fine_tuning.jobs.list(\\*\\*params) -> SyncCursorPage[FineTuningJob]\n- client.fine_tuning.jobs.cancel(fine_tuning_job_id) -> FineTuningJob\n- client.fine_tuning.jobs.list_events(fine_tuning_job_id, \\*\\*params) -> SyncCursorPage[FineTuningJobEvent]\n- client.fine_tuning.jobs.pause(fine_tuning_job_id) -> FineTuningJob\n- client.fine_tuning.jobs.resume(fine_tuning_job_id) -> FineTuningJob\n\n### Checkpoints\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning.jobs import FineTuningJobCheckpoint\n```\n\nMethods:\n\n- client.fine_tuning.jobs.checkpoints.list(fine_tuning_job_id, \\*\\*params) -> SyncCursorPage[FineTuningJobCheckpoint]\n\n## Checkpoints\n\n### Permissions\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning.checkpoints import (\n PermissionCreateResponse,\n PermissionRetrieveResponse,\n PermissionListResponse,\n PermissionDeleteResponse,\n)\n```\n\nMethods:\n\n- client.fine_tuning.checkpoints.permissions.create(fine_tuned_model_checkpoint, \\*\\*params) -> SyncPage[PermissionCreateResponse]\n- client.fine_tuning.checkpoints.permissions.retrieve(fine_tuned_model_checkpoint, \\*\\*params) -> PermissionRetrieveResponse\n- client.fine_tuning.checkpoints.permissions.list(fine_tuned_model_checkpoint, \\*\\*params) -> SyncConversationCursorPage[PermissionListResponse]\n- client.fine_tuning.checkpoints.permissions.delete(permission_id, \\*, fine_tuned_model_checkpoint) -> PermissionDeleteResponse\n\n## Alpha\n\n### Graders\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning.alpha import GraderRunResponse, GraderValidateResponse\n```\n\nMethods:\n\n- client.fine_tuning.alpha.graders.run(\\*\\*params) -> GraderRunResponse\n- client.fine_tuning.alpha.graders.validate(\\*\\*params) -> GraderValidateResponse\n\n# Graders\n\n## GraderModels\n\nTypes:\n\n```python\nfrom openai.types.graders import (\n GraderInputs,\n LabelModelGrader,\n MultiGrader,\n PythonGrader,\n ScoreModelGrader,\n StringCheckGrader,\n TextSimilarityGrader,\n)\n```\n\n# VectorStores\n\nTypes:\n\n```python\nfrom openai.types import (\n AutoFileChunkingStrategyParam,\n FileChunkingStrategy,\n FileChunkingStrategyParam,\n OtherFileChunkingStrategyObject,\n StaticFileChunkingStrategy,\n StaticFileChunkingStrategyObject,\n StaticFileChunkingStrategyObjectParam,\n VectorStore,\n VectorStoreDeleted,\n VectorStoreSearchResponse,\n)\n```\n\nMethods:\n\n- client.vector_stores.create(\\*\\*params) -> VectorStore\n- client.vector_stores.retrieve(vector_store_id) -> VectorStore\n- client.vector_stores.update(vector_store_id, \\*\\*params) -> VectorStore\n- client.vector_stores.list(\\*\\*params) -> SyncCursorPage[VectorStore]\n- client.vector_stores.delete(vector_store_id) -> VectorStoreDeleted\n- client.vector_stores.search(vector_store_id, \\*\\*params) -> SyncPage[VectorStoreSearchResponse]\n\n## Files\n\nTypes:\n\n```python\nfrom openai.types.vector_stores import VectorStoreFile, VectorStoreFileDeleted, FileContentResponse\n```\n\nMethods:\n\n- client.vector_stores.files.create(vector_store_id, \\*\\*params) -> VectorStoreFile\n- client.vector_stores.files.retrieve(file_id, \\*, vector_store_id) -> VectorStoreFile\n- client.vector_stores.files.update(file_id, \\*, vector_store_id, \\*\\*params) -> VectorStoreFile\n- client.vector_stores.files.list(vector_store_id, \\*\\*params) -> SyncCursorPage[VectorStoreFile]\n- client.vector_stores.files.delete(file_id, \\*, vector_store_id) -> VectorStoreFileDeleted\n- client.vector_stores.files.content(file_id, \\*, vector_store_id) -> SyncPage[FileContentResponse]\n- client.vector_stores.files.create_and_poll(\\*args) -> VectorStoreFile\n- client.vector_stores.files.poll(\\*args) -> VectorStoreFile\n- client.vector_stores.files.upload(\\*args) -> VectorStoreFile\n- client.vector_stores.files.upload_and_poll(\\*args) -> VectorStoreFile\n\n## FileBatches\n\nTypes:\n\n```python\nfrom openai.types.vector_stores import VectorStoreFileBatch\n```\n\nMethods:\n\n- client.vector_stores.file_batches.create(vector_store_id, \\*\\*params) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.retrieve(batch_id, \\*, vector_store_id) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.cancel(batch_id, \\*, vector_store_id) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.list_files(batch_id, \\*, vector_store_id, \\*\\*params) -> SyncCursorPage[VectorStoreFile]\n- client.vector_stores.file_batches.create_and_poll(\\*args) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.poll(\\*args) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.upload_and_poll(\\*args) -> VectorStoreFileBatch\n\n# Safety\n\n## Alerts\n\nTypes:\n\n```python\nfrom openai.types.safety import SafetyAlert\n```\n\nMethods:\n\n- client.safety.alerts.retrieve(id) -> SafetyAlert\n\n# Safety\n\n## Cases\n\nTypes:\n\n```python\nfrom openai.types.safety import SafetyCase\n```\n\nMethods:\n\n- client.safety.cases.retrieve(id) -> SafetyCase\n\n## Alerts\n\nTypes:\n\n```python\nfrom openai.types.safety import SafetyAlert\n```\n\nMethods:\n\n- client.safety.alerts.retrieve(id) -> SafetyAlert\n\n# [Webhooks](src/openai/resources/webhooks/api.md)\n\nMethods:\n\n- client.webhooks.unwrap(payload, headers, \\*, secret) -> UnwrapWebhookEvent\n- client.webhooks.verify_signature(payload, headers, \\*, secret, tolerance) -> None\n\n# Beta\n\n## Agents\n\nTypes:\n\n```python\nfrom openai.types.beta import (\n Agent,\n AgentBrowserAuthenticationCancelParam,\n AgentBrowserAuthenticationSubmitParam,\n AgentBrowserOriginAccessParam,\n AgentCloseSubagentCallItem,\n AgentCommandExecutionItem,\n AgentContent,\n AgentCreateSubagentCallItem,\n AgentDeleted,\n AgentFunctionCallItem,\n AgentFunctionCallOutput,\n AgentFunctionCallOutputParam,\n AgentFunctionCallStatus,\n AgentInterruptSubagentCallItem,\n AgentMcpCallItem,\n AgentOutputCommandExecutionOutputDeltaEvent,\n AgentOutputItem,\n AgentOutputItemStatus,\n AgentReasoning,\n AgentReasoningItem,\n AgentReasoningParam,\n AgentResumeSubagentCallItem,\n AgentSendSubagentInputCallItem,\n AgentSession,\n AgentSessionAssistantMessage,\n AgentSessionCreatedEvent,\n AgentSessionDeleted,\n AgentSessionEnvironmentConnectedEvent,\n AgentSessionEnvironmentDisconnectedEvent,\n AgentSessionEnvironmentExpiredEvent,\n AgentSessionEnvironmentFailedEvent,\n AgentSessionEnvironmentPendingEvent,\n AgentSessionEnvironmentReadyEvent,\n AgentSessionEnvironmentResetEvent,\n AgentSessionEnvironmentState,\n AgentSessionEnvironmentSuspendedEvent,\n AgentSessionErrorEvent,\n AgentSessionEvent,\n AgentSessionFailedEvent,\n AgentSessionIdleEvent,\n AgentSessionInProgressEvent,\n AgentSessionInputMessageParam,\n AgentSessionInputParam,\n AgentSessionItem,\n AgentSessionMessage,\n AgentSessionMessageContent,\n AgentSessionRequiresActionEvent,\n AgentSessionSubagentActiveEvent,\n AgentSessionSubagentClosedEvent,\n AgentSessionSubagentCreatedEvent,\n AgentSessionTurnCancelledEvent,\n AgentSessionTurnCompletedEvent,\n AgentSessionTurnContentPartAddedEvent,\n AgentSessionTurnContentPartDoneEvent,\n AgentSessionTurnCreatedEvent,\n AgentSessionTurnFailedEvent,\n AgentSessionTurnInProgressEvent,\n AgentSessionTurnItemAddedEvent,\n AgentSessionTurnItemDoneEvent,\n AgentSessionTurnOutputTextDeltaEvent,\n AgentSessionTurnOutputTextDoneEvent,\n AgentSessionTurnReasoningSummaryPartAddedEvent,\n AgentSessionTurnReasoningSummaryPartDoneEvent,\n AgentSessionTurnReasoningSummaryTextDeltaEvent,\n AgentSessionTurnReasoningSummaryTextDoneEvent,\n AgentText,\n AgentTextParam,\n AgentTool,\n AgentToolParam,\n AgentWaitForSubagentsCallItem,\n AgentWebSearchCallItem,\n Environment,\n EnvironmentParam,\n HostedEnvironmentFile,\n HostedEnvironmentFileID,\n HostedEnvironmentFileParam,\n HostedPlugin,\n HostedPluginParam,\n HostedSkill,\n HostedSkillParam,\n HostedSkillReference,\n InlineCapabilitySourceParam,\n InputContent,\n InputContentParam,\n McpTransport,\n McpTransportParam,\n MultiAgentConfig,\n MultiAgentConfigParam,\n OutputText,\n PersistedAgentTool,\n PersistedAgentToolParam,\n PersistedMcpTransport,\n PersistedMcpTransportParam,\n SessionError,\n SessionTurnError,\n SetupCommandParam,\n Subagent,\n SummaryText,\n TextFormat,\n TextFormatParam,\n TokenUsage,\n WebSearchAction,\n)\n```\n\nMethods:\n\n- client.beta.agents.create(\\*\\*params) -> Agent\n- client.beta.agents.retrieve(agent_id) -> Agent\n- client.beta.agents.update(agent_id, \\*\\*params) -> Agent\n- client.beta.agents.list(\\*\\*params) -> SyncCursorPage[Agent]\n- client.beta.agents.delete(agent_id) -> AgentDeleted\n\n### Environments\n\nTypes:\n\n```python\nfrom openai.types.beta.agents import EnvironmentInfo\n```\n\nMethods:\n\n- client.beta.agents.environments.create(\\*\\*params) -> EnvironmentInfo\n- client.beta.agents.environments.retrieve(environment_id) -> EnvironmentInfo\n- client.beta.agents.environments.list(\\*\\*params) -> SyncCursorPage[EnvironmentInfo]\n\n#### Files\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.environments import EnvironmentFile\n```\n\nMethods:\n\n- client.beta.agents.environments.files.create(environment_id, \\*\\*params) -> EnvironmentFile\n- client.beta.agents.environments.files.list(environment_id, \\*\\*params) -> SyncTokenPage[EnvironmentFile]\n\n#### Templates\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.environments import EnvironmentTemplate, EnvironmentTemplateDeleted\n```\n\nMethods:\n\n- client.beta.agents.environments.templates.create(\\*\\*params) -> EnvironmentTemplate\n- client.beta.agents.environments.templates.retrieve(environment_template_id) -> EnvironmentTemplate\n- client.beta.agents.environments.templates.update(environment_template_id, \\*\\*params) -> EnvironmentTemplate\n- client.beta.agents.environments.templates.list(\\*\\*params) -> SyncCursorPage[EnvironmentTemplate]\n- client.beta.agents.environments.templates.delete(environment_template_id) -> EnvironmentTemplateDeleted\n\n### Vaults\n\nTypes:\n\n```python\nfrom openai.types.beta.agents import Vault, VaultDeleted, VaultStatus, VaultStatusFilterParam\n```\n\nMethods:\n\n- client.beta.agents.vaults.create(\\*\\*params) -> Vault\n- client.beta.agents.vaults.retrieve(vault_id) -> Vault\n- client.beta.agents.vaults.update(vault_id, \\*\\*params) -> Vault\n- client.beta.agents.vaults.list(\\*\\*params) -> SyncCursorPage[Vault]\n- client.beta.agents.vaults.delete(vault_id) -> VaultDeleted\n\n#### Credentials\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.vaults import (\n Credential,\n CredentialAuth,\n CredentialAuthCreateParam,\n CredentialAuthRotateParam,\n CredentialDeleted,\n CredentialNetworking,\n CredentialNetworkingParam,\n McpOauthTokenEndpointAuth,\n McpOauthTokenEndpointAuthCreateParam,\n McpOauthTokenEndpointAuthRotateParam,\n)\n```\n\nMethods:\n\n- client.beta.agents.vaults.credentials.create(vault_id, \\*\\*params) -> Credential\n- client.beta.agents.vaults.credentials.retrieve(credential_id, \\*, vault_id) -> Credential\n- client.beta.agents.vaults.credentials.update(credential_id, \\*, vault_id, \\*\\*params) -> Credential\n- client.beta.agents.vaults.credentials.list(vault_id, \\*\\*params) -> SyncCursorPage[Credential]\n- client.beta.agents.vaults.credentials.delete(credential_id, \\*, vault_id) -> CredentialDeleted\n\n### Sessions\n\nMethods:\n\n- client.beta.agents.sessions.create(\\*\\*params) -> AgentSession\n- client.beta.agents.sessions.retrieve(session_id) -> AgentSession\n- client.beta.agents.sessions.update(session_id, \\*\\*params) -> AgentSession\n- client.beta.agents.sessions.list(\\*\\*params) -> SyncCursorPage[AgentSession]\n- client.beta.agents.sessions.delete(session_id) -> AgentSessionDeleted\n\n#### Subagents\n\nMethods:\n\n- client.beta.agents.sessions.subagents.retrieve(subagent_id, \\*, session_id) -> Subagent\n- client.beta.agents.sessions.subagents.list(session_id, \\*\\*params) -> SyncCursorPage[Subagent]\n\n##### Items\n\nMethods:\n\n- client.beta.agents.sessions.subagents.items.list(subagent_id, \\*, session_id, \\*\\*params) -> SyncCursorPage[AgentSessionItem]\n\n##### Turns\n\nMethods:\n\n- client.beta.agents.sessions.subagents.turns.retrieve(turn_id, \\*, session_id, subagent_id) -> Turn\n- client.beta.agents.sessions.subagents.turns.list(subagent_id, \\*, session_id, \\*\\*params) -> SyncCursorPage[Turn]\n\n###### Items\n\nMethods:\n\n- client.beta.agents.sessions.subagents.turns.items.list(turn_id, \\*, session_id, subagent_id, \\*\\*params) -> SyncCursorPage[AgentSessionItem]\n\n#### Artifacts\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.sessions import SessionArtifact, SessionArtifactDeleted\n```\n\nMethods:\n\n- client.beta.agents.sessions.artifacts.retrieve(artifact_id, \\*, session_id) -> SessionArtifact\n- client.beta.agents.sessions.artifacts.list(session_id, \\*\\*params) -> SyncCursorPage[SessionArtifact]\n- client.beta.agents.sessions.artifacts.delete(artifact_id, \\*, session_id) -> SessionArtifactDeleted\n- client.beta.agents.sessions.artifacts.content(artifact_id, \\*, session_id) -> HttpxBinaryResponseContent\n\n#### Items\n\nMethods:\n\n- client.beta.agents.sessions.items.list(session_id, \\*\\*params) -> SyncCursorPage[AgentSessionItem]\n\n#### Events\n\nMethods:\n\n- client.beta.agents.sessions.events.create(session_id, \\*\\*params) -> None\n- client.beta.agents.sessions.events.stream(session_id) -> AgentSessionEvent\n\n#### Traces\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.sessions import SessionTrace\n```\n\nMethods:\n\n- client.beta.agents.sessions.traces.list(session_id, \\*\\*params) -> SyncCursorPage[SessionTrace]\n\n#### Turns\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.sessions import Turn\n```\n\nMethods:\n\n- client.beta.agents.sessions.turns.retrieve(turn_id, \\*, session_id) -> Turn\n- client.beta.agents.sessions.turns.list(session_id, \\*\\*params) -> SyncCursorPage[Turn]\n\n##### Items\n\nMethods:\n\n- client.beta.agents.sessions.turns.items.list(turn_id, \\*, session_id, \\*\\*params) -> SyncConversationCursorPage[AgentSessionItem]\n\n## Responses\n\nTypes:\n\n```python\nfrom openai.types.beta import (\n BetaApplyPatchTool,\n BetaCompactedResponse,\n BetaComputerAction,\n BetaComputerActionList,\n BetaComputerTool,\n BetaComputerUsePreviewTool,\n BetaContainerAuto,\n BetaContainerNetworkPolicyAllowlist,\n BetaContainerNetworkPolicyDisabled,\n BetaContainerNetworkPolicyDomainSecret,\n BetaContainerReference,\n BetaCustomTool,\n BetaEasyInputMessage,\n BetaFileSearchTool,\n BetaFunctionShellTool,\n BetaFunctionTool,\n BetaImageDetail,\n BetaInlineSkill,\n BetaInlineSkillSource,\n BetaLocalEnvironment,\n BetaLocalSkill,\n BetaMcpToolCallError,\n BetaNamespaceTool,\n BetaResponse,\n BetaResponseApplyPatchToolCall,\n BetaResponseApplyPatchToolCallOutput,\n BetaResponseAudioDeltaEvent,\n BetaResponseAudioDoneEvent,\n BetaResponseAudioTranscriptDeltaEvent,\n BetaResponseAudioTranscriptDoneEvent,\n BetaResponseCodeInterpreterCallCodeDeltaEvent,\n BetaResponseCodeInterpreterCallCodeDoneEvent,\n BetaResponseCodeInterpreterCallCompletedEvent,\n BetaResponseCodeInterpreterCallInProgressEvent,\n BetaResponseCodeInterpreterCallInterpretingEvent,\n BetaResponseCodeInterpreterToolCall,\n BetaResponseCompactionCompactingEvent,\n BetaResponseCompactionItem,\n BetaResponseCompactionItemParam,\n BetaResponseCompletedEvent,\n BetaResponseComputerToolCall,\n BetaResponseComputerToolCallOutputItem,\n BetaResponseComputerToolCallOutputScreenshot,\n BetaResponseConfigurationUpdateItem,\n BetaResponseConfigurationUpdateItemParam,\n BetaResponseContainerReference,\n BetaResponseContent,\n BetaResponseContentPartAddedEvent,\n BetaResponseContentPartDoneEvent,\n BetaResponseConversationParam,\n BetaResponseCreatedEvent,\n BetaResponseCustomToolCall,\n BetaResponseCustomToolCallInputDeltaEvent,\n BetaResponseCustomToolCallInputDoneEvent,\n BetaResponseCustomToolCallItem,\n BetaResponseCustomToolCallOutput,\n BetaResponseCustomToolCallOutputItem,\n BetaResponseError,\n BetaResponseErrorEvent,\n BetaResponseFailedEvent,\n BetaResponseFileSearchCallCompletedEvent,\n BetaResponseFileSearchCallInProgressEvent,\n BetaResponseFileSearchCallSearchingEvent,\n BetaResponseFileSearchToolCall,\n BetaResponseFormatTextConfig,\n BetaResponseFormatTextJSONSchemaConfig,\n BetaResponseFunctionCallArgumentsDeltaEvent,\n BetaResponseFunctionCallArgumentsDoneEvent,\n BetaResponseFunctionCallOutputItem,\n BetaResponseFunctionCallOutputItemList,\n BetaResponseFunctionShellCallOutputContent,\n BetaResponseFunctionShellToolCall,\n BetaResponseFunctionShellToolCallOutput,\n BetaResponseFunctionToolCall,\n BetaResponseFunctionToolCallItem,\n BetaResponseFunctionToolCallOutputItem,\n BetaResponseFunctionWebSearch,\n BetaResponseImageGenCallCompletedEvent,\n BetaResponseImageGenCallGeneratingEvent,\n BetaResponseImageGenCallInProgressEvent,\n BetaResponseImageGenCallPartialImageEvent,\n BetaResponseInProgressEvent,\n BetaResponseIn","isInternal":false,"tokens":13014,"sizeBytes":50000}],"systemPromptSnippet":"\n\n# Shared Types\n\n```python\nfrom openai.types import (\n AllModels,\n ChatModel,\n ComparisonFilter,\n CompoundFilter,\n CustomToolInputFormat,\n DecisionInputJSON,\n DecisionQuestionInputImage,\n DecisionQuestionInputPart,\n DecisionQuestionInputText,\n ErrorObject,\n FunctionDefinition,\n FunctionParameters,\n Metadata,\n OAuthErrorCode,\n Reasoning,\n ReasoningEffort,\n ResponseFormatJSONObject,\n ResponseFormatJSONSchema,\n ResponseFormatText,\n ResponseFormatTextGrammar,\n ResponseFormatTextPython,\n ResponsesModel,\n)\n```\n\n# Decisions\n\nTypes:\n\n```python\nfrom openai.types import (\n Decision,\n DecisionInputImageParam,\n DecisionInputMessageParam,\n DecisionInputPartUnionParam,\n DecisionInputTextParam,\n DecisionPromptCacheBreakpointParam,\n)\n```\n\nMethods:\n\n- client.decisions.create(\\*\\*params) -> Decision\n\n# Completions\n\nTypes:\n\n```python\nfrom openai.types import Completion, CompletionChoice, CompletionUsage\n```\n\nMethods:\n\n- client.completions.create(\\*\\*params) -> Completion\n\n# Chat\n\nTypes:\n\n```python\nfrom openai.types import ChatModel\n```\n\n## Completions\n\nTypes:\n\n```python\nfrom openai.types.chat import (\n ChatCompletionAllowedToolsParam,\n ChatCompletion,\n ChatCompletionAllowedToolChoiceParam,\n ChatCompletionAssistantMessageParam,\n ChatCompletionAudio,\n ChatCompletionAudioParam,\n ChatCompletionChunk,\n ChatCompletionContentPartParam,\n ChatCompletionContentPartImage,\n ChatCompletionContentPartInputAudioParam,\n ChatCompletionContentPartRefusalParam,\n ChatCompletionContentPartText,\n ChatCompletionCustomToolParam,\n ChatCompletionDeleted,\n ChatCompletionDeveloperMessageParam,\n ChatCompletionFunctionCallOptionParam,\n ChatCompletionFunctionMessageParam,\n ChatCompletionFunctionTool,\n ChatCompletionMessage,\n ChatCompletionMessageCustomToolCall,\n ChatCompletionMessageFunctionToolCall,\n ChatCompletionMessageParam,\n ChatCompletionMessageToolCallUnion,\n ChatCompletionModality,\n ChatCompletionNamedToolChoiceParam,\n ChatCompletionNamedToolChoiceCustomParam,\n ChatCompletionPredictionContentParam,\n ChatCompletionRole,\n ChatCompletionStoreMessage,\n ChatCompletionStreamOptionsParam,\n ChatCompletionSystemMessageParam,\n ChatCompletionTokenLogprob,\n ChatCompletionToolUnionParam,\n ChatCompletionToolChoiceOptionParam,\n ChatCompletionToolMessageParam,\n ChatCompletionUserMessageParam,\n ChatCompletionReasoningEffort,\n)\n```\n\nMethods:\n\n- client.chat.completions.create(\\*\\*params) -> ChatCompletion\n- client.chat.completions.retrieve(completion_id) -> ChatCompletion\n- client.chat.completions.update(completion_id, \\*\\*params) -> ChatCompletion\n- client.chat.completions.list(\\*\\*params) -> SyncCursorPage[ChatCompletion]\n- client.chat.completions.delete(completion_id) -> ChatCompletionDeleted\n\n### Messages\n\nMethods:\n\n- client.chat.completions.messages.list(completion_id, \\*\\*params) -> SyncCursorPage[ChatCompletionStoreMessage]\n\n# Embeddings\n\nTypes:\n\n```python\nfrom openai.types import CreateEmbeddingResponse, Embedding, EmbeddingModel\n```\n\nMethods:\n\n- client.embeddings.create(\\*\\*params) -> CreateEmbeddingResponse\n\n# Files\n\nTypes:\n\n```python\nfrom openai.types import FileContent, FileDeleted, FileObject, FilePurpose\n```\n\nMethods:\n\n- client.files.create(\\*\\*params) -> FileObject\n- client.files.retrieve(file_id) -> FileObject\n- client.files.list(\\*\\*params) -> SyncCursorPage[FileObject]\n- client.files.delete(file_id) -> FileDeleted\n- client.files.content(file_id) -> HttpxBinaryResponseContent\n- client.files.retrieve_content(file_id) -> str\n- client.files.wait_for_processing(\\*args) -> FileObject\n\n# Images\n\nTypes:\n\n```python\nfrom openai.types import (\n Image,\n ImageEditCompletedEvent,\n ImageEditPartialImageEvent,\n ImageEditStreamEvent,\n ImageGenCompletedEvent,\n ImageGenPartialImageEvent,\n ImageGenStreamEvent,\n ImageModel,\n ImagesResponse,\n)\n```\n\nMethods:\n\n- client.images.create_variation(\\*\\*params) -> ImagesResponse\n- client.images.edit(\\*\\*params) -> ImagesResponse\n- client.images.generate(\\*\\*params) -> ImagesResponse\n\n# ContentProvenanceChecks\n\nTypes:\n\n```python\nfrom openai.types import ContentProvenanceCheck\n```\n\nMethods:\n\n- client.content_provenance_checks.create(\\*\\*params) -> ContentProvenanceCheck\n\n# Audio\n\nTypes:\n\n```python\nfrom openai.types import AudioModel, AudioResponseFormat\n```\n\n## Transcriptions\n\nTypes:\n\n```python\nfrom openai.types.audio import (\n Transcription,\n TranscriptionDiarized,\n TranscriptionDiarizedSegment,\n TranscriptionInclude,\n TranscriptionLanguage,\n TranscriptionSegment,\n TranscriptionStreamEvent,\n TranscriptionTextDeltaEvent,\n TranscriptionTextDoneEvent,\n TranscriptionTextSegmentEvent,\n TranscriptionVerbose,\n TranscriptionWord,\n TranscriptionCreateResponse,\n)\n```\n\nMethods:\n\n- client.audio.transcriptions.create(\\*\\*params) -> TranscriptionCreateResponse\n\n## Translations\n\nTypes:\n\n```python\nfrom openai.types.audio import Translation, TranslationVerbose, TranslationCreateResponse\n```\n\nMethods:\n\n- client.audio.translations.create(\\*\\*params) -> TranslationCreateResponse\n\n## Speech\n\nTypes:\n\n```python\nfrom openai.types.audio import SpeechModel\n```\n\nMethods:\n\n- client.audio.speech.create(\\*\\*params) -> HttpxBinaryResponseContent\n\n## Voices\n\nTypes:\n\n```python\nfrom openai.types.audio import Voice\n```\n\nMethods:\n\n- client.audio.voices.create(\\*\\*params) -> Voice\n\n## VoiceConsents\n\nTypes:\n\n```python\nfrom openai.types.audio import VoiceConsent, VoiceConsentDeleted\n```\n\nMethods:\n\n- client.audio.voice_consents.create(\\*\\*params) -> VoiceConsent\n- client.audio.voice_consents.retrieve(consent_id) -> VoiceConsent\n- client.audio.voice_consents.update(consent_id, \\*\\*params) -> VoiceConsent\n- client.audio.voice_consents.list(\\*\\*params) -> SyncCursorPage[VoiceConsent]\n- client.audio.voice_consents.delete(consent_id) -> VoiceConsentDeleted\n\n# Moderations\n\nTypes:\n\n```python\nfrom openai.types import (\n Moderation,\n ModerationImageURLInputParam,\n ModerationModel,\n ModerationMultiModalInputParam,\n ModerationTextInputParam,\n ModerationCreateResponse,\n)\n```\n\nMethods:\n\n- client.moderations.create(\\*\\*params) -> ModerationCreateResponse\n\n# Models\n\nTypes:\n\n```python\nfrom openai.types import Model, ModelDeleted\n```\n\nMethods:\n\n- client.models.retrieve(model) -> Model\n- client.models.list() -> SyncPage[Model]\n- client.models.delete(model) -> ModelDeleted\n\n# FineTuning\n\n## Methods\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning import (\n DpoHyperparameters,\n DpoMethod,\n ReinforcementHyperparameters,\n ReinforcementMethod,\n SupervisedHyperparameters,\n SupervisedMethod,\n)\n```\n\n## Jobs\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning import (\n FineTuningJob,\n FineTuningJobEvent,\n FineTuningJobWandbIntegration,\n FineTuningJobWandbIntegrationObject,\n FineTuningJobIntegration,\n)\n```\n\nMethods:\n\n- client.fine_tuning.jobs.create(\\*\\*params) -> FineTuningJob\n- client.fine_tuning.jobs.retrieve(fine_tuning_job_id) -> FineTuningJob\n- client.fine_tuning.jobs.list(\\*\\*params) -> SyncCursorPage[FineTuningJob]\n- client.fine_tuning.jobs.cancel(fine_tuning_job_id) -> FineTuningJob\n- client.fine_tuning.jobs.list_events(fine_tuning_job_id, \\*\\*params) -> SyncCursorPage[FineTuningJobEvent]\n- client.fine_tuning.jobs.pause(fine_tuning_job_id) -> FineTuningJob\n- client.fine_tuning.jobs.resume(fine_tuning_job_id) -> FineTuningJob\n\n### Checkpoints\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning.jobs import FineTuningJobCheckpoint\n```\n\nMethods:\n\n- client.fine_tuning.jobs.checkpoints.list(fine_tuning_job_id, \\*\\*params) -> SyncCursorPage[FineTuningJobCheckpoint]\n\n## Checkpoints\n\n### Permissions\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning.checkpoints import (\n PermissionCreateResponse,\n PermissionRetrieveResponse,\n PermissionListResponse,\n PermissionDeleteResponse,\n)\n```\n\nMethods:\n\n- client.fine_tuning.checkpoints.permissions.create(fine_tuned_model_checkpoint, \\*\\*params) -> SyncPage[PermissionCreateResponse]\n- client.fine_tuning.checkpoints.permissions.retrieve(fine_tuned_model_checkpoint, \\*\\*params) -> PermissionRetrieveResponse\n- client.fine_tuning.checkpoints.permissions.list(fine_tuned_model_checkpoint, \\*\\*params) -> SyncConversationCursorPage[PermissionListResponse]\n- client.fine_tuning.checkpoints.permissions.delete(permission_id, \\*, fine_tuned_model_checkpoint) -> PermissionDeleteResponse\n\n## Alpha\n\n### Graders\n\nTypes:\n\n```python\nfrom openai.types.fine_tuning.alpha import GraderRunResponse, GraderValidateResponse\n```\n\nMethods:\n\n- client.fine_tuning.alpha.graders.run(\\*\\*params) -> GraderRunResponse\n- client.fine_tuning.alpha.graders.validate(\\*\\*params) -> GraderValidateResponse\n\n# Graders\n\n## GraderModels\n\nTypes:\n\n```python\nfrom openai.types.graders import (\n GraderInputs,\n LabelModelGrader,\n MultiGrader,\n PythonGrader,\n ScoreModelGrader,\n StringCheckGrader,\n TextSimilarityGrader,\n)\n```\n\n# VectorStores\n\nTypes:\n\n```python\nfrom openai.types import (\n AutoFileChunkingStrategyParam,\n FileChunkingStrategy,\n FileChunkingStrategyParam,\n OtherFileChunkingStrategyObject,\n StaticFileChunkingStrategy,\n StaticFileChunkingStrategyObject,\n StaticFileChunkingStrategyObjectParam,\n VectorStore,\n VectorStoreDeleted,\n VectorStoreSearchResponse,\n)\n```\n\nMethods:\n\n- client.vector_stores.create(\\*\\*params) -> VectorStore\n- client.vector_stores.retrieve(vector_store_id) -> VectorStore\n- client.vector_stores.update(vector_store_id, \\*\\*params) -> VectorStore\n- client.vector_stores.list(\\*\\*params) -> SyncCursorPage[VectorStore]\n- client.vector_stores.delete(vector_store_id) -> VectorStoreDeleted\n- client.vector_stores.search(vector_store_id, \\*\\*params) -> SyncPage[VectorStoreSearchResponse]\n\n## Files\n\nTypes:\n\n```python\nfrom openai.types.vector_stores import VectorStoreFile, VectorStoreFileDeleted, FileContentResponse\n```\n\nMethods:\n\n- client.vector_stores.files.create(vector_store_id, \\*\\*params) -> VectorStoreFile\n- client.vector_stores.files.retrieve(file_id, \\*, vector_store_id) -> VectorStoreFile\n- client.vector_stores.files.update(file_id, \\*, vector_store_id, \\*\\*params) -> VectorStoreFile\n- client.vector_stores.files.list(vector_store_id, \\*\\*params) -> SyncCursorPage[VectorStoreFile]\n- client.vector_stores.files.delete(file_id, \\*, vector_store_id) -> VectorStoreFileDeleted\n- client.vector_stores.files.content(file_id, \\*, vector_store_id) -> SyncPage[FileContentResponse]\n- client.vector_stores.files.create_and_poll(\\*args) -> VectorStoreFile\n- client.vector_stores.files.poll(\\*args) -> VectorStoreFile\n- client.vector_stores.files.upload(\\*args) -> VectorStoreFile\n- client.vector_stores.files.upload_and_poll(\\*args) -> VectorStoreFile\n\n## FileBatches\n\nTypes:\n\n```python\nfrom openai.types.vector_stores import VectorStoreFileBatch\n```\n\nMethods:\n\n- client.vector_stores.file_batches.create(vector_store_id, \\*\\*params) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.retrieve(batch_id, \\*, vector_store_id) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.cancel(batch_id, \\*, vector_store_id) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.list_files(batch_id, \\*, vector_store_id, \\*\\*params) -> SyncCursorPage[VectorStoreFile]\n- client.vector_stores.file_batches.create_and_poll(\\*args) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.poll(\\*args) -> VectorStoreFileBatch\n- client.vector_stores.file_batches.upload_and_poll(\\*args) -> VectorStoreFileBatch\n\n# Safety\n\n## Alerts\n\nTypes:\n\n```python\nfrom openai.types.safety import SafetyAlert\n```\n\nMethods:\n\n- client.safety.alerts.retrieve(id) -> SafetyAlert\n\n# Safety\n\n## Cases\n\nTypes:\n\n```python\nfrom openai.types.safety import SafetyCase\n```\n\nMethods:\n\n- client.safety.cases.retrieve(id) -> SafetyCase\n\n## Alerts\n\nTypes:\n\n```python\nfrom openai.types.safety import SafetyAlert\n```\n\nMethods:\n\n- client.safety.alerts.retrieve(id) -> SafetyAlert\n\n# [Webhooks](src/openai/resources/webhooks/api.md)\n\nMethods:\n\n- client.webhooks.unwrap(payload, headers, \\*, secret) -> UnwrapWebhookEvent\n- client.webhooks.verify_signature(payload, headers, \\*, secret, tolerance) -> None\n\n# Beta\n\n## Agents\n\nTypes:\n\n```python\nfrom openai.types.beta import (\n Agent,\n AgentBrowserAuthenticationCancelParam,\n AgentBrowserAuthenticationSubmitParam,\n AgentBrowserOriginAccessParam,\n AgentCloseSubagentCallItem,\n AgentCommandExecutionItem,\n AgentContent,\n AgentCreateSubagentCallItem,\n AgentDeleted,\n AgentFunctionCallItem,\n AgentFunctionCallOutput,\n AgentFunctionCallOutputParam,\n AgentFunctionCallStatus,\n AgentInterruptSubagentCallItem,\n AgentMcpCallItem,\n AgentOutputCommandExecutionOutputDeltaEvent,\n AgentOutputItem,\n AgentOutputItemStatus,\n AgentReasoning,\n AgentReasoningItem,\n AgentReasoningParam,\n AgentResumeSubagentCallItem,\n AgentSendSubagentInputCallItem,\n AgentSession,\n AgentSessionAssistantMessage,\n AgentSessionCreatedEvent,\n AgentSessionDeleted,\n AgentSessionEnvironmentConnectedEvent,\n AgentSessionEnvironmentDisconnectedEvent,\n AgentSessionEnvironmentExpiredEvent,\n AgentSessionEnvironmentFailedEvent,\n AgentSessionEnvironmentPendingEvent,\n AgentSessionEnvironmentReadyEvent,\n AgentSessionEnvironmentResetEvent,\n AgentSessionEnvironmentState,\n AgentSessionEnvironmentSuspendedEvent,\n AgentSessionErrorEvent,\n AgentSessionEvent,\n AgentSessionFailedEvent,\n AgentSessionIdleEvent,\n AgentSessionInProgressEvent,\n AgentSessionInputMessageParam,\n AgentSessionInputParam,\n AgentSessionItem,\n AgentSessionMessage,\n AgentSessionMessageContent,\n AgentSessionRequiresActionEvent,\n AgentSessionSubagentActiveEvent,\n AgentSessionSubagentClosedEvent,\n AgentSessionSubagentCreatedEvent,\n AgentSessionTurnCancelledEvent,\n AgentSessionTurnCompletedEvent,\n AgentSessionTurnContentPartAddedEvent,\n AgentSessionTurnContentPartDoneEvent,\n AgentSessionTurnCreatedEvent,\n AgentSessionTurnFailedEvent,\n AgentSessionTurnInProgressEvent,\n AgentSessionTurnItemAddedEvent,\n AgentSessionTurnItemDoneEvent,\n AgentSessionTurnOutputTextDeltaEvent,\n AgentSessionTurnOutputTextDoneEvent,\n AgentSessionTurnReasoningSummaryPartAddedEvent,\n AgentSessionTurnReasoningSummaryPartDoneEvent,\n AgentSessionTurnReasoningSummaryTextDeltaEvent,\n AgentSessionTurnReasoningSummaryTextDoneEvent,\n AgentText,\n AgentTextParam,\n AgentTool,\n AgentToolParam,\n AgentWaitForSubagentsCallItem,\n AgentWebSearchCallItem,\n Environment,\n EnvironmentParam,\n HostedEnvironmentFile,\n HostedEnvironmentFileID,\n HostedEnvironmentFileParam,\n HostedPlugin,\n HostedPluginParam,\n HostedSkill,\n HostedSkillParam,\n HostedSkillReference,\n InlineCapabilitySourceParam,\n InputContent,\n InputContentParam,\n McpTransport,\n McpTransportParam,\n MultiAgentConfig,\n MultiAgentConfigParam,\n OutputText,\n PersistedAgentTool,\n PersistedAgentToolParam,\n PersistedMcpTransport,\n PersistedMcpTransportParam,\n SessionError,\n SessionTurnError,\n SetupCommandParam,\n Subagent,\n SummaryText,\n TextFormat,\n TextFormatParam,\n TokenUsage,\n WebSearchAction,\n)\n```\n\nMethods:\n\n- client.beta.agents.create(\\*\\*params) -> Agent\n- client.beta.agents.retrieve(agent_id) -> Agent\n- client.beta.agents.update(agent_id, \\*\\*params) -> Agent\n- client.beta.agents.list(\\*\\*params) -> SyncCursorPage[Agent]\n- client.beta.agents.delete(agent_id) -> AgentDeleted\n\n### Environments\n\nTypes:\n\n```python\nfrom openai.types.beta.agents import EnvironmentInfo\n```\n\nMethods:\n\n- client.beta.agents.environments.create(\\*\\*params) -> EnvironmentInfo\n- client.beta.agents.environments.retrieve(environment_id) -> EnvironmentInfo\n- client.beta.agents.environments.list(\\*\\*params) -> SyncCursorPage[EnvironmentInfo]\n\n#### Files\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.environments import EnvironmentFile\n```\n\nMethods:\n\n- client.beta.agents.environments.files.create(environment_id, \\*\\*params) -> EnvironmentFile\n- client.beta.agents.environments.files.list(environment_id, \\*\\*params) -> SyncTokenPage[EnvironmentFile]\n\n#### Templates\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.environments import EnvironmentTemplate, EnvironmentTemplateDeleted\n```\n\nMethods:\n\n- client.beta.agents.environments.templates.create(\\*\\*params) -> EnvironmentTemplate\n- client.beta.agents.environments.templates.retrieve(environment_template_id) -> EnvironmentTemplate\n- client.beta.agents.environments.templates.update(environment_template_id, \\*\\*params) -> EnvironmentTemplate\n- client.beta.agents.environments.templates.list(\\*\\*params) -> SyncCursorPage[EnvironmentTemplate]\n- client.beta.agents.environments.templates.delete(environment_template_id) -> EnvironmentTemplateDeleted\n\n### Vaults\n\nTypes:\n\n```python\nfrom openai.types.beta.agents import Vault, VaultDeleted, VaultStatus, VaultStatusFilterParam\n```\n\nMethods:\n\n- client.beta.agents.vaults.create(\\*\\*params) -> Vault\n- client.beta.agents.vaults.retrieve(vault_id) -> Vault\n- client.beta.agents.vaults.update(vault_id, \\*\\*params) -> Vault\n- client.beta.agents.vaults.list(\\*\\*params) -> SyncCursorPage[Vault]\n- client.beta.agents.vaults.delete(vault_id) -> VaultDeleted\n\n#### Credentials\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.vaults import (\n Credential,\n CredentialAuth,\n CredentialAuthCreateParam,\n CredentialAuthRotateParam,\n CredentialDeleted,\n CredentialNetworking,\n CredentialNetworkingParam,\n McpOauthTokenEndpointAuth,\n McpOauthTokenEndpointAuthCreateParam,\n McpOauthTokenEndpointAuthRotateParam,\n)\n```\n\nMethods:\n\n- client.beta.agents.vaults.credentials.create(vault_id, \\*\\*params) -> Credential\n- client.beta.agents.vaults.credentials.retrieve(credential_id, \\*, vault_id) -> Credential\n- client.beta.agents.vaults.credentials.update(credential_id, \\*, vault_id, \\*\\*params) -> Credential\n- client.beta.agents.vaults.credentials.list(vault_id, \\*\\*params) -> SyncCursorPage[Credential]\n- client.beta.agents.vaults.credentials.delete(credential_id, \\*, vault_id) -> CredentialDeleted\n\n### Sessions\n\nMethods:\n\n- client.beta.agents.sessions.create(\\*\\*params) -> AgentSession\n- client.beta.agents.sessions.retrieve(session_id) -> AgentSession\n- client.beta.agents.sessions.update(session_id, \\*\\*params) -> AgentSession\n- client.beta.agents.sessions.list(\\*\\*params) -> SyncCursorPage[AgentSession]\n- client.beta.agents.sessions.delete(session_id) -> AgentSessionDeleted\n\n#### Subagents\n\nMethods:\n\n- client.beta.agents.sessions.subagents.retrieve(subagent_id, \\*, session_id) -> Subagent\n- client.beta.agents.sessions.subagents.list(session_id, \\*\\*params) -> SyncCursorPage[Subagent]\n\n##### Items\n\nMethods:\n\n- client.beta.agents.sessions.subagents.items.list(subagent_id, \\*, session_id, \\*\\*params) -> SyncCursorPage[AgentSessionItem]\n\n##### Turns\n\nMethods:\n\n- client.beta.agents.sessions.subagents.turns.retrieve(turn_id, \\*, session_id, subagent_id) -> Turn\n- client.beta.agents.sessions.subagents.turns.list(subagent_id, \\*, session_id, \\*\\*params) -> SyncCursorPage[Turn]\n\n###### Items\n\nMethods:\n\n- client.beta.agents.sessions.subagents.turns.items.list(turn_id, \\*, session_id, subagent_id, \\*\\*params) -> SyncCursorPage[AgentSessionItem]\n\n#### Artifacts\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.sessions import SessionArtifact, SessionArtifactDeleted\n```\n\nMethods:\n\n- client.beta.agents.sessions.artifacts.retrieve(artifact_id, \\*, session_id) -> SessionArtifact\n- client.beta.agents.sessions.artifacts.list(session_id, \\*\\*params) -> SyncCursorPage[SessionArtifact]\n- client.beta.agents.sessions.artifacts.delete(artifact_id, \\*, session_id) -> SessionArtifactDeleted\n- client.beta.agents.sessions.artifacts.content(artifact_id, \\*, session_id) -> HttpxBinaryResponseContent\n\n#### Items\n\nMethods:\n\n- client.beta.agents.sessions.items.list(session_id, \\*\\*params) -> SyncCursorPage[AgentSessionItem]\n\n#### Events\n\nMethods:\n\n- client.beta.agents.sessions.events.create(session_id, \\*\\*params) -> None\n- client.beta.agents.sessions.events.stream(session_id) -> AgentSessionEvent\n\n#### Traces\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.sessions import SessionTrace\n```\n\nMethods:\n\n- client.beta.agents.sessions.traces.list(session_id, \\*\\*params) -> SyncCursorPage[SessionTrace]\n\n#### Turns\n\nTypes:\n\n```python\nfrom openai.types.beta.agents.sessions import Turn\n```\n\nMethods:\n\n- client.beta.agents.sessions.turns.retrieve(turn_id, \\*, session_id) -> Turn\n- client.beta.agents.sessions.turns.list(session_id, \\*\\*params) -> SyncCursorPage[Turn]\n\n##### Items\n\nMethods:\n\n- client.beta.agents.sessions.turns.items.list(turn_id, \\*, session_id, \\*\\*params) -> SyncConversationCursorPage[AgentSessionItem]\n\n## Responses\n\nTypes:\n\n```python\nfrom openai.types.beta import (\n BetaApplyPatchTool,\n BetaCompactedResponse,\n BetaComputerAction,\n BetaComputerActionList,\n BetaComputerTool,\n BetaComputerUsePreviewTool,\n BetaContainerAuto,\n BetaContainerNetworkPolicyAllowlist,\n BetaContainerNetworkPolicyDisabled,\n BetaContainerNetworkPolicyDomainSecret,\n BetaContainerReference,\n BetaCustomTool,\n BetaEasyInputMessage,\n BetaFileSearchTool,\n BetaFunctionShellTool,\n BetaFunctionTool,\n BetaImageDetail,\n BetaInlineSkill,\n BetaInlineSkillSource,\n BetaLocalEnvironment,\n BetaLocalSkill,\n BetaMcpToolCallError,\n BetaNamespaceTool,\n BetaResponse,\n BetaResponseApplyPatchToolCall,\n BetaResponseApplyPatchToolCallOutput,\n BetaResponseAudioDeltaEvent,\n BetaResponseAudioDoneEvent,\n BetaResponseAudioTranscriptDeltaEvent,\n BetaResponseAudioTranscriptDoneEvent,\n BetaResponseCodeInterpreterCallCodeDeltaEvent,\n BetaResponseCodeInterpreterCallCodeDoneEvent,\n BetaResponseCodeInterpreterCallCompletedEvent,\n BetaResponseCodeInterpreterCallInProgressEvent,\n BetaResponseCodeInterpreterCallInterpretingEvent,\n BetaResponseCodeInterpreterToolCall,\n BetaResponseCompactionCompactingEvent,\n BetaResponseCompactionItem,\n BetaResponseCompactionItemParam,\n BetaResponseCompletedEvent,\n BetaResponseComputerToolCall,\n BetaResponseComputerToolCallOutputItem,\n BetaResponseComputerToolCallOutputScreenshot,\n BetaResponseConfigurationUpdateItem,\n BetaResponseConfigurationUpdateItemParam,\n BetaResponseContainerReference,\n BetaResponseContent,\n BetaResponseContentPartAddedEvent,\n BetaResponseContentPartDoneEvent,\n BetaResponseConversationParam,\n BetaResponseCreatedEvent,\n BetaResponseCustomToolCall,\n BetaResponseCustomToolCallInputDeltaEvent,\n BetaResponseCustomToolCallInputDoneEvent,\n BetaResponseCustomToolCallItem,\n BetaResponseCustomToolCallOutput,\n BetaResponseCustomToolCallOutputItem,\n BetaResponseError,\n BetaResponseErrorEvent,\n BetaResponseFailedEvent,\n BetaResponseFileSearchCallCompletedEvent,\n BetaResponseFileSearchCallInProgressEvent,\n BetaResponseFileSearchCallSearchingEvent,\n BetaResponseFileSearchToolCall,\n BetaResponseFormatTextConfig,\n BetaResponseFormatTextJSONSchemaConfig,\n BetaResponseFunctionCallArgumentsDeltaEvent,\n BetaResponseFunctionCallArgumentsDoneEvent,\n BetaResponseFunctionCallOutputItem,\n BetaResponseFunctionCallOutputItemList,\n BetaResponseFunctionShellCallOutputContent,\n BetaResponseFunctionShellToolCall,\n BetaResponseFunctionShellToolCallOutput,\n BetaResponseFunctionToolCall,\n BetaResponseFunctionToolCallItem,\n BetaResponseFunctionToolCallOutputItem,\n BetaResponseFunctionWebSearch,\n BetaResponseImageGenCallCompletedEvent,\n BetaResponseImageGenCallGeneratingEvent,\n BetaResponseImageGenCallInProgressEvent,\n BetaResponseImageGenCallPartialImageEvent,\n BetaResponseInProgressEvent,\n BetaResponseIn\n"}