The official Python library for the OpenAI API
# Shared Types
```python
from openai.types import (
AllModels,
ChatModel,
ComparisonFilter,
CompoundFilter,
CustomToolInputFormat,
DecisionInputJSON,
DecisionQuestionInputImage,
DecisionQuestionInputPart,
DecisionQuestionInputText,
ErrorObject,
FunctionDefinition,
FunctionParameters,
Metadata,
OAuthErrorCode,
Reasoning,
ReasoningEffort,
ResponseFormatJSONObject,
ResponseFormatJSONSchema,
ResponseFormatText,
ResponseFormatTextGrammar,
ResponseFormatTextPython,
ResponsesModel,
)
```
# Decisions
Types:
```python
from openai.types import (
Decision,
DecisionInputImageParam,
DecisionInputMessageParam,
DecisionInputPartUnionParam,
DecisionInputTextParam,
DecisionPromptCacheBreakpointParam,
)
```
Methods:
- <code title="post /decisions">client.decisions.<a href="./src/openai/resources/decisions.py">create</a>(\*\*<a href="src/openai/types/decision_create_params.py">params</a>) -> <a href="./src/openai/types/decision.py">Decision</a></code>
# Completions
Types:
```python
from openai.types import Completion, CompletionChoice, CompletionUsage
```
Methods:
- <code title="post /completions">client.completions.<a href="./src/openai/resources/completions.py">create</a>(\*\*<a href="src/openai/types/completion_create_params.py">params</a>) -> <a href="./src/openai/types/completion.py">Completion</a></code>
# Chat
Types:
```python
from openai.types import ChatModel
```
## Completions
Types:
```python
from openai.types.chat import (
ChatCompletionAllowedToolsParam,
ChatCompletion,
ChatCompletionAllowedToolChoiceParam,
ChatCompletionAssistantMessageParam,
ChatCompletionAudio,
ChatCompletionAudioParam,
ChatCompletionChunk,
ChatCompletionContentPartParam,
ChatCompletionContentPartImage,
ChatCompletionContentPartInputAudioParam,
ChatCompletionContentPartRefusalParam,
ChatCompletionContentPartText,
ChatCompletionCustomToolParam,
ChatCompletionDeleted,
ChatCompletionDeveloperMessageParam,
ChatCompletionFunctionCallOptionParam,
ChatCompletionFunctionMessageParam,
ChatCompletionFunctionTool,
ChatCompletionMessage,
ChatCompletionMessageCustomToolCall,
ChatCompletionMessageFunctionToolCall,
ChatCompletionMessageParam,
ChatCompletionMessageToolCallUnion,
ChatCompletionModality,
ChatCompletionNamedToolChoiceParam,
ChatCompletionNamedToolChoiceCustomParam,
ChatCompletionPredictionContentParam,
ChatCompletionRole,
ChatCompletionStoreMessage,
ChatCompletionStreamOptionsParam,
ChatCompletionSystemMessageParam,
ChatCompletionTokenLogprob,
ChatCompletionToolUnionParam,
ChatCompletionToolChoiceOptionParam,
ChatCompletionToolMessageParam,
ChatCompletionUserMessageParam,
ChatCompletionReasoningEffort,
)
```
Methods:
- <code title="post /chat/completions">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">create</a>(\*\*<a href="src/openai/types/chat/completion_create_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion.py">ChatCompletion</a></code>
- <code title="get /chat/completions/{completion_id}">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">retrieve</a>(completion_id) -> <a href="./src/openai/types/chat/chat_completion.py">ChatCompletion</a></code>
- <code title="post /chat/completions/{completion_id}">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">update</a>(completion_id, \*\*<a href="src/openai/types/chat/completion_update_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion.py">ChatCompletion</a></code>
- <code title="get /chat/completions">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">list</a>(\*\*<a href="src/openai/types/chat/completion_list_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion.py">SyncCursorPage[ChatCompletion]</a></code>
- <code title="delete /chat/completions/{completion_id}">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">delete</a>(completion_id) -> <a href="./src/openai/types/chat/chat_completion_deleted.py">ChatCompletionDeleted</a></code>
### Messages
Methods:
- <code title="get /chat/completions/{completion_id}/messages">client.chat.completions.messages.<a href="./src/openai/resources/chat/completions/messages.py">list</a>(completion_id, \*\*<a href="src/openai/types/chat/completions/message_list_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion_store_message.py">SyncCursorPage[ChatCompletionStoreMessage]</a></code>
# Embeddings
Types:
```python
from openai.types import CreateEmbeddingResponse, Embedding, EmbeddingModel
```
Methods:
- <code title="post /embeddings">client.embeddings.<a href="./src/openai/resources/embeddings.py">create</a>(\*\*<a href="src/openai/types/embedding_create_params.py">params</a>) -> <a href="./src/openai/types/create_embedding_response.py">CreateEmbeddingResponse</a></code>
# Files
Types:
```python
from openai.types import FileContent, FileDeleted, FileObject, FilePurpose
```
Methods:
- <code title="post /files">client.files.<a href="./src/openai/resources/files.py">create</a>(\*\*<a href="src/openai/types/file_create_params.py">params</a>) -> <a href="./src/openai/types/file_object.py">FileObject</a></code>
- <code title="get /files/{file_id}">client.files.<a href="./src/openai/resources/files.py">retrieve</a>(file_id) -> <a href="./src/openai/types/file_object.py">FileObject</a></code>
- <code title="get /files">client.files.<a href="./src/openai/resources/files.py">list</a>(\*\*<a href="src/openai/types/file_list_params.py">params</a>) -> <a href="./src/openai/types/file_object.py">SyncCursorPage[FileObject]</a></code>
- <code title="delete /files/{file_id}">client.files.<a href="./src/openai/resources/files.py">delete</a>(file_id) -> <a href="./src/openai/types/file_deleted.py">FileDeleted</a></code>
- <code title="get /files/{file_id}/content">client.files.<a href="./src/openai/resources/files.py">content</a>(file_id) -> HttpxBinaryResponseContent</code>
- <code title="get /files/{file_id}/content">client.files.<a href="./src/openai/resources/files.py">retrieve_content</a>(file_id) -> <a href="./src/openai/types/file_content.py">str</a></code>
- <code>client.files.<a href="./src/openai/resources/files.py">wait_for_processing</a>(\*args) -> FileObject</code>
# Images
Types:
```python
from openai.types import (
Image,
ImageEditCompletedEvent,
ImageEditPartialImageEvent,
ImageEditStreamEvent,
ImageGenCompletedEvent,
ImageGenPartialImageEvent,
ImageGenStreamEvent,
ImageModel,
ImagesResponse,
)
```
Methods:
- <code title="post /images/variations">client.images.<a href="./src/openai/resources/images.py">create_variation</a>(\*\*<a href="src/openai/types/image_create_variation_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code>
- <code title="post /images/edits">client.images.<a href="./src/openai/resources/images.py">edit</a>(\*\*<a href="src/openai/types/image_edit_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code>
- <code title="post /images/generations">client.images.<a href="./src/openai/resources/images.py">generate</a>(\*\*<a href="src/openai/types/image_generate_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code>
# ContentProvenanceChecks
Types:
```python
from openai.types import ContentProvenanceCheck
```
Methods:
- <code title="post /content_provenance_checks">client.content_provenance_checks.<a href="./src/openai/resources/content_provenance_checks.py">create</a>(\*\*<a href="src/openai/types/content_provenance_check_create_params.py">params</a>) -> <a href="./src/openai/types/content_provenance_check.py">ContentProvenanceCheck</a></code>
# Audio
Types:
```python
from openai.types import AudioModel, AudioResponseFormat
```
## Transcriptions
Types:
```python
from openai.types.audio import (
Transcription,
TranscriptionDiarized,
TranscriptionDiarizedSegment,
TranscriptionInclude,
TranscriptionLanguage,
TranscriptionSegment,
TranscriptionStreamEvent,
TranscriptionTextDeltaEvent,
TranscriptionTextDoneEvent,
TranscriptionTextSegmentEvent,
TranscriptionVerbose,
TranscriptionWord,
TranscriptionCreateResponse,
)
```
Methods:
- <code title="post /audio/transcriptions">client.audio.transcriptions.<a href="./src/openai/resources/audio/transcriptions.py">create</a>(\*\*<a href="src/openai/types/audio/transcription_create_params.py">params</a>) -> <a href="./src/openai/types/audio/transcription_create_response.py">TranscriptionCreateResponse</a></code>
## Translations
Types:
```python
from openai.types.audio import Translation, TranslationVerbose, TranslationCreateResponse
```
Methods:
- <code title="post /audio/translations">client.audio.translations.<a href="./src/openai/resources/audio/translations.py">create</a>(\*\*<a href="src/openai/types/audio/translation_create_params.py">params</a>) -> <a href="./src/openai/types/audio/translation_create_response.py">TranslationCreateResponse</a></code>
## Speech
Types:
```python
from openai.types.audio import SpeechModel
```
Methods:
- <code title="post /audio/speech">client.audio.speech.<a href="./src/openai/resources/audio/speech.py">create</a>(\*\*<a href="src/openai/types/audio/speech_create_params.py">params</a>) -> HttpxBinaryResponseContent</code>
## Voices
Types:
```python
from openai.types.audio import Voice
```
Methods:
- <code title="post /audio/voices">client.audio.voices.<a href="./src/openai/resources/audio/voices.py">create</a>(\*\*<a href="src/openai/types/audio/voice_create_params.py">params</a>) -> <a href="./src/openai/types/audio/voice.py">Voice</a></code>
## VoiceConsents
Types:
```python
from openai.types.audio import VoiceConsent, VoiceConsentDeleted
```
Methods:
- <code title="post /audio/voice_consents">client.audio.voice_consents.<a href="./src/openai/resources/audio/voice_consents.py">create</a>(\*\*<a href="src/openai/types/audio/voice_consent_create_params.py">params</a>) -> <a href="./src/openai/types/audio/voice_consent.py">VoiceConsent</a></code>
- <code title="get /audio/voice_consents/{consent_id}">client.audio.voice_consents.<a href="./src/openai/resources/audio/voice_consents.py">retrieve</a>(consent_id) -> <a href="./src/openai/types/audio/voice_consent.py">VoiceConsent</a></code>
- <code title="post /audio/voice_consents/{consent_id}">client.audio.voice_consents.<a href="./src/openai/resources/audio/voice_consents.py">update</a>(consent_id, \*\*<a href="src/openai/types/audio/voice_consent_update_params.py">params</a>) -> <a href="./src/openai/types/audio/voice_consent.py">VoiceConsent</a></code>
- <code title="get /audio/voice_consents">client.audio.voice_consents.<a href="./src/openai/resources/audio/voice_consents.py">list</a>(\*\*<a href="src/openai/types/audio/voice_consent_list_params.py">params</a>) -> <a href="./src/openai/types/audio/voice_consent.py">SyncCursorPage[VoiceConsent]</a></code>
- <code title="delete /audio/voice_consents/{consent_id}">client.audio.voice_consents.<a href="./src/openai/resources/audio/voice_consents.py">delete</a>(consent_id) -> <a href="./src/openai/types/audio/voice_consent_deleted.py">VoiceConsentDeleted</a></code>
# Moderations
Types:
```python
from openai.types import (
Moderation,
ModerationImageURLInputParam,
ModerationModel,
ModerationMultiModalInputParam,
ModerationTextInputParam,
ModerationCreateResponse,
)
```
Methods:
- <code title="post /moderations">client.moderations.<a href="./src/openai/resources/moderations.py">create</a>(\*\*<a href="src/openai/types/moderation_create_params.py">params</a>) -> <a href="./src/openai/types/moderation_create_response.py">ModerationCreateResponse</a></code>
# Models
Types:
```python
from openai.types import Model, ModelDeleted
```
Methods:
- <code title="get /models/{model}">client.models.<a href="./src/openai/resources/models.py">retrieve</a>(model) -> <a href="./src/openai/types/model.py">Model</a></code>
- <code title="get /models">client.models.<a href="./src/openai/resources/models.py">list</a>() -> <a href="./src/openai/types/model.py">SyncPage[Model]</a></code>
- <code title="delete /models/{model}">client.models.<a href="./src/openai/resources/models.py">delete</a>(model) -> <a href="./src/openai/types/model_deleted.py">ModelDeleted</a></code>
# FineTuning
## Methods
Types:
```python
from openai.types.fine_tuning import (
DpoHyperparameters,
DpoMethod,
ReinforcementHyperparameters,
ReinforcementMethod,
SupervisedHyperparameters,
SupervisedMethod,
)
```
## Jobs
Types:
```python
from openai.types.fine_tuning import (
FineTuningJob,
FineTuningJobEvent,
FineTuningJobWandbIntegration,
FineTuningJobWandbIntegrationObject,
FineTuningJobIntegration,
)
```
Methods:
- <code title="post /fine_tuning/jobs">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">create</a>(\*\*<a href="src/openai/types/fine_tuning/job_create_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code>
- <code title="get /fine_tuning/jobs/{fine_tuning_job_id}">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">retrieve</a>(fine_tuning_job_id) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code>
- <code title="get /fine_tuning/jobs">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">list</a>(\*\*<a href="src/openai/types/fine_tuning/job_list_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">SyncCursorPage[FineTuningJob]</a></code>
- <code title="post /fine_tuning/jobs/{fine_tuning_job_id}/cancel">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">cancel</a>(fine_tuning_job_id) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code>
- <code title="get /fine_tuning/jobs/{fine_tuning_job_id}/events">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">list_events</a>(fine_tuning_job_id, \*\*<a href="src/openai/types/fine_tuning/job_list_events_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job_event.py">SyncCursorPage[FineTuningJobEvent]</a></code>
- <code title="post /fine_tuning/jobs/{fine_tuning_job_id}/pause">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">pause</a>(fine_tuning_job_id) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code>
- <code title="post /fine_tuning/jobs/{fine_tuning_job_id}/resume">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">resume</a>(fine_tuning_job_id) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code>
### Checkpoints
Types:
```python
from openai.types.fine_tuning.jobs import FineTuningJobCheckpoint
```
Methods:
- <code title="get /fine_tuning/jobs/{fine_tuning_job_id}/checkpoints">client.fine_tuning.jobs.checkpoints.<a href="./src/openai/resources/fine_tuning/jobs/checkpoints.py">list</a>(fine_tuning_job_id, \*\*<a href="src/openai/types/fine_tuning/jobs/checkpoint_list_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/jobs/fine_tuning_job_checkpoint.py">SyncCursorPage[FineTuningJobCheckpoint]</a></code>
## Checkpoints
### Permissions
Types:
```python
from openai.types.fine_tuning.checkpoints import (
PermissionCreateResponse,
PermissionRetrieveResponse,
PermissionListResponse,
PermissionDeleteResponse,
)
```
Methods:
- <code title="post /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions">client.fine_tuning.checkpoints.permissions.<a href="./src/openai/resources/fine_tuning/checkpoints/permissions.py">create</a>(fine_tuned_model_checkpoint, \*\*<a href="src/openai/types/fine_tuning/checkpoints/permission_create_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/checkpoints/permission_create_response.py">SyncPage[PermissionCreateResponse]</a></code>
- <code title="get /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions">client.fine_tuning.checkpoints.permissions.<a href="./src/openai/resources/fine_tuning/checkpoints/permissions.py">retrieve</a>(fine_tuned_model_checkpoint, \*\*<a href="src/openai/types/fine_tuning/checkpoints/permission_retrieve_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/checkpoints/permission_retrieve_response.py">PermissionRetrieveResponse</a></code>
- <code title="get /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions">client.fine_tuning.checkpoints.permissions.<a href="./src/openai/resources/fine_tuning/checkpoints/permissions.py">list</a>(fine_tuned_model_checkpoint, \*\*<a href="src/openai/types/fine_tuning/checkpoints/permission_list_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/checkpoints/permission_list_response.py">SyncConversationCursorPage[PermissionListResponse]</a></code>
- <code title="delete /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}">client.fine_tuning.checkpoints.permissions.<a href="./src/openai/resources/fine_tuning/checkpoints/permissions.py">delete</a>(permission_id, \*, fine_tuned_model_checkpoint) -> <a href="./src/openai/types/fine_tuning/checkpoints/permission_delete_response.py">PermissionDeleteResponse</a></code>
## Alpha
### Graders
Types:
```python
from openai.types.fine_tuning.alpha import GraderRunResponse, GraderValidateResponse
```
Methods:
- <code title="post /fine_tuning/alpha/graders/run">client.fine_tuning.alpha.graders.<a href="./src/openai/resources/fine_tuning/alpha/graders.py">run</a>(\*\*<a href="src/openai/types/fine_tuning/alpha/grader_run_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/alpha/grader_run_response.py">GraderRunResponse</a></code>
- <code title="post /fine_tuning/alpha/graders/validate">client.fine_tuning.alpha.graders.<a href="./src/openai/resources/fine_tuning/alpha/graders.py">validate</a>(\*\*<a href="src/openai/types/fine_tuning/alpha/grader_validate_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/alpha/grader_validate_response.py">GraderValidateResponse</a></code>
# Graders
## GraderModels
Types:
```python
from openai.types.graders import (
GraderInputs,
LabelModelGrader,
MultiGrader,
PythonGrader,
ScoreModelGrader,
StringCheckGrader,
TextSimilarityGrader,
)
```
# VectorStores
Types:
```python
from openai.types import (
AutoFileChunkingStrategyParam,
FileChunkingStrategy,
FileChunkingStrategyParam,
OtherFileChunkingStrategyObject,
StaticFileChunkingStrategy,
StaticFileChunkingStrategyObject,
StaticFileChunkingStrategyObjectParam,
VectorStore,
VectorStoreDeleted,
VectorStoreSearchResponse,
)
```
Methods:
- <code title="post /vector_stores">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">create</a>(\*\*<a href="src/openai/types/vector_store_create_params.py">params</a>) -> <a href="./src/openai/types/vector_store.py">VectorStore</a></code>
- <code title="get /vector_stores/{vector_store_id}">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">retrieve</a>(vector_store_id) -> <a href="./src/openai/types/vector_store.py">VectorStore</a></code>
- <code title="post /vector_stores/{vector_store_id}">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">update</a>(vector_store_id, \*\*<a href="src/openai/types/vector_store_update_params.py">params</a>) -> <a href="./src/openai/types/vector_store.py">VectorStore</a></code>
- <code title="get /vector_stores">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">list</a>(\*\*<a href="src/openai/types/vector_store_list_params.py">params</a>) -> <a href="./src/openai/types/vector_store.py">SyncCursorPage[VectorStore]</a></code>
- <code title="delete /vector_stores/{vector_store_id}">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">delete</a>(vector_store_id) -> <a href="./src/openai/types/vector_store_deleted.py">VectorStoreDeleted</a></code>
- <code title="post /vector_stores/{vector_store_id}/search">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">search</a>(vector_store_id, \*\*<a href="src/openai/types/vector_store_search_params.py">params</a>) -> <a href="./src/openai/types/vector_store_search_response.py">SyncPage[VectorStoreSearchResponse]</a></code>
## Files
Types:
```python
from openai.types.vector_stores import VectorStoreFile, VectorStoreFileDeleted, FileContentResponse
```
Methods:
- <code title="post /vector_stores/{vector_store_id}/files">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">create</a>(vector_store_id, \*\*<a href="src/openai/types/vector_stores/file_create_params.py">params</a>) -> <a href="./src/openai/types/vector_stores/vector_store_file.py">VectorStoreFile</a></code>
- <code title="get /vector_stores/{vector_store_id}/files/{file_id}">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">retrieve</a>(file_id, \*, vector_store_id) -> <a href="./src/openai/types/vector_stores/vector_store_file.py">VectorStoreFile</a></code>
- <code title="post /vector_stores/{vector_store_id}/files/{file_id}">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">update</a>(file_id, \*, vector_store_id, \*\*<a href="src/openai/types/vector_stores/file_update_params.py">params</a>) -> <a href="./src/openai/types/vector_stores/vector_store_file.py">VectorStoreFile</a></code>
- <code title="get /vector_stores/{vector_store_id}/files">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">list</a>(vector_store_id, \*\*<a href="src/openai/types/vector_stores/file_list_params.py">params</a>) -> <a href="./src/openai/types/vector_stores/vector_store_file.py">SyncCursorPage[VectorStoreFile]</a></code>
- <code title="delete /vector_stores/{vector_store_id}/files/{file_id}">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">delete</a>(file_id, \*, vector_store_id) -> <a href="./src/openai/types/vector_stores/vector_store_file_deleted.py">VectorStoreFileDeleted</a></code>
- <code title="get /vector_stores/{vector_store_id}/files/{file_id}/content">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">content</a>(file_id, \*, vector_store_id) -> <a href="./src/openai/types/vector_stores/file_content_response.py">SyncPage[FileContentResponse]</a></code>
- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">create_and_poll</a>(\*args) -> VectorStoreFile</code>
- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">poll</a>(\*args) -> VectorStoreFile</code>
- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">upload</a>(\*args) -> VectorStoreFile</code>
- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">upload_and_poll</a>(\*args) -> VectorStoreFile</code>
## FileBatches
Types:
```python
from openai.types.vector_stores import VectorStoreFileBatch
```
Methods:
- <code title="post /vector_stores/{vector_store_id}/file_batches">client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">create</a>(vector_store_id, \*\*<a href="src/openai/types/vector_stores/file_batch_create_params.py">params</a>) -> <a href="./src/openai/types/vector_stores/vector_store_file_batch.py">VectorStoreFileBatch</a></code>
- <code title="get /vector_stores/{vector_store_id}/file_batches/{batch_id}">client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">retrieve</a>(batch_id, \*, vector_store_id) -> <a href="./src/openai/types/vector_stores/vector_store_file_batch.py">VectorStoreFileBatch</a></code>
- <code title="post /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel">client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">cancel</a>(batch_id, \*, vector_store_id) -> <a href="./src/openai/types/vector_stores/vector_store_file_batch.py">VectorStoreFileBatch</a></code>
- <code title="get /vector_stores/{vector_store_id}/file_batches/{batch_id}/files">client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">list_files</a>(batch_id, \*, vector_store_id, \*\*<a href="src/openai/types/vector_stores/file_batch_list_files_params.py">params</a>) -> <a href="./src/openai/types/vector_stores/vector_store_file.py">SyncCursorPage[VectorStoreFile]</a></code>
- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">create_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">poll</a>(\*args) -> VectorStoreFileBatch</code>
- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">upload_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
# Safety
## Alerts
Types:
```python
from openai.types.safety import SafetyAlert
```
Methods:
- <code title="get /safety/alerts/{id}">client.safety.alerts.<a href="./src/openai/resources/safety/alerts.py">retrieve</a>(id) -> <a href="./src/openai/types/safety/safety_alert.py">SafetyAlert</a></code>
# Safety
## Cases
Types:
```python
from openai.types.safety import SafetyCase
```
Methods:
- <code title="get /safety/cases/{id}">client.safety.cases.<a href="./src/openai/resources/safety/cases.py">retrieve</a>(id) -> <a href="./src/openai/types/safety/safety_case.py">SafetyCase</a></code>
## Alerts
Types:
```python
from openai.types.safety import SafetyAlert
```
Methods:
- <code title="get /safety/alerts/{id}">client.safety.alerts.<a href="./src/openai/resources/safety/alerts.py">retrieve</a>(id) -> <a href="./src/openai/types/safety/safety_alert.py">SafetyAlert</a></code>
# [Webhooks](src/openai/resources/webhooks/api.md)
Methods:
- <code>client.webhooks.<a href="./src/openai/resources/webhooks.py">unwrap</a>(payload, headers, \*, secret) -> UnwrapWebhookEvent</code>
- <code>client.webhooks.<a href="./src/openai/resources/webhooks.py">verify_signature</a>(payload, headers, \*, secret, tolerance) -> None</code>
# Beta
## Agents
Types:
```python
from openai.types.beta import (
Agent,
AgentBrowserAuthenticationCancelParam,
AgentBrowserAuthenticationSubmitParam,
AgentBrowserOriginAccessParam,
AgentCloseSubagentCallItem,
AgentCommandExecutionItem,
AgentContent,
AgentCreateSubagentCallItem,
AgentDeleted,
AgentFunctionCallItem,
AgentFunctionCallOutput,
AgentFunctionCallOutputParam,
AgentFunctionCallStatus,
AgentInterruptSubagentCallItem,
AgentMcpCallItem,
AgentOutputCommandExecutionOutputDeltaEvent,
AgentOutputItem,
AgentOutputItemStatus,
AgentReasoning,
AgentReasoningItem,
AgentReasoningParam,
AgentResumeSubagentCallItem,
AgentSendSubagentInputCallItem,
AgentSession,
AgentSessionAssistantMessage,
AgentSessionCreatedEvent,
AgentSessionDeleted,
AgentSessionEnvironmentConnectedEvent,
AgentSessionEnvironmentDisconnectedEvent,
AgentSessionEnvironmentExpiredEvent,
AgentSessionEnvironmentFailedEvent,
AgentSessionEnvironmentPendingEvent,
AgentSessionEnvironmentReadyEvent,
AgentSessionEnvironmentResetEvent,
AgentSessionEnvironmentState,
AgentSessionEnvironmentSuspendedEvent,
AgentSessionErrorEvent,
AgentSessionEvent,
AgentSessionFailedEvent,
AgentSessionIdleEvent,
AgentSessionInProgressEvent,
AgentSessionInputMessageParam,
AgentSessionInputParam,
AgentSessionItem,
AgentSessionMessage,
AgentSessionMessageContent,
AgentSessionRequiresActionEvent,
AgentSessionSubagentActiveEvent,
AgentSessionSubagentClosedEvent,
AgentSessionSubagentCreatedEvent,
AgentSessionTurnCancelledEvent,
AgentSessionTurnCompletedEvent,
AgentSessionTurnContentPartAddedEvent,
AgentSessionTurnContentPartDoneEvent,
AgentSessionTurnCreatedEvent,
AgentSessionTurnFailedEvent,
AgentSessionTurnInProgressEvent,
AgentSessionTurnItemAddedEvent,
AgentSessionTurnItemDoneEvent,
AgentSessionTurnOutputTextDeltaEvent,
AgentSessionTurnOutputTextDoneEvent,
AgentSessionTurnReasoningSummaryPartAddedEvent,
AgentSessionTurnReasoningSummaryPartDoneEvent,
AgentSessionTurnReasoningSummaryTextDeltaEvent,
AgentSessionTurnReasoningSummaryTextDoneEvent,
AgentText,
AgentTextParam,
AgentTool,
AgentToolParam,
AgentWaitForSubagentsCallItem,
AgentWebSearchCallItem,
Environment,
EnvironmentParam,
HostedEnvironmentFile,
HostedEnvironmentFileID,
HostedEnvironmentFileParam,
HostedPlugin,
HostedPluginParam,
HostedSkill,
HostedSkillParam,
HostedSkillReference,
InlineCapabilitySourceParam,
InputContent,
InputContentParam,
McpTransport,
McpTransportParam,
MultiAgentConfig,
MultiAgentConfigParam,
OutputText,
PersistedAgentTool,
PersistedAgentToolParam,
PersistedMcpTransport,
PersistedMcpTransportParam,
SessionError,
SessionTurnError,
SetupCommandParam,
Subagent,
SummaryText,
TextFormat,
TextFormatParam,
TokenUsage,
WebSearchAction,
)
```
Methods:
- <code title="post /agents">client.beta.agents.<a href="./src/openai/resources/beta/agents/agents.py">create</a>(\*\*<a href="src/openai/types/beta/agent_create_params.py">params</a>) -> <a href="./src/openai/types/beta/agent.py">Agent</a></code>
- <code title="get /agents/{agent_id}">client.beta.agents.<a href="./src/openai/resources/beta/agents/agents.py">retrieve</a>(agent_id) -> <a href="./src/openai/types/beta/agent.py">Agent</a></code>
- <code title="post /agents/{agent_id}">client.beta.agents.<a href="./src/openai/resources/beta/agents/agents.py">update</a>(agent_id, \*\*<a href="src/openai/types/beta/agent_update_params.py">params</a>) -> <a href="./src/openai/types/beta/agent.py">Agent</a></code>
- <code title="get /agents">client.beta.agents.<a href="./src/openai/resources/beta/agents/agents.py">list</a>(\*\*<a href="src/openai/types/beta/agent_list_params.py">params</a>) -> <a href="./src/openai/types/beta/agent.py">SyncCursorPage[Agent]</a></code>
- <code title="delete /agents/{agent_id}">client.beta.agents.<a href="./src/openai/resources/beta/agents/agents.py">delete</a>(agent_id) -> <a href="./src/openai/types/beta/agent_deleted.py">AgentDeleted</a></code>
### Environments
Types:
```python
from openai.types.beta.agents import EnvironmentInfo
```
Methods:
- <code title="post /agents/environments">client.beta.agents.environments.<a href="./src/openai/resources/beta/agents/environments/environments.py">create</a>(\*\*<a href="src/openai/types/beta/agents/environment_create_params.py">params</a>) -> <a href="./src/openai/types/beta/agents/environment_info.py">EnvironmentInfo</a></code>
- <code title="get /agents/environments/{environment_id}">client.beta.agents.environments.<a href="./src/openai/resources/beta/agents/environments/environments.py">retrieve</a>(environment_id) -> <a href="./src/openai/types/beta/agents/environment_info.py">EnvironmentInfo</a></code>
- <code title="get /agents/environments">client.beta.agents.environments.<a href="./src/openai/resources/beta/agents/environments/environments.py">list</a>(\*\*<a href="src/openai/types/beta/agents/environment_list_params.py">params</a>) -> <a href="./src/openai/types/beta/agents/environment_info.py">SyncCursorPage[EnvironmentInfo]</a></code>
#### Files
Types:
```python
from openai.types.beta.agents.environments import EnvironmentFile
```
Methods:
- <code title="post /agents/environments/{environment_id}/files">client.beta.agents.environments.files.<a href="./src/openai/resources/beta/agents/environments/files.py">create</a>(environment_id, \*\*<a href="src/openai/types/beta/agents/environments/file_create_params.py">params</a>) -> <a href="./src/openai/types/beta/agents/environments/environment_file.py">EnvironmentFile</a></code>
- <code title="get /agents/environments/{environment_id}/files">client.beta.agents.environments.files.<a href="./src/openai/resources/beta/agents/environments/files.py">list</a>(environment_id, \*\*<a href="src/openai/types/beta/agents/environments/file_list_params.py">params</a>) -> <a href="./src/openai/types/beta/agents/environments/environment_file.py">SyncTokenPage[EnvironmentFile]</a></code>
#### Templates
Types:
```python
from openai.types.beta.agents.environments import EnvironmentTemplate, EnvironmentTemplateDeleted
```
Methods:
- <code title="post /agents/environments/templates">client.beta.agents.environments.templates.<a href="./src/openai/resources/beta/agents/environments/templates.py">create</a>(\*\*<a href="src/openai/types/beta/agents/environments/template_create_params.py">params</a>) -> <a href="./src/openai/types/beta/agents/environments/environment_template.py">EnvironmentTemplate</a></code>
- <code title="get /agents/environments/templates/{environment_template_id}">client.beta.agents.environments.templates.<a href="./src/openai/resources/beta/agents/environments/templates.py">retrieve</a>(environment_template_id) -> <a href="./src/openai/types/beta/agents/environments/environment_template.py">EnvironmentTemplate</a></code>
- <code title="post /agents/environments/templates/{environment_template_id}">client.beta.agents.environments.templates.<a href="./src/openai/resources/beta/agents/environments/templates.py">update</a>(environment_template_id, \*\*<a href="src/openai/types/beta/agents/environments/template_update_params.py">params</a>) -> <a href="./src/openai/types/beta/agents/environments/environment_template.py">EnvironmentTemplate</a></code>
- <code title="get /agents/environments/templates">client.beta.agents.environments.templates.<a href="./src/openai/resources/beta/agents/environments/templates.py">list</a>(\*\*<a href="src/openai/types/beta/agents/environments/template_list_params.py">params</a>) -> <a href="./src/openai/types/beta/agents/environments/environment_template.py">SyncCursorPage[EnvironmentTemplate]</a></code>
- <code title="delete /agents/environments/templates/{environment_template_id}">client.beta.agents.environments.templates.<a href="./src/openai/resources/beta/agents/environments/templates.py">delete</a>(environment_template_id) -> <a href="./src/openai/types/beta/agents/environments/environment_template_deleted.py">EnvironmentTemplateDeleted</a></code>
### Vaults
Types:
```python
from openai.types.beta.agents import Vault, VaultDeleted, VaultStatus, VaultStatusFilterParam
```
Methods:
- <code title="post /vaults">client.beta.agents.vaults.<a href="./src/openai/resources/beta/agents/vaults/vaults.py">create</a>(\*\*<a href="src/openai/types/beta/agents/vault_create_params.py">params</a>) -> <a href="./src/openai/types/beta/agents/vault.py">Vault</a></code>
- <code title="get /vaults/{vault_id}">client.beta.agents.vaults.<a href="./src/openai/resources/beta/agents/vaults/vaults.py">retrieve</a>(vault_id) -> <a href="./src/openai/types/beta/agents/vault.py">Vault</a></code>
- <code title="post /vaults/{vault_id}">client.beta.agents.vaults.<a href="./src/openai/resources/beta/agents/vaults/vaults.py">update</a>(vault_id, \*\*<a href="src/openai/types/beta/agents/vault_update_params.py">params</a>) -> <a href="./src/openai/types/beta/agents/vault.py">Vault</a></code>
- <code title="get /vaults">client.beta.agents.vaults.<a href="./src/openai/resources/beta/agents/vaults/vaults.py">list</a>(\*\*<a href="src/openai/types/beta/agents/vault_list_params.py">params</a>) -> <a href="./src/openai/types/beta/agents/vault.py">SyncCursorPage[Vault]</a></code>
- <code title="delete /vaults/{vault_id}">client.beta.agents.vaults.<a href="./src/openai/resources/beta/agents/vaults/vaults.py">delete</a>(vault_id) -> <a href="./src/openai/types/beta/agents/vault_deleted.py">VaultDeleted</a></code>
#### Credentials
Types:
```python
from openai.types.beta.agents.vaults import (
Credential,
CredentialAuth,
CredentialAuthCreateParam,
CredentialAuthRotateParam,
CredentialDeleted,
CredentialNetworking,
CredentialNetworkingParam,
McpOauthTokenEndpointAuth,
McpOauthTokenEndpointAuthCreateParam,
McpOauthTokenEndpointAuthRotateParam,
)
```
Methods:
- <code title="post /vaults/{vault_id}/credentials">client.beta.agents.vaults.credentials.<a href="./src/openai/resources/beta/agents/vaults/credentials.py">create</a>(vault_id, \*\*<a href="src/openai/types/beta/agents/vaults/credential_create_params.py">params</a>) -> <a href="./src/openai/types/beta/agents/vaults/credential.py">Credential</a></code>
- <code title="get /vaults/{vault_id}/credentials/{credential_id}">client.beta.agents.vaults.credentials.<a href="./src/openai/resources/beta/agents/vaults/credentials.py">retrieve</a>(credential_id, \*, vault_id) -> <a href="./src/openai/types/beta/agents/vaults/credential.py">Credential</a></code>
- <code title="post /vaults/{vault_id}/credentials/{credential_id}">client.beta.agents.vaults.credentials.<a href="./src/openai/resources/beta/agents/vaults/credentials.py">update</a>(credential_id, \*, vault_id, \*\*<a href="src/openai/types/beta/agents/vaults/credential_update_params.py">params</a>) -> <a href="./src/openai/types/beta/agents/vaults/credential.py">Credential</a></code>
- <code title="get /vaults/{vault_id}/credentials">client.beta.agents.vaults.credentials.<a href="./src/openai/resources/beta/agents/vaults/credentials.py">list</a>(vault_id, \*\*<a href="src/openai/types/beta/agents/vaults/credential_list_params.py">params</a>) -> <a href="./src/openai/types/beta/agents/vaults/credential.py">SyncCursorPage[Credential]</a></code>
- <code title="delete /vaults/{vault_id}/credentials/{credential_id}">client.beta.agents.vaults.credentials.<a href="./src/openai/resources/beta/agents/vaults/credentials.py">delete</a>(credential_id, \*, vault_id) -> <a href="./src/openai/types/beta/agents/vaults/credential_deleted.py">CredentialDeleted</a></code>
### Sessions
Methods:
- <code title="post /agents/sessions">client.beta.agents.sessions.<a href="./src/openai/resources/beta/agents/sessions/sessions.py">create</a>(\*\*<a href="src/openai/types/beta/agents/session_create_params.py">params</a>) -> <a href="./src/openai/types/beta/agent_session.py">AgentSession</a></code>
- <code title="get /agents/sessions/{session_id}">client.beta.agents.sessions.<a href="./src/openai/resources/beta/agents/sessions/sessions.py">retrieve</a>(session_id) -> <a href="./src/openai/types/beta/agent_session.py">AgentSession</a></code>
- <code title="post /agents/sessions/{session_id}">client.beta.agents.sessions.<a href="./src/openai/resources/beta/agents/sessions/sessions.py">update</a>(session_id, \*\*<a href="src/openai/types/beta/agents/session_update_params.py">params</a>) -> <a href="./src/openai/types/beta/agent_session.py">AgentSession</a></code>
- <code title="get /agents/sessions">client.beta.agents.sessions.<a href="./src/openai/resources/beta/agents/sessions/sessions.py">list</a>(\*\*<a href="src/openai/types/beta/agents/session_list_params.py">params</a>) -> <a href="./src/openai/types/beta/agent_session.py">SyncCursorPage[AgentSession]</a></code>
- <code title="delete /agents/sessions/{session_id}">client.beta.agents.sessions.<a href="./src/openai/resources/beta/agents/sessions/sessions.py">delete</a>(session_id) -> <a href="./src/openai/types/beta/agent_session_deleted.py">AgentSessionDeleted</a></code>
#### Subagents
Methods:
- <code title="get /agents/sessions/{session_id}/subagents/{subagent_id}">client.beta.agents.sessions.subagents.<a href="./src/openai/resources/beta/agents/sessions/subagents/subagents.py">retrieve</a>(subagent_id, \*, session_id) -> <a href="./src/openai/types/beta/subagent.py">Subagent</a></code>
- <code title="get /agents/sessions/{session_id}/subagents">client.beta.agents.sessions.subagents.<a href="./src/openai/resources/beta/agents/sessions/subagents/subagents.py">list</a>(session_id, \*\*<a href="src/openai/types/beta/agents/sessions/subagent_list_params.py">params</a>) -> <a href="./src/openai/types/beta/subagent.py">SyncCursorPage[Subagent]</a></code>
##### Items
Methods:
- <code title="get /agents/sessions/{session_id}/subagents/{subagent_id}/items">client.beta.agents.sessions.subagents.items.<a href="./src/openai/resources/beta/agents/sessions/subagents/items.py">list</a>(subagent_id, \*, session_id, \*\*<a href="src/openai/types/beta/agents/sessions/subagents/item_list_params.py">params</a>) -> <a href="./src/openai/types/beta/agent_session_item.py">SyncCursorPage[AgentSessionItem]</a></code>
##### Turns
Methods:
- <code title="get /agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}">client.beta.agents.sessions.subagents.turns.<a href="./src/openai/resources/beta/agents/sessions/subagents/turns/turns.py">retrieve</a>(turn_id, \*, session_id, subagent_id) -> <a href="./src/openai/types/beta/agents/sessions/turn.py">Turn</a></code>
- <code title="get /agents/sessions/{session_id}/subagents/{subagent_id}/turns">client.beta.agents.sessions.subagents.turns.<a href="./src/openai/resources/beta/agents/sessions/subagents/turns/turns.py">list</a>(subagent_id, \*, session_id, \*\*<a href="src/openai/types/beta/agents/sessions/subagents/turn_list_params.py">params</a>) -> <a href="./src/openai/types/beta/agents/sessions/turn.py">SyncCursorPage[Turn]</a></code>
###### Items
Methods:
- <code title="get /agents/sessions/{session_id}/subagents/{subagent_id}/turns/{turn_id}/items">client.beta.agents.sessions.subagents.turns.items.<a href="./src/openai/resources/beta/agents/sessions/subagents/turns/items.py">list</a>(turn_id, \*, session_id, subagent_id, \*\*<a href="src/openai/types/beta/agents/sessions/subagents/turns/item_list_params.py">params</a>) -> <a href="./src/openai/types/beta/agent_session_item.py">SyncCursorPage[AgentSessionItem]</a></code>
#### Artifacts
Types:
```python
from openai.types.beta.agents.sessions import SessionArtifact, SessionArtifactDeleted
```
Methods:
- <code title="get /agents/sessions/{session_id}/artifacts/{artifact_id}">client.beta.agents.sessions.artifacts.<a href="./src/openai/resources/beta/agents/sessions/artifacts.py">retrieve</a>(artifact_id, \*, session_id) -> <a href="./src/openai/types/beta/agents/sessions/session_artifact.py">SessionArtifact</a></code>
- <code title="get /agents/sessions/{session_id}/artifacts">client.beta.agents.sessions.artifacts.<a href="./src/openai/resources/beta/agents/sessions/artifacts.py">list</a>(session_id, \*\*<a href="src/openai/types/beta/agents/sessions/artifact_list_params.py">params</a>) -> <a href="./src/openai/types/beta/agents/sessions/session_artifact.py">SyncCursorPage[SessionArtifact]</a></code>
- <code title="delete /agents/sessions/{session_id}/artifacts/{artifact_id}">client.beta.agents.sessions.artifacts.<a href="./src/openai/resources/beta/agents/sessions/artifacts.py">delete</a>(artifact_id, \*, session_id) -> <a href="./src/openai/types/beta/agents/sessions/session_artifact_deleted.py">SessionArtifactDeleted</a></code>
- <code title="get /agents/sessions/{session_id}/artifacts/{artifact_id}/content">client.beta.agents.sessions.artifacts.<a href="./src/openai/resources/beta/agents/sessions/artifacts.py">content</a>(artifact_id, \*, session_id) -> HttpxBinaryResponseContent</code>
#### Items
Methods:
- <code title="get /agents/sessions/{session_id}/items">client.beta.agents.sessions.items.<a href="./src/openai/resources/beta/agents/sessions/items.py">list</a>(session_id, \*\*<a href="src/openai/types/beta/agents/sessions/item_list_params.py">params</a>) -> <a href="./src/openai/types/beta/agent_session_item.py">SyncCursorPage[AgentSessionItem]</a></code>
#### Events
Methods:
- <code title="post /agents/sessions/{session_id}/events">client.beta.agents.sessions.events.<a href="./src/openai/resources/beta/agents/sessions/events.py">create</a>(session_id, \*\*<a href="src/openai/types/beta/agents/sessions/event_create_params.py">params</a>) -> None</code>
- <code title="get /agents/sessions/{session_id}/events">client.beta.agents.sessions.events.<a href="./src/openai/resources/beta/agents/sessions/events.py">stream</a>(session_id) -> <a href="./src/openai/types/beta/agent_session_event.py">AgentSessionEvent</a></code>
#### Traces
Types:
```python
from openai.types.beta.agents.sessions import SessionTrace
```
Methods:
- <code title="get /agents/sessions/{session_id}/traces">client.beta.agents.sessions.traces.<a href="./src/openai/resources/beta/agents/sessions/traces.py">list</a>(session_id, \*\*<a href="src/openai/types/beta/agents/sessions/trace_list_params.py">params</a>) -> <a href="./src/openai/types/beta/agents/sessions/session_trace.py">SyncCursorPage[SessionTrace]</a></code>
#### Turns
Types:
```python
from openai.types.beta.agents.sessions import Turn
```
Methods:
- <code title="get /agents/sessions/{session_id}/turns/{turn_id}">client.beta.agents.sessions.turns.<a href="./src/openai/resources/beta/agents/sessions/turns/turns.py">retrieve</a>(turn_id, \*, session_id) -> <a href="./src/openai/types/beta/agents/sessions/turn.py">Turn</a></code>
- <code title="get /agents/sessions/{session_id}/turns">client.beta.agents.sessions.turns.<a href="./src/openai/resources/beta/agents/sessions/turns/turns.py">list</a>(session_id, \*\*<a href="src/openai/types/beta/agents/sessions/turn_list_params.py">params</a>) -> <a href="./src/openai/types/beta/agents/sessions/turn.py">SyncCursorPage[Turn]</a></code>
##### Items
Methods:
- <code title="get /agents/sessions/{session_id}/turns/{turn_id}/items">client.beta.agents.sessions.turns.items.<a href="./src/openai/resources/beta/agents/sessions/turns/items.py">list</a>(turn_id, \*, session_id, \*\*<a href="src/openai/types/beta/agents/sessions/turns/item_list_params.py">params</a>) -> <a href="./src/openai/types/beta/agent_session_item.py">SyncConversationCursorPage[AgentSessionItem]</a></code>
## Responses
Types:
```python
from openai.types.beta import (
BetaApplyPatchTool,
BetaCompactedResponse,
BetaComputerAction,
BetaComputerActionList,
BetaComputerTool,
BetaComputerUsePreviewTool,
BetaContainerAuto,
BetaContainerNetworkPolicyAllowlist,
BetaContainerNetworkPolicyDisabled,
BetaContainerNetworkPolicyDomainSecret,
BetaContainerReference,
BetaCustomTool,
BetaEasyInputMessage,
BetaFileSearchTool,
BetaFunctionShellTool,
BetaFunctionTool,
BetaImageDetail,
BetaInlineSkill,
BetaInlineSkillSource,
BetaLocalEnvironment,
BetaLocalSkill,
BetaMcpToolCallError,
BetaNamespaceTool,
BetaResponse,
BetaResponseApplyPatchToolCall,
BetaResponseApplyPatchToolCallOutput,
BetaResponseAudioDeltaEvent,
BetaResponseAudioDoneEvent,
BetaResponseAudioTranscriptDeltaEvent,
BetaResponseAudioTranscriptDoneEvent,
BetaResponseCodeInterpreterCallCodeDeltaEvent,
BetaResponseCodeInterpreterCallCodeDoneEvent,
BetaResponseCodeInterpreterCallCompletedEvent,
BetaResponseCodeInterpreterCallInProgressEvent,
BetaResponseCodeInterpreterCallInterpretingEvent,
BetaResponseCodeInterpreterToolCall,
BetaResponseCompactionCompactingEvent,
BetaResponseCompactionItem,
BetaResponseCompactionItemParam,
BetaResponseCompletedEvent,
BetaResponseComputerToolCall,
BetaResponseComputerToolCallOutputItem,
BetaResponseComputerToolCallOutputScreenshot,
BetaResponseConfigurationUpdateItem,
BetaResponseConfigurationUpdateItemParam,
BetaResponseContainerReference,
BetaResponseContent,
BetaResponseContentPartAddedEvent,
BetaResponseContentPartDoneEvent,
BetaResponseConversationParam,
BetaResponseCreatedEvent,
BetaResponseCustomToolCall,
BetaResponseCustomToolCallInputDeltaEvent,
BetaResponseCustomToolCallInputDoneEvent,
BetaResponseCustomToolCallItem,
BetaResponseCustomToolCallOutput,
BetaResponseCustomToolCallOutputItem,
BetaResponseError,
BetaResponseErrorEvent,
BetaResponseFailedEvent,
BetaResponseFileSearchCallCompletedEvent,
BetaResponseFileSearchCallInProgressEvent,
BetaResponseFileSearchCallSearchingEvent,
BetaResponseFileSearchToolCall,
BetaResponseFormatTextConfig,
BetaResponseFormatTextJSONSchemaConfig,
BetaResponseFunctionCallArgumentsDeltaEvent,
BetaResponseFunctionCallArgumentsDoneEvent,
BetaResponseFunctionCallOutputItem,
BetaResponseFunctionCallOutputItemList,
BetaResponseFunctionShellCallOutputContent,
BetaResponseFunctionShellToolCall,
BetaResponseFunctionShellToolCallOutput,
BetaResponseFunctionToolCall,
BetaResponseFunctionToolCallItem,
BetaResponseFunctionToolCallOutputItem,
BetaResponseFunctionWebSearch,
BetaResponseImageGenCallCompletedEvent,
BetaResponseImageGenCallGeneratingEvent,
BetaResponseImageGenCallInProgressEvent,
BetaResponseImageGenCallPartialImageEvent,
BetaResponseInProgressEvent,
BetaResponseIn