openapiopenai 1.2.0
OpenAI API
License: MIT
Requires Python: >=3.9
Keywords: OpenAPI, OpenAPI-Generator, OpenAI API

# openapiopenai
The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 2.3.0
- Package version: 1.2.0
- Generator version: 7.18.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://github.com/oapicf/openapi-openai](https://github.com/oapicf/openapi-openai)

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/oapicf/openapi-openai.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/oapicf/openapi-openai.git`)

Then import the package:
```python
import openapiopenai
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import openapiopenai
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import openapiopenai
from openapiopenai.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.openai.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openapiopenai.Configuration(
    host = "https://api.openai.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: ApiKeyAuth
configuration = openapiopenai.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with openapiopenai.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapiopenai.AssistantsApi(api_client)
    thread_id = 'thread_id_example' # str | The ID of the thread to which this run belongs.
    run_id = 'run_id_example' # str | The ID of the run to cancel.

    try:
        # Cancels a run that is `in_progress`.
        api_response = api_instance.cancel_run(thread_id, run_id)
        print("The response of AssistantsApi->cancel_run:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AssistantsApi->cancel_run: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.openai.com/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AssistantsApi* | [**cancel_run**](docs/AssistantsApi.md#cancel_run) | **POST** /threads/{thread_id}/runs/{run_id}/cancel | Cancels a run that is &#x60;in_progress&#x60;.
*AssistantsApi* | [**create_assistant**](docs/AssistantsApi.md#create_assistant) | **POST** /assistants | Create an assistant with a model and instructions.
*AssistantsApi* | [**create_message**](docs/AssistantsApi.md#create_message) | **POST** /threads/{thread_id}/messages | Create a message.
*AssistantsApi* | [**create_run**](docs/AssistantsApi.md#create_run) | **POST** /threads/{thread_id}/runs | Create a run.
*AssistantsApi* | [**create_thread**](docs/AssistantsApi.md#create_thread) | **POST** /threads | Create a thread.
*AssistantsApi* | [**create_thread_and_run**](docs/AssistantsApi.md#create_thread_and_run) | **POST** /threads/runs | Create a thread and run it in one request.
*AssistantsApi* | [**delete_assistant**](docs/AssistantsApi.md#delete_assistant) | **DELETE** /assistants/{assistant_id} | Delete an assistant.
*AssistantsApi* | [**delete_message**](docs/AssistantsApi.md#delete_message) | **DELETE** /threads/{thread_id}/messages/{message_id} | Deletes a message.
*AssistantsApi* | [**delete_thread**](docs/AssistantsApi.md#delete_thread) | **DELETE** /threads/{thread_id} | Delete a thread.
*AssistantsApi* | [**get_assistant**](docs/AssistantsApi.md#get_assistant) | **GET** /assistants/{assistant_id} | Retrieves an assistant.
*AssistantsApi* | [**get_message**](docs/AssistantsApi.md#get_message) | **GET** /threads/{thread_id}/messages/{message_id} | Retrieve a message.
*AssistantsApi* | [**get_run**](docs/AssistantsApi.md#get_run) | **GET** /threads/{thread_id}/runs/{run_id} | Retrieves a run.
*AssistantsApi* | [**get_run_step**](docs/AssistantsApi.md#get_run_step) | **GET** /threads/{thread_id}/runs/{run_id}/steps/{step_id} | Retrieves a run step.
*AssistantsApi* | [**get_thread**](docs/AssistantsApi.md#get_thread) | **GET** /threads/{thread_id} | Retrieves a thread.
*AssistantsApi* | [**list_assistants**](docs/AssistantsApi.md#list_assistants) | **GET** /assistants | Returns a list of assistants.
*AssistantsApi* | [**list_messages**](docs/AssistantsApi.md#list_messages) | **GET** /threads/{thread_id}/messages | Returns a list of messages for a given thread.
*AssistantsApi* | [**list_run_steps**](docs/AssistantsApi.md#list_run_steps) | **GET** /threads/{thread_id}/runs/{run_id}/steps | Returns a list of run steps belonging to a run.
*AssistantsApi* | [**list_runs**](docs/AssistantsApi.md#list_runs) | **GET** /threads/{thread_id}/runs | Returns a list of runs belonging to a thread.
*AssistantsApi* | [**modify_assistant**](docs/AssistantsApi.md#modify_assistant) | **POST** /assistants/{assistant_id} | Modifies an assistant.
*AssistantsApi* | [**modify_message**](docs/AssistantsApi.md#modify_message) | **POST** /threads/{thread_id}/messages/{message_id} | Modifies a message.
*AssistantsApi* | [**modify_run**](docs/AssistantsApi.md#modify_run) | **POST** /threads/{thread_id}/runs/{run_id} | Modifies a run.
*AssistantsApi* | [**modify_thread**](docs/AssistantsApi.md#modify_thread) | **POST** /threads/{thread_id} | Modifies a thread.
*AssistantsApi* | [**submit_tool_ouputs_to_run**](docs/AssistantsApi.md#submit_tool_ouputs_to_run) | **POST** /threads/{thread_id}/runs/{run_id}/submit_tool_outputs | When a run has the &#x60;status: \&quot;requires_action\&quot;&#x60; and &#x60;required_action.type&#x60; is &#x60;submit_tool_outputs&#x60;, this endpoint can be used to submit the outputs from the tool calls once they&#39;re all completed. All outputs must be submitted in a single request. 
*AudioApi* | [**create_speech**](docs/AudioApi.md#create_speech) | **POST** /audio/speech | Generates audio from the input text.
*AudioApi* | [**create_transcription**](docs/AudioApi.md#create_transcription) | **POST** /audio/transcriptions | Transcribes audio into the input language.
*AudioApi* | [**create_translation**](docs/AudioApi.md#create_translation) | **POST** /audio/translations | Translates audio into English.
*AuditLogsApi* | [**list_audit_logs**](docs/AuditLogsApi.md#list_audit_logs) | **GET** /organization/audit_logs | List user actions and configuration changes within this organization.
*BatchApi* | [**cancel_batch**](docs/BatchApi.md#cancel_batch) | **POST** /batches/{batch_id}/cancel | Cancels an in-progress batch. The batch will be in status &#x60;cancelling&#x60; for up to 10 minutes, before changing to &#x60;cancelled&#x60;, where it will have partial results (if any) available in the output file.
*BatchApi* | [**create_batch**](docs/BatchApi.md#create_batch) | **POST** /batches | Creates and executes a batch from an uploaded file of requests
*BatchApi* | [**list_batches**](docs/BatchApi.md#list_batches) | **GET** /batches | List your organization&#39;s batches.
*BatchApi* | [**retrieve_batch**](docs/BatchApi.md#retrieve_batch) | **GET** /batches/{batch_id} | Retrieves a batch.
*ChatApi* | [**create_chat_completion**](docs/ChatApi.md#create_chat_completion) | **POST** /chat/completions | Creates a model response for the given chat conversation. Learn more in the [text generation](/docs/guides/text-generation), [vision](/docs/guides/vision), and [audio](/docs/guides/audio) guides.  Parameter support can differ depending on the model used to generate the response, particularly for newer reasoning models. Parameters that are only supported for reasoning models are noted below. For the current state of  unsupported parameters in reasoning models,  [refer to the reasoning guide](/docs/guides/reasoning). 
*CompletionsApi* | [**create_completion**](docs/CompletionsApi.md#create_completion) | **POST** /completions | Creates a completion for the provided prompt and parameters.
*EmbeddingsApi* | [**create_embedding**](docs/EmbeddingsApi.md#create_embedding) | **POST** /embeddings | Creates an embedding vector representing the input text.
*FilesApi* | [**create_file**](docs/FilesApi.md#create_file) | **POST** /files | Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and the size of all files uploaded by one organization can be up to 100 GB.  The Assistants API supports files up to 2 million tokens and of specific file types. See the [Assistants Tools guide](/docs/assistants/tools) for details.  The Fine-tuning API only supports &#x60;.jsonl&#x60; files. The input also has certain required formats for fine-tuning [chat](/docs/api-reference/fine-tuning/chat-input) or [completions](/docs/api-reference/fine-tuning/completions-input) models.  The Batch API only supports &#x60;.jsonl&#x60; files up to 200 MB in size. The input also has a specific required [format](/docs/api-reference/batch/request-input).  Please [contact us](https://help.openai.com/) if you need to increase these storage limits. 
*FilesApi* | [**delete_file**](docs/FilesApi.md#delete_file) | **DELETE** /files/{file_id} | Delete a file.
*FilesApi* | [**download_file**](docs/FilesApi.md#download_file) | **GET** /files/{file_id}/content | Returns the contents of the specified file.
*FilesApi* | [**list_files**](docs/FilesApi.md#list_files) | **GET** /files | Returns a list of files.
*FilesApi* | [**retrieve_file**](docs/FilesApi.md#retrieve_file) | **GET** /files/{file_id} | Returns information about a specific file.
*FineTuningApi* | [**cancel_fine_tuning_job**](docs/FineTuningApi.md#cancel_fine_tuning_job) | **POST** /fine_tuning/jobs/{fine_tuning_job_id}/cancel | Immediately cancel a fine-tune job. 
*FineTuningApi* | [**create_fine_tuning_job**](docs/FineTuningApi.md#create_fine_tuning_job) | **POST** /fine_tuning/jobs | Creates a fine-tuning job which begins the process of creating a new model from a given dataset.  Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.  [Learn more about fine-tuning](/docs/guides/fine-tuning) 
*FineTuningApi* | [**list_fine_tuning_events**](docs/FineTuningApi.md#list_fine_tuning_events) | **GET** /fine_tuning/jobs/{fine_tuning_job_id}/events | Get status updates for a fine-tuning job. 
*FineTuningApi* | [**list_fine_tuning_job_checkpoints**](docs/FineTuningApi.md#list_fine_tuning_job_checkpoints) | **GET** /fine_tuning/jobs/{fine_tuning_job_id}/checkpoints | List checkpoints for a fine-tuning job. 
*FineTuningApi* | [**list_paginated_fine_tuning_jobs**](docs/FineTuningApi.md#list_paginated_fine_tuning_jobs) | **GET** /fine_tuning/jobs | List your organization&#39;s fine-tuning jobs 
*FineTuningApi* | [**retrieve_fine_tuning_job**](docs/FineTuningApi.md#retrieve_fine_tuning_job) | **GET** /fine_tuning/jobs/{fine_tuning_job_id} | Get info about a fine-tuning job.  [Learn more about fine-tuning](/docs/guides/fine-tuning) 
*ImagesApi* | [**create_image**](docs/ImagesApi.md#create_image) | **POST** /images/generations | Creates an image given a prompt.
*ImagesApi* | [**create_image_edit**](docs/ImagesApi.md#create_image_edit) | **POST** /images/edits | Creates an edited or extended image given an original image and a prompt.
*ImagesApi* | [**create_image_variation**](docs/ImagesApi.md#create_image_variation) | **POST** /images/variations | Creates a variation of a given image.
*InvitesApi* | [**delete_invite**](docs/InvitesApi.md#delete_invite) | **DELETE** /organization/invites/{invite_id} | Delete an invite. If the invite has already been accepted, it cannot be deleted.
*InvitesApi* | [**invite_user**](docs/InvitesApi.md#invite_user) | **POST** /organization/invites | Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.
*InvitesApi* | [**list_invites**](docs/InvitesApi.md#list_invites) | **GET** /organization/invites | Returns a list of invites in the organization.
*InvitesApi* | [**retrieve_invite**](docs/InvitesApi.md#retrieve_invite) | **GET** /organization/invites/{invite_id} | Retrieves an invite.
*ModelsApi* | [**delete_model**](docs/ModelsApi.md#delete_model) | **DELETE** /models/{model} | Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.
*ModelsApi* | [**list_models**](docs/ModelsApi.md#list_models) | **GET** /models | Lists the currently available models, and provides basic information about each one such as the owner and availability.
*ModelsApi* | [**retrieve_model**](docs/ModelsApi.md#retrieve_model) | **GET** /models/{model} | Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
*ModerationsApi* | [**create_moderation**](docs/ModerationsApi.md#create_moderation) | **POST** /moderations | Classifies if text and/or image inputs are potentially harmful. Learn more in the [moderation guide](/docs/guides/moderation). 
*ProjectsApi* | [**archive_project**](docs/ProjectsApi.md#archive_project) | **POST** /organization/projects/{project_id}/archive | Archives a project in the organization. Archived projects cannot be used or updated.
*ProjectsApi* | [**create_project**](docs/ProjectsApi.md#create_project) | **POST** /organization/projects | Create a new project in the organization. Projects can be created and archived, but cannot be deleted.
*ProjectsApi* | [**create_project_service_account**](docs/ProjectsApi.md#create_project_service_account) | **POST** /organization/projects/{project_id}/service_accounts | Creates a new service account in the project. This also returns an unredacted API key for the service account.
*ProjectsApi* | [**create_project_user**](docs/ProjectsApi.md#create_project_user) | **POST** /organization/projects/{project_id}/users | Adds a user to the project. Users must already be members of the organization to be added to a project.
*ProjectsApi* | [**delete_project_api_key**](docs/ProjectsApi.md#delete_project_api_key) | **DELETE** /organization/projects/{project_id}/api_keys/{key_id} | Deletes an API key from the project.
*ProjectsApi* | [**delete_project_service_account**](docs/ProjectsApi.md#delete_project_service_account) | **DELETE** /organization/projects/{project_id}/service_accounts/{service_account_id} | Deletes a service account from the project.
*ProjectsApi* | [**delete_project_user**](docs/ProjectsApi.md#delete_project_user) | **DELETE** /organization/projects/{project_id}/users/{user_id} | Deletes a user from the project.
*ProjectsApi* | [**list_project_api_keys**](docs/ProjectsApi.md#list_project_api_keys) | **GET** /organization/projects/{project_id}/api_keys | Returns a list of API keys in the project.
*ProjectsApi* | [**list_project_rate_limits**](docs/ProjectsApi.md#list_project_rate_limits) | **GET** /organization/projects/{project_id}/rate_limits | Returns the rate limits per model for a project.
*ProjectsApi* | [**list_project_service_accounts**](docs/ProjectsApi.md#list_project_service_accounts) | **GET** /organization/projects/{project_id}/service_accounts | Returns a list of service accounts in the project.
*ProjectsApi* | [**list_project_users**](docs/ProjectsApi.md#list_project_users) | **GET** /organization/projects/{project_id}/users | Returns a list of users in the project.
*ProjectsApi* | [**list_projects**](docs/ProjectsApi.md#list_projects) | **GET** /organization/projects | Returns a list of projects.
*ProjectsApi* | [**modify_project**](docs/ProjectsApi.md#modify_project) | **POST** /organization/projects/{project_id} | Modifies a project in the organization.
*ProjectsApi* | [**modify_project_user**](docs/ProjectsApi.md#modify_project_user) | **POST** /organization/projects/{project_id}/users/{user_id} | Modifies a user&#39;s role in the project.
*ProjectsApi* | [**retrieve_project**](docs/ProjectsApi.md#retrieve_project) | **GET** /organization/projects/{project_id} | Retrieves a project.
*ProjectsApi* | [**retrieve_project_api_key**](docs/ProjectsApi.md#retrieve_project_api_key) | **GET** /organization/projects/{project_id}/api_keys/{key_id} | Retrieves an API key in the project.
*ProjectsApi* | [**retrieve_project_service_account**](docs/ProjectsApi.md#retrieve_project_service_account) | **GET** /organization/projects/{project_id}/service_accounts/{service_account_id} | Retrieves a service account in the project.
*ProjectsApi* | [**retrieve_project_user**](docs/ProjectsApi.md#retrieve_project_user) | **GET** /organization/projects/{project_id}/users/{user_id} | Retrieves a user in the project.
*ProjectsApi* | [**update_project_rate_limits**](docs/ProjectsApi.md#update_project_rate_limits) | **POST** /organization/projects/{project_id}/rate_limits/{rate_limit_id} | Updates a project rate limit.
*RealtimeApi* | [**create_realtime_session**](docs/RealtimeApi.md#create_realtime_session) | **POST** /realtime/sessions | Create an ephemeral API token for use in client-side applications with the Realtime API. Can be configured with the same session parameters as the &#x60;session.update&#x60; client event.  It responds with a session object, plus a &#x60;client_secret&#x60; key which contains a usable ephemeral API token that can be used to authenticate browser clients for the Realtime API. 
*UploadsApi* | [**add_upload_part**](docs/UploadsApi.md#add_upload_part) | **POST** /uploads/{upload_id}/parts | Adds a [Part](/docs/api-reference/uploads/part-object) to an [Upload](/docs/api-reference/uploads/object) object. A Part represents a chunk of bytes from the file you are trying to upload.   Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB.  It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you [complete the Upload](/docs/api-reference/uploads/complete). 
*UploadsApi* | [**cancel_upload**](docs/UploadsApi.md#cancel_upload) | **POST** /uploads/{upload_id}/cancel | Cancels the Upload. No Parts may be added after an Upload is cancelled. 
*UploadsApi* | [**complete_upload**](docs/UploadsApi.md#complete_upload) | **POST** /uploads/{upload_id}/complete | Completes the [Upload](/docs/api-reference/uploads/object).   Within the returned Upload object, there is a nested [File](/docs/api-reference/files/object) object that is ready to use in the rest of the platform.  You can specify the order of the Parts by passing in an ordered list of the Part IDs.  The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed. 
*UploadsApi* | [**create_upload**](docs/UploadsApi.md#create_upload) | **POST** /uploads | Creates an intermediate [Upload](/docs/api-reference/uploads/object) object that you can add [Parts](/docs/api-reference/uploads/part-object) to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it.  Once you complete the Upload, we will create a [File](/docs/api-reference/files/object) object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object.  For certain &#x60;purpose&#x60;s, the correct &#x60;mime_type&#x60; must be specified. Please refer to documentation for the supported MIME types for your use case: - [Assistants](/docs/assistants/tools/file-search#supported-files)  For guidance on the proper filename extensions for each purpose, please follow the documentation on [creating a File](/docs/api-reference/files/create). 
*UsageApi* | [**usage_audio_speeches**](docs/UsageApi.md#usage_audio_speeches) | **GET** /organization/usage/audio_speeches | Get audio speeches usage details for the organization.
*UsageApi* | [**usage_audio_transcriptions**](docs/UsageApi.md#usage_audio_transcriptions) | **GET** /organization/usage/audio_transcriptions | Get audio transcriptions usage details for the organization.
*UsageApi* | [**usage_code_interpreter_sessions**](docs/UsageApi.md#usage_code_interpreter_sessions) | **GET** /organization/usage/code_interpreter_sessions | Get code interpreter sessions usage details for the organization.
*UsageApi* | [**usage_completions**](docs/UsageApi.md#usage_completions) | **GET** /organization/usage/completions | Get completions usage details for the organization.
*UsageApi* | [**usage_costs**](docs/UsageApi.md#usage_costs) | **GET** /organization/costs | Get costs details for the organization.
*UsageApi* | [**usage_embeddings**](docs/UsageApi.md#usage_embeddings) | **GET** /organization/usage/embeddings | Get embeddings usage details for the organization.
*UsageApi* | [**usage_images**](docs/UsageApi.md#usage_images) | **GET** /organization/usage/images | Get images usage details for the organization.
*UsageApi* | [**usage_moderations**](docs/UsageApi.md#usage_moderations) | **GET** /organization/usage/moderations | Get moderations usage details for the organization.
*UsageApi* | [**usage_vector_stores**](docs/UsageApi.md#usage_vector_stores) | **GET** /organization/usage/vector_stores | Get vector stores usage details for the organization.
*UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /organization/users/{user_id} | Deletes a user from the organization.
*UsersApi* | [**list_users**](docs/UsersApi.md#list_users) | **GET** /organization/users | Lists all of the users in the organization.
*UsersApi* | [**modify_user**](docs/UsersApi.md#modify_user) | **POST** /organization/users/{user_id} | Modifies a user&#39;s role in the organization.
*UsersApi* | [**retrieve_user**](docs/UsersApi.md#retrieve_user) | **GET** /organization/users/{user_id} | Retrieves a user by their identifier.
*VectorStoresApi* | [**cancel_vector_store_file_batch**](docs/VectorStoresApi.md#cancel_vector_store_file_batch) | **POST** /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel | Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.
*VectorStoresApi* | [**create_vector_store**](docs/VectorStoresApi.md#create_vector_store) | **POST** /vector_stores | Create a vector store.
*VectorStoresApi* | [**create_vector_store_file**](docs/VectorStoresApi.md#create_vector_store_file) | **POST** /vector_stores/{vector_store_id}/files | Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).
*VectorStoresApi* | [**create_vector_store_file_batch**](docs/VectorStoresApi.md#create_vector_store_file_batch) | **POST** /vector_stores/{vector_store_id}/file_batches | Create a vector store file batch.
*VectorStoresApi* | [**delete_vector_store**](docs/VectorStoresApi.md#delete_vector_store) | **DELETE** /vector_stores/{vector_store_id} | Delete a vector store.
*VectorStoresApi* | [**delete_vector_store_file**](docs/VectorStoresApi.md#delete_vector_store_file) | **DELETE** /vector_stores/{vector_store_id}/files/{file_id} | Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint.
*VectorStoresApi* | [**get_vector_store**](docs/VectorStoresApi.md#get_vector_store) | **GET** /vector_stores/{vector_store_id} | Retrieves a vector store.
*VectorStoresApi* | [**get_vector_store_file**](docs/VectorStoresApi.md#get_vector_store_file) | **GET** /vector_stores/{vector_store_id}/files/{file_id} | Retrieves a vector store file.
*VectorStoresApi* | [**get_vector_store_file_batch**](docs/VectorStoresApi.md#get_vector_store_file_batch) | **GET** /vector_stores/{vector_store_id}/file_batches/{batch_id} | Retrieves a vector store file batch.
*VectorStoresApi* | [**list_files_in_vector_store_batch**](docs/VectorStoresApi.md#list_files_in_vector_store_batch) | **GET** /vector_stores/{vector_store_id}/file_batches/{batch_id}/files | Returns a list of vector store files in a batch.
*VectorStoresApi* | [**list_vector_store_files**](docs/VectorStoresApi.md#list_vector_store_files) | **GET** /vector_stores/{vector_store_id}/files | Returns a list of vector store files.
*VectorStoresApi* | [**list_vector_stores**](docs/VectorStoresApi.md#list_vector_stores) | **GET** /vector_stores | Returns a list of vector stores.
*VectorStoresApi* | [**modify_vector_store**](docs/VectorStoresApi.md#modify_vector_store) | **POST** /vector_stores/{vector_store_id} | Modifies a vector store.
*DefaultApi* | [**admin_api_keys_create**](docs/DefaultApi.md#admin_api_keys_create) | **POST** /organization/admin_api_keys | Create an organization admin API key
*DefaultApi* | [**admin_api_keys_delete**](docs/DefaultApi.md#admin_api_keys_delete) | **DELETE** /organization/admin_api_keys/{key_id} | Delete an organization admin API key
*DefaultApi* | [**admin_api_keys_get**](docs/DefaultApi.md#admin_api_keys_get) | **GET** /organization/admin_api_keys/{key_id} | Retrieve a single organization API key
*DefaultApi* | [**admin_api_keys_list**](docs/DefaultApi.md#admin_api_keys_list) | **GET** /organization/admin_api_keys | List organization API keys


## Documentation For Models

 - [AdminApiKey](docs/AdminApiKey.md)
 - [AdminApiKeyOwner](docs/AdminApiKeyOwner.md)
 - [AdminApiKeysCreateRequest](docs/AdminApiKeysCreateRequest.md)
 - [AdminApiKeysDelete200Response](docs/AdminApiKeysDelete200Response.md)
 - [ApiKeyList](docs/ApiKeyList.md)
 - [ArrayOfContentPartsInner](docs/ArrayOfContentPartsInner.md)
 - [AssistantObject](docs/AssistantObject.md)
 - [AssistantObjectToolResources](docs/AssistantObjectToolResources.md)
 - [AssistantObjectToolResourcesCodeInterpreter](docs/AssistantObjectToolResourcesCodeInterpreter.md)
 - [AssistantObjectToolResourcesFileSearch](docs/AssistantObjectToolResourcesFileSearch.md)
 - [AssistantObjectToolsInner](docs/AssistantObjectToolsInner.md)
 - [AssistantStreamEvent](docs/AssistantStreamEvent.md)
 - [AssistantToolsCode](docs/AssistantToolsCode.md)
 - [AssistantToolsFileSearch](docs/AssistantToolsFileSearch.md)
 - [AssistantToolsFileSearchFileSearch](docs/AssistantToolsFileSearchFileSearch.md)
 - [AssistantToolsFileSearchTypeOnly](docs/AssistantToolsFileSearchTypeOnly.md)
 - [AssistantToolsFunction](docs/AssistantToolsFunction.md)
 - [AssistantsApiResponseFormatOption](docs/AssistantsApiResponseFormatOption.md)
 - [AssistantsApiToolChoiceOption](docs/AssistantsApiToolChoiceOption.md)
 - [AssistantsNamedToolChoice](docs/AssistantsNamedToolChoice.md)
 - [AssistantsNamedToolChoiceFunction](docs/AssistantsNamedToolChoiceFunction.md)
 - [AudioResponseFormat](docs/AudioResponseFormat.md)
 - [AuditLog](docs/AuditLog.md)
 - [AuditLogActor](docs/AuditLogActor.md)
 - [AuditLogActorApiKey](docs/AuditLogActorApiKey.md)
 - [AuditLogActorServiceAccount](docs/AuditLogActorServiceAccount.md)
 - [AuditLogActorSession](docs/AuditLogActorSession.md)
 - [AuditLogActorUser](docs/AuditLogActorUser.md)
 - [AuditLogApiKeyCreated](docs/AuditLogApiKeyCreated.md)
 - [AuditLogApiKeyCreatedData](docs/AuditLogApiKeyCreatedData.md)
 - [AuditLogApiKeyDeleted](docs/AuditLogApiKeyDeleted.md)
 - [AuditLogApiKeyUpdated](docs/AuditLogApiKeyUpdated.md)
 - [AuditLogApiKeyUpdatedChangesRequested](docs/AuditLogApiKeyUpdatedChangesRequested.md)
 - [AuditLogEventType](docs/AuditLogEventType.md)
 - [AuditLogInviteAccepted](docs/AuditLogInviteAccepted.md)
 - [AuditLogInviteSent](docs/AuditLogInviteSent.md)
 - [AuditLogInviteSentData](docs/AuditLogInviteSentData.md)
 - [AuditLogLoginFailed](docs/AuditLogLoginFailed.md)
 - [AuditLogOrganizationUpdated](docs/AuditLogOrganizationUpdated.md)
 - [AuditLogOrganizationUpdatedChangesRequested](docs/AuditLogOrganizationUpdatedChangesRequested.md)
 - [AuditLogOrganizationUpdatedChangesRequestedSettings](docs/AuditLogOrganizationUpdatedChangesRequestedSettings.md)
 - [AuditLogProject](docs/AuditLogProject.md)
 - [AuditLogProjectArchived](docs/AuditLogProjectArchived.md)
 - [AuditLogProjectCreated](docs/AuditLogProjectCreated.md)
 - [AuditLogProjectCreatedData](docs/AuditLogProjectCreatedData.md)
 - [AuditLogProjectUpdated](docs/AuditLogProjectUpdated.md)
 - [AuditLogProjectUpdatedChangesRequested](docs/AuditLogProjectUpdatedChangesRequested.md)
 - [AuditLogRateLimitDeleted](docs/AuditLogRateLimitDeleted.md)
 - [AuditLogRateLimitUpdated](docs/AuditLogRateLimitUpdated.md)
 - [AuditLogRateLimitUpdatedChangesRequested](docs/AuditLogRateLimitUpdatedChangesRequested.md)
 - [AuditLogServiceAccountCreated](docs/AuditLogServiceAccountCreated.md)
 - [AuditLogServiceAccountCreatedData](docs/AuditLogServiceAccountCreatedData.md)
 - [AuditLogServiceAccountDeleted](docs/AuditLogServiceAccountDeleted.md)
 - [AuditLogServiceAccountUpdated](docs/AuditLogServiceAccountUpdated.md)
 - [AuditLogServiceAccountUpdatedChangesRequested](docs/AuditLogServiceAccountUpdatedChangesRequested.md)
 - [AuditLogUserAdded](docs/AuditLogUserAdded.md)
 - [AuditLogUserAddedData](docs/AuditLogUserAddedData.md)
 - [AuditLogUserDeleted](docs/AuditLogUserDeleted.md)
 - [AuditLogUserUpdated](docs/AuditLogUserUpdated.md)
 - [AuditLogUserUpdatedChangesRequested](docs/AuditLogUserUpdatedChangesRequested.md)
 - [AutoChunkingStrategy](docs/AutoChunkingStrategy.md)
 - [AutoChunkingStrategyRequestParam](docs/AutoChunkingStrategyRequestParam.md)
 - [Batch](docs/Batch.md)
 - [BatchErrors](docs/BatchErrors.md)
 - [BatchErrorsDataInner](docs/BatchErrorsDataInner.md)
 - [BatchRequestCounts](docs/BatchRequestCounts.md)
 - [BatchRequestInput](docs/BatchRequestInput.md)
 - [BatchRequestOutput](docs/BatchRequestOutput.md)
 - [BatchRequestOutputError](docs/BatchRequestOutputError.md)
 - [BatchRequestOutputResponse](docs/BatchRequestOutputResponse.md)
 - [ChatCompletionFunctionCallOption](docs/ChatCompletionFunctionCallOption.md)
 - [ChatCompletionFunctions](docs/ChatCompletionFunctions.md)
 - [ChatCompletionMessageToolCall](docs/ChatCompletionMessageToolCall.md)
 - [ChatCompletionMessageToolCallChunk](docs/ChatCompletionMessageToolCallChunk.md)
 - [ChatCompletionMessageToolCallChunkFunction](docs/ChatCompletionMessageToolCallChunkFunction.md)
 - [ChatCompletionMessageToolCallFunction](docs/ChatCompletionMessageToolCallFunction.md)
 - [ChatCompletionNamedToolChoice](docs/ChatCompletionNamedToolChoice.md)
 - [ChatCompletionRequestAssistantMessage](docs/ChatCompletionRequestAssistantMessage.md)
 - [ChatCompletionRequestAssistantMessageAudio](docs/ChatCompletionRequestAssistantMessageAudio.md)
 - [ChatCompletionRequestAssistantMessageContent](docs/ChatCompletionRequestAssistantMessageContent.md)
 - [ChatCompletionRequestAssistantMessageContentPart](docs/ChatCompletionRequestAssistantMessageContentPart.md)
 - [ChatCompletionRequestAssistantMessageFunctionCall](docs/ChatCompletionRequestAssistantMessageFunctionCall.md)
 - [ChatCompletionRequestDeveloperMessage](docs/ChatCompletionRequestDeveloperMessage.md)
 - [ChatCompletionRequestDeveloperMessageContent](docs/ChatCompletionRequestDeveloperMessageContent.md)
 - [ChatCompletionRequestFunctionMessage](docs/ChatCompletionRequestFunctionMessage.md)
 - [ChatCompletionRequestMessage](docs/ChatCompletionRequestMessage.md)
 - [ChatCompletionRequestMessageContentPartAudio](docs/ChatCompletionRequestMessageContentPartAudio.md)
 - [ChatCompletionRequestMessageContentPartAudioInputAudio](docs/ChatCompletionRequestMessageContentPartAudioInputAudio.md)
 - [ChatCompletionRequestMessageContentPartImage](docs/ChatCompletionRequestMessageContentPartImage.md)
 - [ChatCompletionRequestMessageContentPartImageImageUrl](docs/ChatCompletionRequestMessageContentPartImageImageUrl.md)
 - [ChatCompletionRequestMessageContentPartRefusal](docs/ChatCompletionRequestMessageContentPartRefusal.md)
 - [ChatCompletionRequestMessageContentPartText](docs/ChatCompletionRequestMessageContentPartText.md)
 - [ChatCompletionRequestSystemMessage](docs/ChatCompletionRequestSystemMessage.md)
 - [ChatCompletionRequestSystemMessageContent](docs/ChatCompletionRequestSystemMessageContent.md)
 - [ChatCompletionRequestToolMessage](docs/ChatCompletionRequestToolMessage.md)
 - [ChatCompletionRequestToolMessageContent](docs/ChatCompletionRequestToolMessageContent.md)
 - [ChatCompletionRequestUserMessage](docs/ChatCompletionRequestUserMessage.md)
 - [ChatCompletionRequestUserMessageContent](docs/ChatCompletionRequestUserMessageContent.md)
 - [ChatCompletionRequestUserMessageContentPart](docs/ChatCompletionRequestUserMessageContentPart.md)
 - [ChatCompletionResponseMessage](docs/ChatCompletionResponseMessage.md)
 - [ChatCompletionResponseMessageAudio](docs/ChatCompletionResponseMessageAudio.md)
 - [ChatCompletionResponseMessageFunctionCall](docs/ChatCompletionResponseMessageFunctionCall.md)
 - [ChatCompletionRole](docs/ChatCompletionRole.md)
 - [ChatCompletionStreamOptions](docs/ChatCompletionStreamOptions.md)
 - [ChatCompletionStreamResponseDelta](docs/ChatCompletionStreamResponseDelta.md)
 - [ChatCompletionStreamResponseDeltaFunctionCall](docs/ChatCompletionStreamResponseDeltaFunctionCall.md)
 - [ChatCompletionTokenLogprob](docs/ChatCompletionTokenLogprob.md)
 - [ChatCompletionTokenLogprobTopLogprobsInner](docs/ChatCompletionTokenLogprobTopLogprobsInner.md)
 - [ChatCompletionTool](docs/ChatCompletionTool.md)
 - [ChatCompletionToolChoiceOption](docs/ChatCompletionToolChoiceOption.md)
 - [ChunkingStrategyRequestParam](docs/ChunkingStrategyRequestParam.md)
 - [CompleteUploadRequest](docs/CompleteUploadRequest.md)
 - [CompletionUsage](docs/CompletionUsage.md)
 - [CompletionUsageCompletionTokensDetails](docs/CompletionUsageCompletionTokensDetails.md)
 - [CompletionUsagePromptTokensDetails](docs/CompletionUsagePromptTokensDetails.md)
 - [CostsResult](docs/CostsResult.md)
 - [CostsResultAmount](docs/CostsResultAmount.md)
 - [CreateAssistantRequest](docs/CreateAssistantRequest.md)
 - [CreateAssistantRequestModel](docs/CreateAssistantRequestModel.md)
 - [CreateAssistantRequestToolResources](docs/CreateAssistantRequestToolResources.md)
 - [CreateAssistantRequestToolResourcesCodeInterpreter](docs/CreateAssistantRequestToolResourcesCodeInterpreter.md)
 - [CreateAssistantRequestToolResourcesFileSearch](docs/CreateAssistantRequestToolResourcesFileSearch.md)
 - [CreateAssistantRequestToolResourcesFileSearchVectorStoresInner](docs/CreateAssistantRequestToolResourcesFileSearchVectorStoresInner.md)
 - [CreateAssistantRequestToolResourcesFileSearchVectorStoresInnerChunkingStrategy](docs/CreateAssistantRequestToolResourcesFileSearchVectorStoresInnerChunkingStrategy.md)
 - [CreateBatchRequest](docs/CreateBatchRequest.md)
 - [CreateChatCompletionFunctionResponse](docs/CreateChatCompletionFunctionResponse.md)
 - [CreateChatCompletionFunctionResponseChoicesInner](docs/CreateChatCompletionFunctionResponseChoicesInner.md)
 - [CreateChatCompletionRequest](docs/CreateChatCompletionRequest.md)
 - [CreateChatCompletionRequestAudio](docs/CreateChatCompletionRequestAudio.md)
 - [CreateChatCompletionRequestFunctionCall](docs/CreateChatCompletionRequestFunctionCall.md)
 - [CreateChatCompletionRequestModel](docs/CreateChatCompletionRequestModel.md)
 - [CreateChatCompletionRequestResponseFormat](docs/CreateChatCompletionRequestResponseFormat.md)
 - [CreateChatCompletionRequestStop](docs/CreateChatCompletionRequestStop.md)
 - [CreateChatCompletionResponse](docs/CreateChatCompletionResponse.md)
 - [CreateChatCompletionResponseChoicesInner](docs/CreateChatCompletionResponseChoicesInner.md)
 - [CreateChatCompletionResponseChoicesInnerLogprobs](docs/CreateChatCompletionResponseChoicesInnerLogprobs.md)
 - [CreateChatCompletionStreamResponse](docs/CreateChatCompletionStreamResponse.md)
 - [CreateChatCompletionStreamResponseChoicesInner](docs/CreateChatCompletionStreamResponseChoicesInner.md)
 - [CreateChatCompletionStreamResponseUsage](docs/CreateChatCompletionStreamResponseUsage.md)
 - [CreateCompletionRequest](docs/CreateCompletionRequest.md)
 - [CreateCompletionRequestModel](docs/CreateCompletionRequestModel.md)
 - [CreateCompletionRequestPrompt](docs/CreateCompletionRequestPrompt.md)
 - [CreateCompletionRequestStop](docs/CreateCompletionRequestStop.md)
 - [CreateCompletionResponse](docs/CreateCompletionResponse.md)
 - [CreateCompletionResponseChoicesInner](docs/CreateCompletionResponseChoicesInner.md)
 - [CreateCompletionResponseChoicesInnerLogprobs](docs/CreateCompletionResponseChoicesInnerLogprobs.md)
 - [CreateEmbeddingRequest](docs/CreateEmbeddingRequest.md)
 - [CreateEmbeddingRequestInput](docs/CreateEmbeddingRequestInput.md)
 - [CreateEmbeddingRequestModel](docs/CreateEmbeddingRequestModel.md)
 - [CreateEmbeddingResponse](docs/CreateEmbeddingResponse.md)
 - [CreateEmbeddingResponseUsage](docs/CreateEmbeddingResponseUsage.md)
 - [CreateFineTuningJobRequest](docs/CreateFineTuningJobRequest.md)
 - [CreateFineTuningJobRequestHyperparameters](docs/CreateFineTuningJobRequestHyperparameters.md)
 - [CreateFineTuningJobRequestHyperparametersBatchSize](docs/CreateFineTuningJobRequestHyperparametersBatchSize.md)
 - [CreateFineTuningJobRequestHyperparametersLearningRateMultiplier](docs/CreateFineTuningJobRequestHyperparametersLearningRateMultiplier.md)
 - [CreateFineTuningJobRequestHyperparametersNEpochs](docs/CreateFineTuningJobRequestHyperparametersNEpochs.md)
 - [CreateFineTuningJobRequestIntegrationsInner](docs/CreateFineTuningJobRequestIntegrationsInner.md)
 - [CreateFineTuningJobRequestIntegrationsInnerWandb](docs/CreateFineTuningJobRequestIntegrationsInnerWandb.md)
 - [CreateFineTuningJobRequestModel](docs/CreateFineTuningJobRequestModel.md)
 - [CreateImageEditRequestModel](docs/CreateImageEditRequestModel.md)
 - [CreateImageRequest](docs/CreateImageRequest.md)
 - [CreateImageRequestModel](docs/CreateImageRequestModel.md)
 - [CreateMessageRequest](docs/CreateMessageRequest.md)
 - [CreateMessageRequestAttachmentsInner](docs/CreateMessageRequestAttachmentsInner.md)
 - [CreateMessageRequestAttachmentsInnerToolsInner](docs/CreateMessageRequestAttachmentsInnerToolsInner.md)
 - [CreateMessageRequestContent](docs/CreateMessageRequestContent.md)
 - [CreateModerationRequest](docs/CreateModerationRequest.md)
 - [CreateModerationRequestInput](docs/CreateModerationRequestInput.md)
 - [CreateModerationRequestInputOneOfInner](docs/CreateModerationRequestInputOneOfInner.md)
 - [CreateModerationRequestInputOneOfInnerOneOf](docs/CreateModerationRequestInputOneOfInnerOneOf.md)
 - [CreateModerationRequestInputOneOfInnerOneOf1](docs/CreateModerationRequestInputOneOfInnerOneOf1.md)
 - [CreateModerationRequestInputOneOfInnerOneOfImageUrl](docs/CreateModerationRequestInputOneOfInnerOneOfImageUrl.md)
 - [CreateModerationRequestModel](docs/CreateModerationRequestModel.md)
 - [CreateModerationResponse](docs/CreateModerationResponse.md)
 - [CreateModerationResponseResultsInner](docs/CreateModerationResponseResultsInner.md)
 - [CreateModerationResponseResultsInnerCategories](docs/CreateModerationResponseResultsInnerCategories.md)
 - [CreateModerationResponseResultsInnerCategoryAppliedInputTypes](docs/CreateModerationResponseResultsInnerCategoryAppliedInputTypes.md)
 - [CreateModerationResponseResultsInnerCategoryScores](docs/CreateModerationResponseResultsInnerCategoryScores.md)
 - [CreateRunRequest](docs/CreateRunRequest.md)
 - [CreateRunRequestModel](docs/CreateRunRequestModel.md)
 - [CreateSpeechR