https://github.com/ainoya/openai-java-generated-client

Java client library for OpenAI API, generated using openai-generator with modifications to the official spec for error-free generation and functionality
https://github.com/ainoya/openai-java-generated-client
java openai openai-api openaiapi openapi-generator
Last synced: 11 months ago
JSON representation
Java client library for OpenAI API, generated using openai-generator with modifications to the official spec for error-free generation and functionality
Host: GitHub
URL: https://github.com/ainoya/openai-java-generated-client
Owner: ainoya
Created: 2023-11-17T09:28:11.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2025-02-25T12:04:46.000Z (about 1 year ago)
Last Synced: 2025-02-25T13:22:18.631Z (about 1 year ago)
Topics: java, openai, openai-api, openaiapi, openapi-generator
Language: Java
Homepage:
Size: 2.81 MB
Stars: 1
Watchers: 4
Forks: 0
Open Issues: 11
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

          # OpenAI API Java Client generated from OpenAPI specification with openapi-generator

[![Release](https://jitpack.io/v/ainoya/openai-java-generated-client.svg)](https://jitpack.io/#ainoya/openai-java-generated-client)

## How to build

```bash

./generate-api-client.sh vXX.XX.XX

```

## Overview

This repository contains a Java client library for the OpenAI API, generated using the OpenAPI Generator tool. The library is based on the official OpenAPI specification provided by OpenAI, which can be found at [openai/openai-openapi](https://github.com/openai/openai-openapi).

## Motivation

While attempting to generate the client library directly from the official OpenAPI spec file, several issues were encountered, primarily due to certain syntax elements like `oneOf` that led to generation errors. To overcome these challenges, modifications were made to the original spec file to ensure successful client generation and functional integrity of the resulting Java client.

## Modifications and Testing

Several definitions in the spec file that caused errors during generation were identified and rectified. This included, but was not limited to, addressing issues with `oneOf` syntax. It is important to note that these modifications might have led to some original parameters becoming unavailable. For transparency and comparison, the original API spec has been saved as `openapi.orig.yaml`, and the modified file used for generation is `openapi.yaml`.

To view the specific changes made, you can use the command: `diff -Nru openapi.yaml openapi.orig.yaml`.

All automatically generated tests have been run and passed, ensuring the reliability of the modified spec.

## Ongoing Verification

It is acknowledged that with a better understanding of the `openapi-generator` options, it might be possible to generate the client from the original spec without modifications. This aspect is currently under continuous review and exploration.

## Usage and Contribution

We encourage users and developers to contribute to this repository, especially in improving the generation process and enhancing the library. Any updates or fixes that enable the use of the original spec file without modifications would be particularly valuable.

## Disclaimer

This client library is an independent effort and is not officially affiliated with OpenAI. Users should exercise due diligence and refer to OpenAI's official documentation and API guidelines for accurate information.

---

# openai-java-generated-client

OpenAI API

- API version: 2.3.0

    - Build date: 2024-10-30T01:20:46.396706715Z[Etc/UTC]

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

    For more information, please visit [https://help.openai.com/](https://help.openai.com/)

*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*

## Requirements

Building the API client library requires:

1. Java 1.8+

    2. Maven/Gradle

## Installation

To install the API client library to your local Maven repository, simply execute:

```shell

mvn clean install

```

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

```shell

mvn clean deploy

```

Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.

### Maven users

Add this dependency to your project's POM:

```xml

    com.github.ainoya

    openai-java-generated-client

    0.0.30

    compile

```

### Gradle users

Add this dependency to your project's build file:

```groovy

repositories {

mavenCentral()     // Needed if the 'openai-java-generated-client' jar has been published to maven central.

mavenLocal()       // Needed if the 'openai-java-generated-client' jar has been published to the local maven repo.

}

dependencies {

implementation "com.github.ainoya:openai-java-generated-client:0.0.30"

}

```

### Others

At first generate the JAR by executing:

```shell

mvn clean package

```

Then manually install the following JARs:

- `target/openai-java-generated-client-0.0.30.jar`

- `target/lib/*.jar`

## Getting Started

Please follow the [installation](#installation) instruction and execute the following Java code:

```java

    import com.github.ainoya.client.*;

    import com.github.ainoya.client.auth.*;

    import com.github.ainoya.client.model.*;

    import com.github.ainoya.openai.client.api.AssistantsApi;

    public class AssistantsApiExample {

    public static void main(String[] args) {

    ApiClient defaultClient = Configuration.getDefaultApiClient();

    defaultClient.setBasePath("https://api.openai.com/v1");

    

        // Configure HTTP bearer authorization: ApiKeyAuth

        HttpBearerAuth ApiKeyAuth = (HttpBearerAuth) defaultClient.getAuthentication("ApiKeyAuth");

        ApiKeyAuth.setBearerToken("BEARER TOKEN");

    AssistantsApi apiInstance = new AssistantsApi(defaultClient);

        String threadId = "threadId_example"; // String | The ID of the thread to which this run belongs.

        String runId = "runId_example"; // String | The ID of the run to cancel.

    try {

    RunObject result = apiInstance.cancelRun(threadId, runId);

        System.out.println(result);

    } catch (ApiException e) {

    System.err.println("Exception when calling AssistantsApi#cancelRun");

    System.err.println("Status code: " + e.getCode());

    System.err.println("Reason: " + e.getResponseBody());

    System.err.println("Response headers: " + e.getResponseHeaders());

    e.printStackTrace();

    }

    }

    }

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*AssistantsApi* | [**cancelRun**](docs/AssistantsApi.md#cancelRun) | **POST** /threads/{thread_id}/runs/{run_id}/cancel | Cancels a run that is `in_progress`.

*AssistantsApi* | [**createAssistant**](docs/AssistantsApi.md#createAssistant) | **POST** /assistants | Create an assistant with a model and instructions.

*AssistantsApi* | [**createMessage**](docs/AssistantsApi.md#createMessage) | **POST** /threads/{thread_id}/messages | Create a message.

*AssistantsApi* | [**createRun**](docs/AssistantsApi.md#createRun) | **POST** /threads/{thread_id}/runs | Create a run.

*AssistantsApi* | [**createThread**](docs/AssistantsApi.md#createThread) | **POST** /threads | Create a thread.

*AssistantsApi* | [**createThreadAndRun**](docs/AssistantsApi.md#createThreadAndRun) | **POST** /threads/runs | Create a thread and run it in one request.

*AssistantsApi* | [**deleteAssistant**](docs/AssistantsApi.md#deleteAssistant) | **DELETE** /assistants/{assistant_id} | Delete an assistant.

*AssistantsApi* | [**deleteMessage**](docs/AssistantsApi.md#deleteMessage) | **DELETE** /threads/{thread_id}/messages/{message_id} | Deletes a message.

*AssistantsApi* | [**deleteThread**](docs/AssistantsApi.md#deleteThread) | **DELETE** /threads/{thread_id} | Delete a thread.

*AssistantsApi* | [**getAssistant**](docs/AssistantsApi.md#getAssistant) | **GET** /assistants/{assistant_id} | Retrieves an assistant.

*AssistantsApi* | [**getMessage**](docs/AssistantsApi.md#getMessage) | **GET** /threads/{thread_id}/messages/{message_id} | Retrieve a message.

*AssistantsApi* | [**getRun**](docs/AssistantsApi.md#getRun) | **GET** /threads/{thread_id}/runs/{run_id} | Retrieves a run.

*AssistantsApi* | [**getRunStep**](docs/AssistantsApi.md#getRunStep) | **GET** /threads/{thread_id}/runs/{run_id}/steps/{step_id} | Retrieves a run step.

*AssistantsApi* | [**getThread**](docs/AssistantsApi.md#getThread) | **GET** /threads/{thread_id} | Retrieves a thread.

*AssistantsApi* | [**listAssistants**](docs/AssistantsApi.md#listAssistants) | **GET** /assistants | Returns a list of assistants.

*AssistantsApi* | [**listMessages**](docs/AssistantsApi.md#listMessages) | **GET** /threads/{thread_id}/messages | Returns a list of messages for a given thread.

*AssistantsApi* | [**listRunSteps**](docs/AssistantsApi.md#listRunSteps) | **GET** /threads/{thread_id}/runs/{run_id}/steps | Returns a list of run steps belonging to a run.

*AssistantsApi* | [**listRuns**](docs/AssistantsApi.md#listRuns) | **GET** /threads/{thread_id}/runs | Returns a list of runs belonging to a thread.

*AssistantsApi* | [**modifyAssistant**](docs/AssistantsApi.md#modifyAssistant) | **POST** /assistants/{assistant_id} | Modifies an assistant.

*AssistantsApi* | [**modifyMessage**](docs/AssistantsApi.md#modifyMessage) | **POST** /threads/{thread_id}/messages/{message_id} | Modifies a message.

*AssistantsApi* | [**modifyRun**](docs/AssistantsApi.md#modifyRun) | **POST** /threads/{thread_id}/runs/{run_id} | Modifies a run.

*AssistantsApi* | [**modifyThread**](docs/AssistantsApi.md#modifyThread) | **POST** /threads/{thread_id} | Modifies a thread.

*AssistantsApi* | [**submitToolOuputsToRun**](docs/AssistantsApi.md#submitToolOuputsToRun) | **POST** /threads/{thread_id}/runs/{run_id}/submit_tool_outputs | When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request. 

*AudioApi* | [**createSpeech**](docs/AudioApi.md#createSpeech) | **POST** /audio/speech | Generates audio from the input text.

*AudioApi* | [**createTranscription**](docs/AudioApi.md#createTranscription) | **POST** /audio/transcriptions | Transcribes audio into the input language.

*AudioApi* | [**createTranslation**](docs/AudioApi.md#createTranslation) | **POST** /audio/translations | Translates audio into English.

*AuditLogsApi* | [**listAuditLogs**](docs/AuditLogsApi.md#listAuditLogs) | **GET** /organization/audit_logs | List user actions and configuration changes within this organization.

*BatchApi* | [**cancelBatch**](docs/BatchApi.md#cancelBatch) | **POST** /batches/{batch_id}/cancel | Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes, before changing to `cancelled`, where it will have partial results (if any) available in the output file.

*BatchApi* | [**createBatch**](docs/BatchApi.md#createBatch) | **POST** /batches | Creates and executes a batch from an uploaded file of requests

*BatchApi* | [**listBatches**](docs/BatchApi.md#listBatches) | **GET** /batches | List your organization's batches.

*BatchApi* | [**retrieveBatch**](docs/BatchApi.md#retrieveBatch) | **GET** /batches/{batch_id} | Retrieves a batch.

*ChatApi* | [**createChatCompletion**](docs/ChatApi.md#createChatCompletion) | **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. 

*CompletionsApi* | [**createCompletion**](docs/CompletionsApi.md#createCompletion) | **POST** /completions | Creates a completion for the provided prompt and parameters.

*EmbeddingsApi* | [**createEmbedding**](docs/EmbeddingsApi.md#createEmbedding) | **POST** /embeddings | Creates an embedding vector representing the input text.

*FilesApi* | [**createFile**](docs/FilesApi.md#createFile) | **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 `.jsonl` 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 `.jsonl` files up to 100 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* | [**deleteFile**](docs/FilesApi.md#deleteFile) | **DELETE** /files/{file_id} | Delete a file.

*FilesApi* | [**downloadFile**](docs/FilesApi.md#downloadFile) | **GET** /files/{file_id}/content | Returns the contents of the specified file.

*FilesApi* | [**listFiles**](docs/FilesApi.md#listFiles) | **GET** /files | Returns a list of files that belong to the user's organization.

*FilesApi* | [**retrieveFile**](docs/FilesApi.md#retrieveFile) | **GET** /files/{file_id} | Returns information about a specific file.

*FineTuningApi* | [**cancelFineTuningJob**](docs/FineTuningApi.md#cancelFineTuningJob) | **POST** /fine_tuning/jobs/{fine_tuning_job_id}/cancel | Immediately cancel a fine-tune job. 

*FineTuningApi* | [**createFineTuningJob**](docs/FineTuningApi.md#createFineTuningJob) | **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* | [**listFineTuningEvents**](docs/FineTuningApi.md#listFineTuningEvents) | **GET** /fine_tuning/jobs/{fine_tuning_job_id}/events | Get status updates for a fine-tuning job. 

*FineTuningApi* | [**listFineTuningJobCheckpoints**](docs/FineTuningApi.md#listFineTuningJobCheckpoints) | **GET** /fine_tuning/jobs/{fine_tuning_job_id}/checkpoints | List checkpoints for a fine-tuning job. 

*FineTuningApi* | [**listPaginatedFineTuningJobs**](docs/FineTuningApi.md#listPaginatedFineTuningJobs) | **GET** /fine_tuning/jobs | List your organization's fine-tuning jobs 

*FineTuningApi* | [**retrieveFineTuningJob**](docs/FineTuningApi.md#retrieveFineTuningJob) | **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* | [**createImage**](docs/ImagesApi.md#createImage) | **POST** /images/generations | Creates an image given a prompt.

*ImagesApi* | [**createImageEdit**](docs/ImagesApi.md#createImageEdit) | **POST** /images/edits | Creates an edited or extended image given an original image and a prompt.

*ImagesApi* | [**createImageVariation**](docs/ImagesApi.md#createImageVariation) | **POST** /images/variations | Creates a variation of a given image.

*InvitesApi* | [**deleteInvite**](docs/InvitesApi.md#deleteInvite) | **DELETE** /organization/invites/{invite_id} | Delete an invite. If the invite has already been accepted, it cannot be deleted.

*InvitesApi* | [**inviteUser**](docs/InvitesApi.md#inviteUser) | **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* | [**listInvites**](docs/InvitesApi.md#listInvites) | **GET** /organization/invites | Returns a list of invites in the organization.

*InvitesApi* | [**retrieveInvite**](docs/InvitesApi.md#retrieveInvite) | **GET** /organization/invites/{invite_id} | Retrieves an invite.

*ModelsApi* | [**deleteModel**](docs/ModelsApi.md#deleteModel) | **DELETE** /models/{model} | Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.

*ModelsApi* | [**listModels**](docs/ModelsApi.md#listModels) | **GET** /models | Lists the currently available models, and provides basic information about each one such as the owner and availability.

*ModelsApi* | [**retrieveModel**](docs/ModelsApi.md#retrieveModel) | **GET** /models/{model} | Retrieves a model instance, providing basic information about the model such as the owner and permissioning.

*ModerationsApi* | [**createModeration**](docs/ModerationsApi.md#createModeration) | **POST** /moderations | Classifies if text and/or image inputs are potentially harmful. Learn more in the [moderation guide](/docs/guides/moderation). 

*ProjectsApi* | [**archiveProject**](docs/ProjectsApi.md#archiveProject) | **POST** /organization/projects/{project_id}/archive | Archives a project in the organization. Archived projects cannot be used or updated.

*ProjectsApi* | [**createProject**](docs/ProjectsApi.md#createProject) | **POST** /organization/projects | Create a new project in the organization. Projects can be created and archived, but cannot be deleted.

*ProjectsApi* | [**createProjectServiceAccount**](docs/ProjectsApi.md#createProjectServiceAccount) | **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* | [**createProjectUser**](docs/ProjectsApi.md#createProjectUser) | **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* | [**deleteProjectApiKey**](docs/ProjectsApi.md#deleteProjectApiKey) | **DELETE** /organization/projects/{project_id}/api_keys/{key_id} | Deletes an API key from the project.

*ProjectsApi* | [**deleteProjectServiceAccount**](docs/ProjectsApi.md#deleteProjectServiceAccount) | **DELETE** /organization/projects/{project_id}/service_accounts/{service_account_id} | Deletes a service account from the project.

*ProjectsApi* | [**deleteProjectUser**](docs/ProjectsApi.md#deleteProjectUser) | **DELETE** /organization/projects/{project_id}/users/{user_id} | Deletes a user from the project.

*ProjectsApi* | [**listProjectApiKeys**](docs/ProjectsApi.md#listProjectApiKeys) | **GET** /organization/projects/{project_id}/api_keys | Returns a list of API keys in the project.

*ProjectsApi* | [**listProjectServiceAccounts**](docs/ProjectsApi.md#listProjectServiceAccounts) | **GET** /organization/projects/{project_id}/service_accounts | Returns a list of service accounts in the project.

*ProjectsApi* | [**listProjectUsers**](docs/ProjectsApi.md#listProjectUsers) | **GET** /organization/projects/{project_id}/users | Returns a list of users in the project.

*ProjectsApi* | [**listProjects**](docs/ProjectsApi.md#listProjects) | **GET** /organization/projects | Returns a list of projects.

*ProjectsApi* | [**modifyProject**](docs/ProjectsApi.md#modifyProject) | **POST** /organization/projects/{project_id} | Modifies a project in the organization.

*ProjectsApi* | [**modifyProjectUser**](docs/ProjectsApi.md#modifyProjectUser) | **POST** /organization/projects/{project_id}/users/{user_id} | Modifies a user's role in the project.

*ProjectsApi* | [**retrieveProject**](docs/ProjectsApi.md#retrieveProject) | **GET** /organization/projects/{project_id} | Retrieves a project.

*ProjectsApi* | [**retrieveProjectApiKey**](docs/ProjectsApi.md#retrieveProjectApiKey) | **GET** /organization/projects/{project_id}/api_keys/{key_id} | Retrieves an API key in the project.

*ProjectsApi* | [**retrieveProjectServiceAccount**](docs/ProjectsApi.md#retrieveProjectServiceAccount) | **GET** /organization/projects/{project_id}/service_accounts/{service_account_id} | Retrieves a service account in the project.

*ProjectsApi* | [**retrieveProjectUser**](docs/ProjectsApi.md#retrieveProjectUser) | **GET** /organization/projects/{project_id}/users/{user_id} | Retrieves a user in the project.

*UploadsApi* | [**addUploadPart**](docs/UploadsApi.md#addUploadPart) | **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* | [**cancelUpload**](docs/UploadsApi.md#cancelUpload) | **POST** /uploads/{upload_id}/cancel | Cancels the Upload. No Parts may be added after an Upload is cancelled. 

*UploadsApi* | [**completeUpload**](docs/UploadsApi.md#completeUpload) | **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* | [**createUpload**](docs/UploadsApi.md#createUpload) | **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 `purpose`s, the correct `mime_type` 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). 

*UsersApi* | [**deleteUser**](docs/UsersApi.md#deleteUser) | **DELETE** /organization/users/{user_id} | Deletes a user from the organization.

*UsersApi* | [**listUsers**](docs/UsersApi.md#listUsers) | **GET** /organization/users | Lists all of the users in the organization.

*UsersApi* | [**modifyUser**](docs/UsersApi.md#modifyUser) | **POST** /organization/users/{user_id} | Modifies a user's role in the organization.

*UsersApi* | [**retrieveUser**](docs/UsersApi.md#retrieveUser) | **GET** /organization/users/{user_id} | Retrieves a user by their identifier.

*VectorStoresApi* | [**cancelVectorStoreFileBatch**](docs/VectorStoresApi.md#cancelVectorStoreFileBatch) | **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* | [**createVectorStore**](docs/VectorStoresApi.md#createVectorStore) | **POST** /vector_stores | Create a vector store.

*VectorStoresApi* | [**createVectorStoreFile**](docs/VectorStoresApi.md#createVectorStoreFile) | **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* | [**createVectorStoreFileBatch**](docs/VectorStoresApi.md#createVectorStoreFileBatch) | **POST** /vector_stores/{vector_store_id}/file_batches | Create a vector store file batch.

*VectorStoresApi* | [**deleteVectorStore**](docs/VectorStoresApi.md#deleteVectorStore) | **DELETE** /vector_stores/{vector_store_id} | Delete a vector store.

*VectorStoresApi* | [**deleteVectorStoreFile**](docs/VectorStoresApi.md#deleteVectorStoreFile) | **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* | [**getVectorStore**](docs/VectorStoresApi.md#getVectorStore) | **GET** /vector_stores/{vector_store_id} | Retrieves a vector store.

*VectorStoresApi* | [**getVectorStoreFile**](docs/VectorStoresApi.md#getVectorStoreFile) | **GET** /vector_stores/{vector_store_id}/files/{file_id} | Retrieves a vector store file.

*VectorStoresApi* | [**getVectorStoreFileBatch**](docs/VectorStoresApi.md#getVectorStoreFileBatch) | **GET** /vector_stores/{vector_store_id}/file_batches/{batch_id} | Retrieves a vector store file batch.

*VectorStoresApi* | [**listFilesInVectorStoreBatch**](docs/VectorStoresApi.md#listFilesInVectorStoreBatch) | **GET** /vector_stores/{vector_store_id}/file_batches/{batch_id}/files | Returns a list of vector store files in a batch.

*VectorStoresApi* | [**listVectorStoreFiles**](docs/VectorStoresApi.md#listVectorStoreFiles) | **GET** /vector_stores/{vector_store_id}/files | Returns a list of vector store files.

*VectorStoresApi* | [**listVectorStores**](docs/VectorStoresApi.md#listVectorStores) | **GET** /vector_stores | Returns a list of vector stores.

*VectorStoresApi* | [**modifyVectorStore**](docs/VectorStoresApi.md#modifyVectorStore) | **POST** /vector_stores/{vector_store_id} | Modifies a vector store.

## Documentation for Models

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

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

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

 - [ChatCompletionRequestSystemMessageContentPart](docs/ChatCompletionRequestSystemMessageContentPart.md)

 - [ChatCompletionRequestToolMessage](docs/ChatCompletionRequestToolMessage.md)

 - [ChatCompletionRequestToolMessageContent](docs/ChatCompletionRequestToolMessageContent.md)

 - [ChatCompletionRequestToolMessageContentPart](docs/ChatCompletionRequestToolMessageContentPart.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)

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

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

 - [CreateFineTuningJobRequestIntegrationsInnerType](docs/CreateFineTuningJobRequestIntegrationsInnerType.md)

 - [CreateFineTuningJobRequestIntegrationsInnerWandb](docs/CreateFineTuningJobRequestIntegrationsInnerWandb.md)

 - [CreateFineTuningJobRequestModel](docs/CreateFineTuningJobRequestModel.md)

 - [CreateImageEditRequestModel](docs/CreateImageEditRequestModel.md)

 - [CreateImageRequest](docs/CreateImageRequest.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)

 - [CreateModerationResponse](docs/CreateModerationResponse.md)

 - [CreateModerationResponseResultsInner](docs/CreateModerationResponseResultsInner.md)

 - [CreateModerationResponseResultsInnerCategories](docs/CreateModerationResponseResultsInnerCategories.md)

 - [CreateModerationResponseResultsInnerCategoryAppliedInputTypes](docs/CreateModerationResponseResultsInnerCategoryAppliedInputTypes.md)

 - [CreateModerationResponseResultsInnerCategoryScores](docs/CreateModerationResponseResultsInnerCategoryScores.md)

 - [CreateRunRequest](docs/CreateRunRequest.md)

 - [CreateSpeechRequest](docs/CreateSpeechRequest.md)

 - [CreateThreadAndRunRequest](docs/CreateThreadAndRunRequest.md)

 - [CreateThreadAndRunRequestToolResources](docs/CreateThreadAndRunRequestToolResources.md)

 - [CreateThreadAndRunRequestToolsInner](docs/CreateThreadAndRunRequestToolsInner.md)

 - [CreateThreadRequest](docs/CreateThreadRequest.md)

 - [CreateThreadRequestToolResources](docs/CreateThreadRequestToolResources.md)

 - [CreateThreadRequestToolResourcesFileSearch](docs/CreateThreadRequestToolResourcesFileSearch.md)

 - [CreateThreadRequestToolResourcesFileSearchVectorStoresInner](docs/CreateThreadRequestToolResourcesFileSearchVectorStoresInner.md)

 - [CreateTranscription200Response](docs/CreateTranscription200Response.md)

 - [CreateTranscriptionRequestModel](docs/CreateTranscriptionRequestModel.md)

 - [CreateTranscriptionResponseJson](docs/CreateTranscriptionResponseJson.md)

 - [CreateTranscriptionResponseVerboseJson](docs/CreateTranscriptionResponseVerboseJson.md)

 - [CreateTranslation200Response](docs/CreateTranslation200Response.md)

 - [CreateTranslationResponseJson](docs/CreateTranslationResponseJson.md)

 - [CreateTranslationResponseVerboseJson](docs/CreateTranslationResponseVerboseJson.md)

 - [CreateUploadRequest](docs/CreateUploadRequest.md)

 - [CreateVectorStoreFileBatchRequest](docs/CreateVectorStoreFileBatchRequest.md)

 - [CreateVectorStoreFileRequest](docs/CreateVectorStoreFileRequest.md)

 - [CreateVectorStoreRequest](docs/CreateVectorStoreRequest.md)

 - [CreateVectorStoreRequestChunkingStrategy](docs/CreateVectorStoreRequestChunkingStrategy.md)

 - [DefaultProjectErrorResponse](docs/DefaultProjectErrorResponse.md)

 - [DeleteAssistantResponse](docs/DeleteAssistantResponse.md)

 - [DeleteFileResponse](docs/DeleteFileResponse.md)

 - [DeleteMessageResponse](docs/DeleteMessageResponse.md)

 - [DeleteModelResponse](docs/DeleteModelResponse.md)

 - [DeleteThreadResponse](docs/DeleteThreadResponse.md)

 - [DeleteVectorStoreFileResponse](docs/DeleteVectorStoreFileResponse.md)

 - [DeleteVectorStoreResponse](docs/DeleteVectorStoreResponse.md)

 - [DoneEvent](docs/DoneEvent.md)

 - [Embedding](docs/Embedding.md)

 - [Error](docs/Error.md)

 - [ErrorEvent](docs/ErrorEvent.md)

 - [ErrorResponse](docs/ErrorResponse.md)

 - [FileSearchRankingOptions](docs/FileSearchRankingOptions.md)

 - [FineTuneChatCompletionRequestAssistantMessage](docs/FineTuneChatCompletionRequestAssistantMessage.md)

 - [FineTuningIntegration](docs/FineTuningIntegration.md)

 - [FineTuningJob](docs/FineTuningJob.md)

 - [FineTuningJobCheckpoint](docs/FineTuningJobCheckpoint.md)

 - [FineTuningJobCheckpointMetrics](docs/FineTuningJobCheckpointMetrics.md)

 - [FineTuningJobError](docs/FineTuningJobError.md)

 - [FineTuningJobEvent](docs/FineTuningJobEvent.md)

 - [FineTuningJobHyperparameters](docs/FineTuningJobHyperparameters.md)

 - [FineTuningJobHyperparametersNEpochs](docs/FineTuningJobHyperparametersNEpochs.md)

 - [FineTuningJobIntegrationsInner](docs/FineTuningJobIntegrationsInner.md)

 - [FinetuneChatRequestInput](docs/FinetuneChatRequestInput.md)

 - [FinetuneChatRequestInputMessagesInner](docs/FinetuneChatRequestInputMessagesInner.md)

 - [FinetuneCompletionRequestInput](docs/FinetuneCompletionRequestInput.md)

 - [FunctionObject](docs/FunctionObject.md)

 - [Image](docs/Image.md)

 - [ImagesResponse](docs/ImagesResponse.md)

 - [Invite](docs/Invite.md)

 - [InviteDeleteResponse](docs/InviteDeleteResponse.md)

 - [InviteListResponse](docs/InviteListResponse.md)

 - [InviteRequest](docs/InviteRequest.md)

 - [ListAssistantsResponse](docs/ListAssistantsResponse.md)

 - [ListAuditLogsEffectiveAtParameter](docs/ListAuditLogsEffectiveAtParameter.md)

 - [ListAuditLogsResponse](docs/ListAuditLogsResponse.md)

 - [ListBatchesResponse](docs/ListBatchesResponse.md)

 - [ListFilesResponse](docs/ListFilesResponse.md)

 - [ListFineTuningJobCheckpointsResponse](docs/ListFineTuningJobCheckpointsResponse.md)

 - [ListFineTuningJobEventsResponse](docs/ListFineTuningJobEventsResponse.md)

 - [ListMessagesResponse](docs/ListMessagesResponse.md)

 - [ListModelsResponse](docs/ListModelsResponse.md)

 - [ListPaginatedFineTuningJobsResponse](docs/ListPaginatedFineTuningJobsResponse.md)

 - [ListRunStepsResponse](docs/ListRunStepsResponse.md)

 - [ListRunsResponse](docs/ListRunsResponse.md)

 - [ListThreadsResponse](docs/ListThreadsResponse.md)

 - [ListVectorStoreFilesResponse](docs/ListVectorStoreFilesResponse.md)

 - [ListVectorStoresResponse](docs/ListVectorStoresResponse.md)

 - [MessageContentImageFileObject](docs/MessageContentImageFileObject.md)

 - [MessageContentImageFileObjectImageFile](docs/MessageContentImageFileObjectImageFile.md)

 - [MessageContentImageUrlObject](docs/MessageContentImageUrlObject.md)

 - [MessageContentImageUrlObjectImageUrl](docs/MessageContentImageUrlObjectImageUrl.md)

 - [MessageContentRefusalObject](docs/MessageContentRefusalObject.md)

 - [MessageContentTextAnnotationsFileCitationObject](docs/MessageContentTextAnnotationsFileCitationObject.md)

 - [MessageContentTextAnnotationsFileCitationObjectFileCitation](docs/MessageContentTextAnnotationsFileCitationObjectFileCitation.md)

 - [MessageContentTextAnnotationsFilePathObject](docs/MessageContentTextAnnotationsFilePathObject.md)

 - [MessageContentTextAnnotationsFilePathObjectFilePath](docs/MessageContentTextAnnotationsFilePathObjectFilePath.md)

 - [MessageContentTextObject](docs/MessageContentTextObject.md)

 - [MessageContentTextObjectText](docs/MessageContentTextObjectText.md)

 - [MessageContentTextObjectTextAnnotationsInner](docs/MessageContentTextObjectTextAnnotationsInner.md)

 - [MessageDeltaContentImageFileObject](docs/MessageDeltaContentImageFileObject.md)

 - [MessageDeltaContentImageFileObjectImageFile](docs/MessageDeltaContentImageFileObjectImageFile.md)

 - [MessageDeltaContentImageUrlObject](docs/MessageDeltaContentImageUrlObject.md)

 - [MessageDeltaContentImageUrlObjectImageUrl](docs/MessageDeltaContentImageUrlObjectImageUrl.md)

 - [MessageDeltaContentRefusalObject](docs/MessageDeltaContentRefusalObject.md)

 - [MessageDeltaContentTextAnnotationsFileCitationObject](docs/MessageDeltaContentTextAnnotationsFileCitationObject.md)

 - [MessageDeltaContentTextAnnotationsFileCitationObjectFileCitation](docs/MessageDeltaContentTextAnnotationsFileCitationObjectFileCitation.md)

 - [MessageDeltaContentTextAnnotationsFilePathObject](docs/MessageDeltaContentTextAnnotationsFilePathObject.md)

 - [MessageDeltaContentTextAnnotationsFilePathObjectFilePath](docs/MessageDeltaContentTextAnnotationsFilePathObjectFilePath.md)

 - [MessageDeltaContentTextObject](docs/MessageDeltaContentTextObject.md)

 - [MessageDeltaContentTextObjectText](docs/MessageDeltaContentTextObjectText.md)

 - [MessageDeltaContentTextObjectTextAnnotationsInner](docs/MessageDeltaContentTextObjectTextAnnotationsInner.md)

 - [MessageDeltaObject](docs/MessageDeltaObject.md)

 - [MessageDeltaObjectDelta](docs/MessageDeltaObjectDelta.md)

 - [MessageDeltaObjectDeltaContentInner](docs/MessageDeltaObjectDeltaContentInner.md)

 - [MessageObject](docs/MessageObject.md)

 - [MessageObjectContentInner](docs/MessageObjectContentInner.md)

 - [MessageObjectIncompleteDetails](docs/MessageObjectIncompleteDetails.md)

 - [MessageRequestContentTextObject](docs/MessageRequestContentTextObject.md)

 - [MessageStreamEvent](docs/MessageStreamEvent.md)

 - [MessageStreamEventOneOf](docs/MessageStreamEventOneOf.md)

 - [MessageStreamEventOneOf1](docs/MessageStreamEventOneOf1.md)

 - [MessageStreamEventOneOf2](docs/MessageStreamEventOneOf2.md)

 - [MessageStreamEventOneOf3](docs/MessageStreamEventOneOf3.md)

 - [MessageStreamEventOneOf4](docs/MessageStreamEventOneOf4.md)

 - [Model](docs/Model.md)

 - [ModifyAssistantRequest](docs/ModifyAssistantRequest.md)

 - [ModifyAssistantRequestToolResources](docs/ModifyAssistantRequestToolResources.md)

 - [ModifyAssistantRequestToolResourcesCodeInterpreter](docs/ModifyAssistantRequestToolResourcesCodeInterpreter.md)

 - [ModifyAssistantRequestToolResourcesFileSearch](docs/ModifyAssistantRequestToolResourcesFileSearch.md)

 - [ModifyMessageRequest](docs/ModifyMessageRequest.md)

 - [ModifyRunRequest](docs/ModifyRunRequest.md)

 - [ModifyThreadRequest](docs/ModifyThreadRequest.md)

 - [ModifyThreadRequestToolResources](docs/ModifyThreadRequestToolResources.md)

 - [ModifyThreadRequestToolResourcesFileSearch](docs/ModifyThreadRequestToolResourcesFileSearch.md)

 - [OpenAIFile](docs/OpenAIFile.md)

 - [OtherChunkingStrategyResponseParam](docs/OtherChunkingStrategyResponseParam.md)

 - [Project](docs/Project.md)

 - [ProjectApiKey](docs/ProjectApiKey.md)

 - [ProjectApiKeyDeleteResponse](docs/ProjectApiKeyDeleteResponse.md)

 - [ProjectApiKeyListResponse](docs/ProjectApiKeyListResponse.md)

 - [ProjectApiKeyOwner](docs/ProjectApiKeyOwner.md)

 - [ProjectCreateRequest](docs/ProjectCreateRequest.md)

 - [ProjectListResponse](docs/ProjectListResponse.md)

 - [ProjectServiceAccount](docs/ProjectServiceAccount.md)

 - [ProjectServiceAccountApiKey](docs/ProjectServiceAccountApiKey.md)

 - [ProjectServiceAccountCreateRequest](docs/ProjectServiceAccountCreateRequest.md)

 - [ProjectServiceAccountCreateResponse](docs/ProjectServiceAccountCreateResponse.md)

 - [ProjectServiceAccountDeleteResponse](docs/ProjectServiceAccountDeleteResponse.md)

 - [ProjectServiceAccountListResponse](docs/ProjectServiceAccountListResponse.md)

 - [ProjectUpdateRequest](docs/ProjectUpdateRequest.md)

 - [ProjectUser](docs/ProjectUser.md)

 - [ProjectUserCreateRequest](docs/ProjectUserCreateRequest.md)

 - [ProjectUserDeleteResponse](docs/ProjectUserDeleteResponse.md)

 - [ProjectUserListResponse](docs/ProjectUserListResponse.md)

 - [ProjectUserUpdateRequest](docs/ProjectUserUpdateRequest.md)

 - [RealtimeClientEventConversationItemCreate](docs/RealtimeClientEventConversationItemCreate.md)

 - [RealtimeClientEventConversationItemCreateItem](docs/RealtimeClientEventConversationItemCreateItem.md)

 - [RealtimeClientEventConversationItemCreateItemContentInner](docs/RealtimeClientEventConversationItemCreateItemContentInner.md)

 - [RealtimeClientEventConversationItemDelete](docs/RealtimeClientEventConversationItemDelete.md)

 - [RealtimeClientEventConversationItemTruncate](docs/RealtimeClientEventConversationItemTruncate.md)

 - [RealtimeClientEventInputAudioBufferAppend](docs/RealtimeClientEventInputAudioBufferAppend.md)

 - [RealtimeClientEventInputAudioBufferClear](docs/RealtimeClientEventInputAudioBufferClear.md)

 - [RealtimeClientEventInputAudioBufferCommit](docs/RealtimeClientEventInputAudioBufferCommit.md)

 - [RealtimeClientEventResponseCancel](docs/RealtimeClientEventResponseCancel.md)

 - [RealtimeClientEventResponseCreate](docs/RealtimeClientEventResponseCreate.md)

 - [RealtimeClientEventResponseCreateResponse](docs/RealtimeClientEventResponseCreateResponse.md)

 - [RealtimeClientEventResponseCreateResponseMaxOutputTokens](docs/RealtimeClientEventResponseCreateResponseMaxOutputTokens.md)

 - [RealtimeClientEventResponseCreateResponseToolsInner](docs/RealtimeClientEventResponseCreateResponseToolsInner.md)

 - [RealtimeClientEventSessionUpdate](docs/RealtimeClientEventSessionUpdate.md)

 - [RealtimeClientEventSessionUpdateSession](docs/RealtimeClientEventSessionUpdateSession.md)

 - [RealtimeClientEventSessionUpdateSessionInputAudioTranscription](docs/RealtimeClientEventSessionUpdateSessionInputAudioTranscription.md)

 - [RealtimeClientEventSessionUpdateSessionToolsInner](docs/RealtimeClientEventSessionUpdateSessionToolsInner.md)

 - [RealtimeClientEventSessionUpdateSessionTurnDetection](docs/RealtimeClientEventSessionUpdateSessionTurnDetection.md)

 - [RealtimeServerEventConversationCreated](docs/RealtimeServerEventConversationCreated.md)

 - [RealtimeServerEventConversationCreatedConversation](docs/RealtimeServerEventConversationCreatedConversation.md)

 - [RealtimeServerEventConversationItemCreated](docs/RealtimeServerEventConversationItemCreated.md)

 - [RealtimeServerEventConversationItemCreatedItem](docs/RealtimeServerEventConversationItemCreatedItem.md)

 - [RealtimeServerEventConversationItemCreatedItemContentInner](docs/RealtimeServerEventConversationItemCreatedItemContentInner.md)

 - [RealtimeServerEventConversationItemDeleted](docs/RealtimeServerEventConversationItemDeleted.md)

 - [RealtimeServerEventConversationItemInputAudioTranscriptionCompleted](docs/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted.md)

 - [RealtimeServerEventConversationItemInputAudioTranscriptionFailed](docs/RealtimeServerEventConversationItemInputAudioTranscriptionFailed.md)

 - [RealtimeServerEventConversationItemInputAudioTranscriptionFailedError](docs/RealtimeServerEventConversationItemInputAudioTranscriptionFailedError.md)

 - [RealtimeServerEventConversationItemTruncated](docs/RealtimeServerEventConversationItemTruncated.md)

 - [RealtimeServerEventError](docs/RealtimeServerEventError.md)

 - [RealtimeServerEventErrorError](docs/RealtimeServerEventErrorError.md)

 - [RealtimeServerEventInputAudioBufferCleared](docs/RealtimeServerEventInputAudioBufferCleared.md)

 - [RealtimeServerEventInputAudioBufferCommitted](docs/RealtimeServerEventInputAudioBufferCommitted.md)

 - [RealtimeServerEventInputAudioBufferSpeechStarted](docs/RealtimeServerEventInputAudioBufferSpeechStarted.md)

 - [RealtimeServerEventInputAudioBufferSpeechStopped](docs/RealtimeServerEventInputAudioBufferSpeechStopped.md)

 - [RealtimeServerEventRateLimitsUpdated](docs/RealtimeServerEventRateLimitsUpdated.md)

 - [RealtimeServerEventRateLimitsUpdatedRateLimitsInner](docs/RealtimeServerEventRateLimitsUpdatedRateLimitsInner.md)

 - [RealtimeServerEventResponseAudioDelta](docs/RealtimeServerEventResponseAudioDelta.md)

 - [RealtimeServerEventResponseAudioDone](docs/RealtimeServerEventResponseAudioDone.md)

 - [RealtimeServerEventResponseAudioTranscriptDelta](docs/RealtimeServerEventResponseAudioTranscriptDelta.md)

 - [RealtimeServerEventResponseAudioTranscriptDone](docs/RealtimeServerEventResponseAudioTranscriptDone.md)

 - [RealtimeServerEventResponseContentPartAdded](docs/RealtimeServerEventResponseContentPartAdded.md)

 - [RealtimeServerEventResponseContentPartAddedPart](docs/RealtimeServerEventResponseContentPartAddedPart.md)

 - [RealtimeServerEventResponseContentPartDone](docs/RealtimeServerEventResponseContentPartDone.md)

 - [RealtimeServerEventResponseContentPartDonePart](docs/RealtimeServerEventResponseContentPartDonePart.md)

 - [RealtimeServerEventResponseCreated](docs/RealtimeServerEventResponseCreated.md)

 - [RealtimeServerEventResponseCreatedResponse](docs/RealtimeServerEventResponseCreatedResponse.md)

 - [RealtimeServerEventResponseDone](docs/RealtimeServerEventResponseDone.md)

 - [RealtimeServerEventResponseDoneResponse](docs/RealtimeServerEventResponseDoneResponse.md)

 - [RealtimeServerEventResponseFunctionCallArgumentsDelta](docs/RealtimeServerEventResponseFunctionCallArgumentsDelta.md)

 - [RealtimeServerEventResponseFunctionCallArgumentsDone](docs/RealtimeServerEventResponseFunctionCallArgumentsDone.md)

 - [RealtimeServerEventResponseOutputItemAdded](docs/RealtimeServerEventResponseOutputItemAdded.md)

 - [RealtimeServerEventResponseOutputItemAddedItem](docs/RealtimeServerEventResponseOutputItemAddedItem.md)

 - [RealtimeServerEventResponseOutputItemAddedItemContentInner](docs/RealtimeServerEventResponseOutputItemAddedItemContentInner.md)

 - [RealtimeServerEventResponseOutputItemDone](docs/RealtimeServerEventResponseOutputItemDone.md)

 - [RealtimeServerEventResponseOutputItemDoneItem](docs/RealtimeServerEventResponseOutputItemDoneItem.md)

 - [RealtimeServerEventResponseTextDelta](docs/RealtimeServerEventResponseTextDelta.md)

 - [RealtimeServerEventResponseTextDone](docs/RealtimeServerEventResponseTextDone.md)

 - [RealtimeServerEventSessionCreated](docs/RealtimeServerEventSessionCreated.md)

 - [RealtimeServerEventSessionCreatedSession](docs/RealtimeServerEventSessionCreatedSession.md)

 - [RealtimeServerEventSessionCreatedSessionInputAudioTranscription](docs/RealtimeServerEventSessionCreatedSessionInputAudioTranscription.md)

 - [RealtimeServerEventSessionCreatedSessionMaxOutputTokens](docs/RealtimeServerEventSessionCreatedSessionMaxOutputTokens.md)

 - [RealtimeServerEventSessionCreatedSessionTurnDetection](docs/RealtimeServerEventSessionCreatedSessionTurnDetection.md)

 - [RealtimeServerEventSessionUpdated](docs/RealtimeServerEventSessionUpdated.md)

 - [RealtimeServerEventSessionUpdatedSession](docs/RealtimeServerEventSessionUpdatedSession.md)

 - [ResponseFormatJsonObject](docs/ResponseFormatJsonObject.md)

 - [ResponseFormatJsonSchema](docs/ResponseFormatJsonSchema.md)

 - [ResponseFormatJsonSchemaJsonSchema](docs/ResponseFormatJsonSchemaJsonSchema.md)

 - [ResponseFormatText](docs/ResponseFormatText.md)

 - [RunCompletionUsage](docs/RunCompletionUsage.md)

 - [RunObject](docs/RunObject.md)

 - [RunObjectIncompleteDetails](docs/RunObjectIncompleteDetails.md)

 - [RunObjectLastError](docs/RunObjectLastError.md)

 - [RunObjectRequiredAction](docs/RunObjectRequiredAction.md)

 - [RunObjectRequiredActionSubmitToolOutputs](docs/RunObjectRequiredActionSubmitToolOutputs.md)

 - [RunStepCompletionUsage](docs/RunStepCompletionUsage.md)

 - [RunStepDeltaObject](docs/RunStepDeltaObject.md)

 - [RunStepDeltaObjectDelta](docs/RunStepDeltaObjectDelta.md)

 - [RunStepDeltaObjectDeltaStepDetails](docs/RunStepDeltaObjectDeltaStepDetails.md)

 - [RunStepDeltaStepDetailsMessageCreationObject](docs/RunStepDeltaStepDetailsMessageCreationObject.md)

 - [RunStepDeltaStepDetailsMessageCreationObjectMessageCreation](docs/RunStepDeltaStepDetailsMessageCreationObjectMessageCreation.md)

 - [RunStepDeltaStepDetailsToolCallsCodeObject](docs/RunStepDeltaStepDetailsToolCallsCodeObject.md)

 - [RunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreter](docs/RunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreter.md)

 - [RunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreterOutputsInner](docs/RunStepDeltaStepDetailsToolCallsCodeObjectCodeInterpreterOutputsInner.md)

 - [RunStepDeltaStepDetailsToolCallsCodeOutputImageObject](docs/RunStepDeltaStepDetailsToolCallsCodeOutputImageObject.md)

 - [RunStepDeltaStepDetailsToolCallsCodeOutputImageObjectImage](docs/RunStepDeltaStepDetailsToolCallsCodeOutputImageObjectImage.md)

 - [RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject](docs/RunStepDeltaStepDetailsToolCallsCodeOutputLogsObject.md)

 - [RunStepDeltaStepDetailsToolCallsFileSearchObject](docs/RunStepDeltaStepDetailsToolCallsFileSearchObject.md)

 - [RunStepDeltaStepDetailsToolCallsFunctionObject](docs/RunStepDeltaStepDetailsToolCallsFunctionObject.md)

 - [RunStepDeltaStepDetailsToolCallsFunctionObjectFunction](docs/RunStepDeltaStepDetailsToolCallsFunctionObjectFunction.md)

 - [RunStepDeltaStepDetailsToolCallsObject](docs/RunStepDeltaStepDetailsToolCallsObject.md)

 - [RunStepDeltaStepDetailsToolCallsObjectToolCallsInner](docs/RunStepDeltaStepDetailsToolCallsObjectToolCallsInner.md)

 - [RunStepDetailsMessageCreationObject](docs/RunStepDetailsMessageCreationObject.md)

 - [RunStepDetailsMessageCreationObjectMessageCreation](docs/RunStepDetailsMessageCreationObjectMessageCreation.md)

 - [RunStepDetailsToolCallsCodeObject](docs/RunStepDetailsToolCallsCodeObject.md)

 - [RunStepDetailsToolCallsCodeObjectCodeInterpreter](docs/RunStepDetailsToolCallsCodeObjectCodeInterpreter.md)

 - [RunStepDetailsToolCallsCodeObjectCodeInterpreterOutputsInner](docs/RunStepDetailsToolCallsCodeObjectCodeInterpreterOutputsInner.md)

 - [RunStepDetailsToolCallsCodeOutputImageObject](docs/RunStepDetailsToolCallsCodeOutputImageObject.md)

 - [RunStepDetailsToolCallsCodeOutputImageObjectImage](docs/RunStepDetailsToolCallsCodeOutputImageObjectImage.md)

 - [RunStepDetailsToolCallsCodeOutputLogsObject](docs/RunStepDetailsToolCallsCodeOutputLogsObject.md)

 - [RunStepDetailsToolCallsFileSearchObject](docs/RunStepDetailsToolCallsFileSearchObject.md)

 - [RunStepDetailsToolCallsFileSearchObjectFileSearch](docs/RunStepDetailsToolCallsFileSearchObjectFileSearch.md)

 - [RunStepDetailsToolCallsFileSearchRankingOptionsObject](docs/RunStepDetailsToolCallsFileSearchRankingOptionsObject.md)

 - [RunStepDetailsToolCallsFileSearchResultObject](docs/RunStepDetailsToolCallsFileSearchResultObject.md)

 - [RunStepDetailsToolCallsFileSearchResultObjectContentInner](docs/RunStepDetailsToolCallsFileSearchResultObjectContentInner.md)

 - [RunStepDetailsToolCallsFunctionObject](docs/RunStepDetailsToolCallsFunctionObject.md)

 - [RunStepDetailsToolCallsFunctionObjectFunction](docs/RunStepDetailsToolCallsFunctionObjectFunction.md)

 - [RunStepDetailsToolCallsObject](docs/RunStepDetailsToolCallsObject.md)

 - [RunStepDetailsToolCallsObjectToolCallsInner](docs/RunStepDetailsToolCallsObjectToolCallsInner.md)

 - [RunStepObject](docs/RunStepObject.md)

 - [RunStepObjectLastError](docs/RunStepObjectLastError.md)

 - [RunStepObjectStepDetails](docs/RunStepObjectStepDetails.md)

 - [RunStepStreamEvent](docs/RunStepStreamEvent.md)

 - [RunStepStreamEventOneOf](docs/RunStepStreamEventOneOf.md)

 - [RunStepStreamEventOneOf1](docs/RunStepStreamEventOneOf1.md)

 - [RunStepStreamEventOneOf2](docs/RunStepStreamEventOneOf2.md)

 - [RunStepStreamEventOneOf3](docs/RunStepStreamEventOneOf3.md)

 - [RunStepStreamEventOneOf4](docs/RunStepStreamEventOneOf4.md)

 - [RunStepStreamEventOneOf5](docs/RunStepStreamEventOneOf5.md)

 - [RunStepStreamEventOneOf6](docs/RunStepStreamEventOneOf6.md)

 - [RunStreamEvent](docs/RunStreamEvent.md)

 - [RunStreamEventOneOf](docs/RunStreamEventOneOf.md)

 - [RunStreamEventOneOf1](docs/RunStreamEventOneOf1.md)

 - [RunStreamEventOneOf2](docs/RunStreamEventOneOf2.md)

 - [RunStreamEventOneOf3](docs/RunStreamEventOneOf3.md)

 - [RunStreamEventOneOf4](docs/RunStreamEventOneOf4.md)

 - [RunStreamEventOneOf5](docs/RunStreamEventOneOf5.md)

 - [RunStreamEventOneOf6](docs/RunStreamEventOneOf6.md)

 - [RunStreamEventOneOf7](docs/RunStreamEventOneOf7.md)

 - [RunStreamEventOneOf8](docs/RunStreamEventOneOf8.md)

 - [RunStreamEventOneOf9](docs/RunStreamEventOneOf9.md)

 - [RunToolCallObject](docs/RunToolCallObject.md)

 - [RunToolCallObjectFunction](docs/RunToolCallObjectFunction.md)

 - [StaticChunkingStrategy](docs/StaticChunkingStrategy.md)

 - [StaticChunkingStrategyRequestParam](docs/StaticChunkingStrategyRequestParam.md)

 - [StaticChunkingStrategyResponseParam](docs/StaticChunkingStrategyResponseParam.md)

 - [StaticChunkingStrategyStatic](docs/StaticChunkingStrategyStatic.md)

 - [SubmitToolOutputsRunRequest](docs/SubmitToolOutputsRunRequest.md)

 - [SubmitToolOutputsRunRequestToolOutputsInner](docs/SubmitToolOutputsRunRequestToolOutputsInner.md)

 - [ThreadObject](docs/ThreadObject.md)

 - [ThreadStreamEvent](docs/ThreadStreamEvent.md)

 - [ThreadStreamEventOneOf](docs/ThreadStreamEventOneOf.md)

 - [TranscriptionSegment](docs/TranscriptionSegment.md)

 - [TranscriptionWord](docs/TranscriptionWord.md)

 - [TruncationObject](docs/TruncationObject.md)

 - [UpdateVectorStoreRequest](docs/UpdateVectorStoreRequest.md)

 - [Upload](docs/Upload.md)

 - [UploadPart](docs/UploadPart.md)

 - [User](docs/User.md)

 - [UserDeleteResponse](docs/UserDeleteResponse.md)

 - [UserListResponse](docs/UserListResponse.md)

 - [UserRoleUpdateRequest](docs/UserRoleUpdateRequest.md)

 - [VectorStoreExpirationAfter](docs/VectorStoreExpirationAfter.md)

 - [VectorStoreFileBatchObject](docs/VectorStoreFileBatchObject.md)

 - [VectorStoreFileBatchObjectFileCounts](docs/VectorStoreFileBatchObjectFileCounts.md)

 - [VectorStoreFileObject](docs/VectorStoreFileObject.md)

 - [VectorStoreFileObjectChunkingStrategy](docs/VectorStoreFileObjectChunkingStrategy.md)

 - [VectorStoreFileObjectLastError](docs/VectorStoreFileObjectLastError.md)

 - [VectorStoreObject](docs/VectorStoreObject.md)

 - [VectorStoreObjectFileCounts](docs/VectorStoreObjectFileCounts.md)



## Documentation for Authorization

Authentication schemes defined for the API:

    

    ### ApiKeyAuth

        - **Type**: HTTP Bearer Token authentication

## Recommendation

It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.

## Author
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/ainoya/openai-java-generated-client

Awesome Lists containing this project

README
