> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# Openai connector

- Connector: `appmixer.openai`
- Version: 1.3.4
- Components: 25 (0 triggers, 25 actions)

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

- Connector page: <https://connectors.appmixer.com/connector/appmixer.openai/1.3.4>
- Documentation: <https://docs.appmixer.com/connector-configuration/openai>
- Source code: <https://github.com/clientIO/appmixer-connectors/tree/dev/src/appmixer/openai>
- Download package: <https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/download>

## Authentication

**Type:** API Key

## Actions (25)

- [Make Api Call](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.MakeApiCall.md) (`appmixer.openai.core.MakeApiCall`): Performs an arbitrary authorized API call to the OpenAI API.
- [cancel Fine Tuning Job](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.cancelFineTuningJob.md) (`appmixer.openai.core.cancelFineTuningJob`): Immediately cancel a fine-tune job.
- [create Chat Completion](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.createChatCompletion.md) (`appmixer.openai.core.createChatCompletion`): Creates a model response for the given chat conversation.
- [create Completion](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.createCompletion.md) (`appmixer.openai.core.createCompletion`): Creates a completion for the provided prompt and parameters.
- [CreateEdit (Deprecated)](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.createEdit.md) (`appmixer.openai.core.createEdit`): Creates a new edit for the provided input, instruction, and parameters.
- [create Embedding](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.createEmbedding.md) (`appmixer.openai.core.createEmbedding`): Creates an embedding vector representing the input text.
- [Upload File](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.createFile.md) (`appmixer.openai.core.createFile`): Upload a file that can be used across various endpoints. The size of all the files uploaded by one organization can be up to 100 GB. The size of individual files can be a maximum of 512 MB. See the [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) to learn more about the types of files supported. The Fine-tuning API only supports `.jsonl` files. Please [contact us](https://help.openai.com/) if you need to increase these storage limits.
- [create Fine Tuning Job](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.createFineTuningJob.md) (`appmixer.openai.core.createFineTuningJob`): Creates a job that fine-tunes a specified 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](https://platform.openai.com/docs/guides/fine-tuning)
- [create Image](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.createImage.md) (`appmixer.openai.core.createImage`): Creates an image given a prompt.
- [create Image Edit](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.createImageEdit.md) (`appmixer.openai.core.createImageEdit`): Creates an edited or extended image given an original image and a prompt.
- [create Image Variation](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.createImageVariation.md) (`appmixer.openai.core.createImageVariation`): Creates a variation of a given image.
- [create Moderation](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.createModeration.md) (`appmixer.openai.core.createModeration`): Classifies if text violates OpenAI's Content Policy
- [create Speech](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.createSpeech.md) (`appmixer.openai.core.createSpeech`): Generates audio from the input text.
- [create Transcription](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.createTranscription.md) (`appmixer.openai.core.createTranscription`): Transcribes audio into the input language.
- [create Translation](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.createTranslation.md) (`appmixer.openai.core.createTranslation`): Translates audio into English.
- [delete File](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.deleteFile.md) (`appmixer.openai.core.deleteFile`): Delete a file.
- [delete Model](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.deleteModel.md) (`appmixer.openai.core.deleteModel`): Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.
- [download File](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.downloadFile.md) (`appmixer.openai.core.downloadFile`): Returns the contents of the specified file.
- [list Files](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.listFiles.md) (`appmixer.openai.core.listFiles`): Returns a list of files that belong to the user's organization.
- [list Fine Tuning Events](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.listFineTuningEvents.md) (`appmixer.openai.core.listFineTuningEvents`): Get status updates for a fine-tuning job.
- [list Models](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.listModels.md) (`appmixer.openai.core.listModels`): Lists the currently available models, and provides basic information about each one such as the owner and availability.
- [list Paginated Fine Tuning Jobs](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.listPaginatedFineTuningJobs.md) (`appmixer.openai.core.listPaginatedFineTuningJobs`): List your organization's fine-tuning jobs
- [retrieve File](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.retrieveFile.md) (`appmixer.openai.core.retrieveFile`): Returns information about a specific file.
- [retrieve Fine Tuning Job](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.retrieveFineTuningJob.md) (`appmixer.openai.core.retrieveFineTuningJob`): Get info about a fine-tuning job. [Learn more about fine-tuning](https://platform.openai.com/docs/guides/fine-tuning)
- [retrieve Model](https://connectors.appmixer.com/connector/appmixer.openai/1.3.4/component/appmixer.openai.core.retrieveModel.md) (`appmixer.openai.core.retrieveModel`): Retrieves a model instance, providing basic information about the model such as the owner and permissioning.

## Changelog

### 1.3.6

- Security: upgraded jsonata to 2.2.2 (fixes arbitrary code execution through crafted expressions, prototype pollution and a $toMillis denial of service).

### 1.3.5

- Security: upgraded form-data to 4.0.6 (predictable multipart boundary, CRLF injection in field names and filenames).

### 1.3.4

- MakeApiCall: Request Headers and Query Parameters set in the Designer are now sent. They were silently dropped: the key-value field stores its rows as a JSON object string, which the component did not parse.

### 1.3.3

- Output examples for createSpeech, createTranscription, createTranslation, deleteFile and retrieveFile.

### 1.3.2

- deleteModel and retrieveModel now stop with a clear error when the model is missing instead of calling the API; added output schemas with examples.

### 1.3.1

- Added output schemas with examples to createFile.

### 1.3.0

- add MakeApiCall component with key-value array inputs for headers and parameters per standard #1459
- Added output examples to component schemas.

### 1.2.7

- Fixed an issue with the `CreateTranslation` and `CreateTranscription` components where the `response_format` parameter `vtt` was causing an 'Invalid obj param.' error.

### 1.2.6

- Updated labels for models in the `CreateEdit` component.

### 1.2.5

- UploadFile: now correctly works with all 4 purpose options. Beware that not all options work for each file.

### 1.2.4

- Remove empty quotas.
- Marked `CreateEdit` as deprecated. It can still be used, but it uses the same functionality as `CreateChatCompletion`. Use `CreateChatCompletion` instead.

### 1.2.3

- CreateCompletion: fixed 'invalid obj param' error that sometimes occurred + added dynamic list for models.
- RetrieveModel: added dynamic list for models.

### 1.2.1

- Fixed validation error in the `createChatCompletion` component for the `max_tokens` parameter.

### 1.1.0

- OpenAI API
