https://github.com/softcreatr/php-openai-sdk

A powerful and easy-to-use PHP SDK for the OpenAI API, allowing seamless integration of advanced AI-powered features into your PHP projects.
https://github.com/softcreatr/php-openai-sdk
api api-wrapper artificial-intelligence dall-e gpt gpt-3 gpt-4 hacktoberfest machine-learning natural-language-processing nlp openai php php-library sdk
Last synced: 2 months ago
JSON representation
A powerful and easy-to-use PHP SDK for the OpenAI API, allowing seamless integration of advanced AI-powered features into your PHP projects.
Host: GitHub
URL: https://github.com/softcreatr/php-openai-sdk
Owner: SoftCreatR
License: isc
Created: 2023-03-17T04:18:12.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2025-04-23T10:35:31.000Z (3 months ago)
Last Synced: 2025-05-07T14:05:34.977Z (2 months ago)
Topics: api, api-wrapper, artificial-intelligence, dall-e, gpt, gpt-3, gpt-4, hacktoberfest, machine-learning, natural-language-processing, nlp, openai, php, php-library, sdk
Language: PHP
Homepage: https://platform.openai.com/docs
Size: 626 KB
Stars: 8
Watchers: 2
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project

README

        # OpenAI API Wrapper for PHP

[![Build](https://img.shields.io/github/actions/workflow/status/SoftCreatR/php-openai-sdk/.github/workflows/create-release.yml?branch=main)](https://github.com/SoftCreatR/php-openai-sdk/actions/workflows/create-release.yml) [![Latest Release](https://img.shields.io/packagist/v/SoftCreatR/php-openai-sdk?color=blue&label=Latest%20Release)](https://packagist.org/packages/softcreatr/php-openai-sdk) [![ISC licensed](https://img.shields.io/badge/license-ISC-blue.svg)](./LICENSE.md) [![Plant Tree](https://img.shields.io/badge/dynamic/json?color=brightgreen&label=Plant%20Tree&query=%24.total&url=https%3A%2F%2Fpublic.ecologi.com%2Fusers%2Fsoftcreatr%2Ftrees)](https://ecologi.com/softcreatr?r=61212ab3fc69b8eb8a2014f4) [![Codecov branch](https://img.shields.io/codecov/c/github/SoftCreatR/php-openai-sdk)](https://codecov.io/gh/SoftCreatR/php-openai-sdk) [![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability-percentage/SoftCreatR/php-openai-sdk)](https://codeclimate.com/github/SoftCreatR/php-openai-sdk)

This PHP library provides a simple wrapper for the OpenAI API, allowing you to easily integrate the OpenAI API into your PHP projects.

## Features

- Easy integration with OpenAI API

- Supports all OpenAI API endpoints

- Streaming support for real-time responses in chat completions

- Utilizes PSR-17 and PSR-18 compliant HTTP clients and factories for making API requests

## Requirements

- PHP 8.1 or higher

- A PSR-17 HTTP Factory implementation (e.g., [guzzle/psr7](https://github.com/guzzle/psr7) or [nyholm/psr7](https://github.com/Nyholm/psr7))

- A PSR-18 HTTP Client implementation (e.g., [guzzlehttp/guzzle](https://github.com/guzzle/guzzle) or [symfony/http-client](https://github.com/symfony/http-client))

## Installation

You can install the library via [Composer](https://getcomposer.org/):

```bash

composer require softcreatr/php-openai-sdk

```

## Usage

First, include the library in your project:

```php

createChatCompletion([

    'model' => 'gpt-4',

    'messages' => [

        ['role' => 'system', 'content' => 'You are a helpful assistant.'],

        ['role' => 'user', 'content' => 'Hello!'],

    ],

]);

// Process the API response

if ($response->getStatusCode() === 200) {

    $responseObj = json_decode($response->getBody()->getContents(), true);

    print_r($responseObj);

} else {

    echo "Error: " . $response->getStatusCode();

}

```

### Streaming Example

You can enable real-time streaming for chat completions:

```php

$streamCallback = static function ($data) {

    if (isset($data['choices'][0]['delta']['content'])) {

        echo $data['choices'][0]['delta']['content'];

    }

};

$openAI->createChatCompletion(

    [

        'model' => 'gpt-4',

        'messages' => [

            [

                'role' => 'user',

                'content' => 'Tell me a story about a brave knight.',

            ],

        ],

        'stream' => true,

    ],

    $streamCallback

);

```

For more details on how to use each endpoint, refer to the [OpenAI API documentation](https://platform.openai.com/docs/api-reference), and the [examples](https://github.com/SoftCreatR/php-openai-sdk/tree/main/examples) provided in the repository.

## Supported Methods

Below is a list of supported methods organized by category. Each method links to its corresponding OpenAI API documentation and includes a link to an example in this repository.

### Audio

- **Create Transcription** – [API Reference](https://platform.openai.com/docs/api-reference/audio/createTranscription) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/audio/createTranscription.php)  

  `createTranscription(array $options = [])`

- **Create Translation** – [API Reference](https://platform.openai.com/docs/api-reference/audio/createTranslation) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/audio/createTranslation.php)  

  `createTranslation(array $options = [])`

- **Create Speech** – [API Reference](https://platform.openai.com/docs/api-reference/audio/createSpeech) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/audio/createSpeech.php)  

  `createSpeech(array $options = [])`

### Responses

- **Create Response** – [API Reference](https://platform.openai.com/docs/api-reference/responses/create) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/responses/createResponse.php)  

  `createResponse(array $options = [], ?callable $streamCallback = null)`

- **Get Response** – [API Reference](https://platform.openai.com/docs/api-reference/responses/get) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/responses/getResponse.php)  

  `getResponse(array $parameters)`

- **Delete Response** – [API Reference](https://platform.openai.com/docs/api-reference/responses/delete) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/responses/deleteResponse.php)  

  `deleteResponse(array $parameters)`

- **List Input Items** – [API Reference](https://platform.openai.com/docs/api-reference/responses/input-items) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/responses/listInputItems.php)  

  `listInputItems(array $parameters)`

### Chat

- **Create Chat Completion** – [API Reference](https://platform.openai.com/docs/api-reference/chat/create) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/chat/createChatCompletion.php)  

  `createChatCompletion(array $options = [], ?callable $streamCallback = null)`

- **Get Chat Completion** – [API Reference](https://platform.openai.com/docs/api-reference/chat/get) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/chat/getChatCompletion.php)  

  `getChatCompletion(array $parameters)`

- **Get Chat Messages** – [API Reference](https://platform.openai.com/docs/api-reference/chat/getMessages) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/chat/getChatMessages.php)  

  `getChatMessages(array $parameters)`

- **List Chat Completions** – [API Reference](https://platform.openai.com/docs/api-reference/chat/list) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/chat/listChatCompletions.php)  

  `listChatCompletions(array $options = [])`

- **Update Chat Completion** – [API Reference](https://platform.openai.com/docs/api-reference/chat/update) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/chat/updateChatCompletion.php)  

  `updateChatCompletion(array $parameters, array $options = [])`

- **Delete Chat Completion** – [API Reference](https://platform.openai.com/docs/api-reference/chat/delete) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/chat/deleteChatCompletion.php)  

  `deleteChatCompletion(array $parameters)`

### Embeddings

- **Create Embedding** – [API Reference](https://platform.openai.com/docs/api-reference/embeddings/create) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/embeddings/createEmbedding.php)  

  `createEmbedding(array $options = [])`

### Fine-tuning

- **Create Fine-tuning Job** – [API Reference](https://platform.openai.com/docs/api-reference/fine-tuning/create) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/fine-tuning/createFineTuningJob.php)  

  `createFineTuningJob(array $options = [])`

- **List Fine-tuning Jobs** – [API Reference](https://platform.openai.com/docs/api-reference/fine-tuning/list) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/fine-tuning/listFineTuningJobs.php)  

  `listFineTuningJobs(array $options = [])`

- **List Fine-tuning Events** – [API Reference](https://platform.openai.com/docs/api-reference/fine-tuning/events) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/fine-tuning/listFineTuningEvents.php)  

  `listFineTuningEvents(array $parameters, array $options = [])`

- **List Fine-tuning Checkpoints** – [API Reference](https://platform.openai.com/docs/api-reference/fine-tuning/checkpoints) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/fine-tuning/listFineTuningCheckpoints.php)  

  `listFineTuningCheckpoints(array $parameters, array $options = [])`

- **Retrieve Fine-tuning Job** – [API Reference](https://platform.openai.com/docs/api-reference/fine-tuning/retrieve) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/fine-tuning/retrieveFineTuningJob.php)  

  `retrieveFineTuningJob(array $parameters)`

- **Cancel Fine-tuning Job** – [API Reference](https://platform.openai.com/docs/api-reference/fine-tuning/cancel) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/fine-tuning/cancelFineTuning.php)  

  `cancelFineTuning(array $parameters)`

### Batch

- **Create Batch** – [API Reference](https://platform.openai.com/docs/api-reference/batch/create) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/batch/createBatch.php)  

  `createBatch(array $options = [])`

- **Retrieve Batch** – [API Reference](https://platform.openai.com/docs/api-reference/batch/retrieve) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/batch/retrieveBatch.php)  

  `retrieveBatch(array $parameters)`

- **Cancel Batch** – [API Reference](https://platform.openai.com/docs/api-reference/batch/cancel) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/batch/cancelBatch.php)  

  `cancelBatch(array $parameters)`

- **List Batches** – [API Reference](https://platform.openai.com/docs/api-reference/batch/list) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/batch/listBatches.php)  

  `listBatches(array $options = [])`

### Files

- **Upload File** – [API Reference](https://platform.openai.com/docs/api-reference/files/upload) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/files/uploadFile.php)  

  `uploadFile(array $options = [])`

- **List Files** – [API Reference](https://platform.openai.com/docs/api-reference/files/list) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/files/listFiles.php)  

  `listFiles()`

- **Retrieve File** – [API Reference](https://platform.openai.com/docs/api-reference/files/retrieve) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/files/retrieveFile.php)  

  `retrieveFile(array $parameters)`

- **Delete File** – [API Reference](https://platform.openai.com/docs/api-reference/files/delete) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/files/deleteFile.php)  

  `deleteFile(array $parameters)`

- **Download File** – [API Reference](https://platform.openai.com/docs/api-reference/files/retrieve-content) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/files/retrieveFileContent.php)  

  `retrieveFileContent(array $parameters)`

### Uploads

- **Create Upload** – [API Reference](https://platform.openai.com/docs/api-reference/uploads/create) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/uploads/createUpload.php)  

  `createUpload(array $options = [])`

- **Add Upload Part** – [API Reference](https://platform.openai.com/docs/api-reference/uploads/add-part) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/uploads/addUploadPart.php)  

  `addUploadPart(array $parameters, array $options = [])`

- **Complete Upload** – [API Reference](https://platform.openai.com/docs/api-reference/uploads/complete) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/uploads/completeUpload.php)  

  `completeUpload(array $parameters)`

- **Cancel Upload** – [API Reference](https://platform.openai.com/docs/api-reference/uploads/cancel) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/uploads/cancelUpload.php)  

  `cancelUpload(array $parameters)`

### Images

- **Create Image** – [API Reference](https://platform.openai.com/docs/api-reference/images/create) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/images/createImage.php)  

  `createImage(array $options = [])`

- **Create Image Edit** – [API Reference](https://platform.openai.com/docs/api-reference/images/create-edit) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/images/createImageEdit.php)  

  `createImageEdit(array $options = [])`

- **Create Image Variation** – [API Reference](https://platform.openai.com/docs/api-reference/images/create-variation) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/images/createImageVariation.php)  

  `createImageVariation(array $options = [])`

### Models

- **List Models** – [API Reference](https://platform.openai.com/docs/api-reference/models/list) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/models/listModels.php)  

  `listModels()`

- **Retrieve Model** – [API Reference](https://platform.openai.com/docs/api-reference/models/retrieve) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/models/retrieveModel.php)  

  `retrieveModel(array $parameters)`

- **Delete Model** – [API Reference](https://platform.openai.com/docs/api-reference/models/delete) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/models/deleteModel.php)  

  `deleteModel(array $parameters)`

### Moderations

- **Create Moderation** – [API Reference](https://platform.openai.com/docs/api-reference/moderations/create) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/moderations/createModeration.php)  

  `createModeration(array $options = [])`

### Assistants

- **Create Assistant** – [API Reference](https://platform.openai.com/docs/api-reference/assistants/createAssistant) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/assistants/createAssistant.php)  

  `createAssistant(array $options = [])`

- **List Assistants** – [API Reference](https://platform.openai.com/docs/api-reference/assistants/listAssistants) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/assistants/listAssistants.php)  

  `listAssistants()`

- **Retrieve Assistant** – [API Reference](https://platform.openai.com/docs/api-reference/assistants/getAssistant) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/assistants/retrieveAssistant.php)  

  `retrieveAssistant(array $parameters)`

- **Modify Assistant** – [API Reference](https://platform.openai.com/docs/api-reference/assistants/modifyAssistant) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/assistants/modifyAssistant.php)  

  `modifyAssistant(array $parameters, array $options = [])`

- **Delete Assistant** – [API Reference](https://platform.openai.com/docs/api-reference/assistants/deleteAssistant) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/assistants/deleteAssistant.php)  

  `deleteAssistant(array $parameters)`

#### Threads

- **Create Thread** – [API Reference](https://platform.openai.com/docs/api-reference/threads/createThread) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/threads/createThread.php)  

  `createThread(array $options = [])`

- **Retrieve Thread** – [API Reference](https://platform.openai.com/docs/api-reference/threads/getThread) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/threads/retrieveThread.php)  

  `retrieveThread(array $parameters)`

- **Modify Thread** – [API Reference](https://platform.openai.com/docs/api-reference/threads/modifyThread) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/threads/modifyThread.php)  

  `modifyThread(array $parameters, array $options = [])`

- **Delete Thread** – [API Reference](https://platform.openai.com/docs/api-reference/threads/deleteThread) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/threads/deleteThread.php)  

  `deleteThread(array $parameters)`

#### Messages

- **Create Message** – [API Reference](https://platform.openai.com/docs/api-reference/messages/createMessage) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/messages/createMessage.php)  

  `createMessage(array $parameters, array $options = [])`

- **List Messages** – [API Reference](https://platform.openai.com/docs/api-reference/messages/listMessages) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/messages/listMessages.php)  

  `listMessages(array $parameters)`

- **Retrieve Message** – [API Reference](https://platform.openai.com/docs/api-reference/messages/getMessage) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/messages/retrieveMessage.php)  

  `retrieveMessage(array $parameters)`

- **Modify Message** – [API Reference](https://platform.openai.com/docs/api-reference/messages/modifyMessage) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/messages/modifyMessage.php)  

  `modifyMessage(array $parameters, array $options = [])`

- **Delete Message** – [API Reference](https://platform.openai.com/docs/api-reference/messages/deleteMessage) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/messages/deleteMessage.php)  

  `deleteMessage(array $parameters)`

#### Runs

- **Create Run** – [API Reference](https://platform.openai.com/docs/api-reference/runs/createRun) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/runs/createRun.php)  

  `createRun(array $parameters, array $options = [])`

- **Create Thread and Run** – [API Reference](https://platform.openai.com/docs/api-reference/runs/createThreadAndRun) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/runs/createThreadAndRun.php)  

  `createThreadAndRun(array $options = [])`

- **List Runs** – [API Reference](https://platform.openai.com/docs/api-reference/runs/listRuns) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/runs/listRuns.php)  

  `listRuns(array $parameters)`

- **Retrieve Run** – [API Reference](https://platform.openai.com/docs/api-reference/runs/getRun) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/runs/retrieveRun.php)  

  `retrieveRun(array $parameters)`

- **Modify Run** – [API Reference](https://platform.openai.com/docs/api-reference/runs/modifyRun) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/runs/modifyRun.php)  

  `modifyRun(array $parameters, array $options = [])`

- **Submit Tool Outputs to Run** – [API Reference](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/runs/submitToolOutputsToRun.php)  

  `submitToolOutputsToRun(array $parameters, array $options = [])`

- **Cancel Run** – [API Reference](https://platform.openai.com/docs/api-reference/runs/cancelRun) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/runs/cancelRun.php)  

  `cancelRun(array $parameters)`

#### Run Steps

- **List Run Steps** – [API Reference](https://platform.openai.com/docs/api-reference/run-steps/listRunSteps) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/run-steps/listRunSteps.php)  

  `listRunSteps(array $parameters)`

- **Retrieve Run Step** – [API Reference](https://platform.openai.com/docs/api-reference/run-steps/getRunStep) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/run-steps/retrieveRunStep.php)  

  `retrieveRunStep(array $parameters)`

### Vector Stores

- **Create Vector Store** – [API Reference](https://platform.openai.com/docs/api-reference/vector-stores/create) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/vector-stores/createVectorStore.php)  

  `createVectorStore(array $options = [])`

- **List Vector Stores** – [API Reference](https://platform.openai.com/docs/api-reference/vector-stores/list) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/vector-stores/listVectorStores.php)  

  `listVectorStores()`

- **Retrieve Vector Store** – [API Reference](https://platform.openai.com/docs/api-reference/vector-stores/retrieve) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/vector-stores/retrieveVectorStore.php)  

  `retrieveVectorStore(array $parameters)`

- **Modify Vector Store** – [API Reference](https://platform.openai.com/docs/api-reference/vector-stores/modify) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/vector-stores/modifyVectorStore.php)  

  `modifyVectorStore(array $parameters, array $options = [])`

- **Delete Vector Store** – [API Reference](https://platform.openai.com/docs/api-reference/vector-stores/delete) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/vector-stores/deleteVectorStore.php)  

  `deleteVectorStore(array $parameters)`

- **Search vector store** – [API Reference](https://platform.openai.com/docs/api-reference/vector-stores/search) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/vector-stores/searchVectorStore.php)  

  `deleteVectorStore(array $parameters)`

#### Vector Store Files

- **Create Vector Store File** – [API Reference](https://platform.openai.com/docs/api-reference/vector-stores-files/createFile) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/vector-store-files/createVectorStoreFile.php)  

  `createVectorStoreFile(array $parameters, array $options = [])`

- **List Vector Store Files** – [API Reference](https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/vector-store-files/listVectorStoreFiles.php)  

  `listVectorStoreFiles(array $parameters)`

- **Retrieve vector store file content** – [API Reference](https://platform.openai.com/docs/api-reference/vector-stores-files/getContent) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/vector-store-files/retrieveVectorStoreFileContent.php)  

  `listVectorStoreFiles(array $parameters)`

- **Update vector store file attributes** – [API Reference](https://platform.openai.com/docs/api-reference/vector-stores-files/updateAttributes) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/vector-store-files/updateVectorStoreFileAttributes.php)  

  `listVectorStoreFiles(array $parameters)`

- **Retrieve Vector Store File** – [API Reference](https://platform.openai.com/docs/api-reference/vector-stores-files/getFile) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/vector-store-files/retrieveVectorStoreFile.php)  

  `retrieveVectorStoreFile(array $parameters)`

- **Delete Vector Store File** – [API Reference](https://platform.openai.com/docs/api-reference/vector-stores-files/deleteFile) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/vector-store-files/deleteVectorStoreFile.php)  

  `deleteVectorStoreFile(array $parameters)`

#### Vector Store File Batches

- **Create Vector Store File Batch** – [API Reference](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/createBatch) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/vector-store-file-batches/createVectorStoreFileBatch.php)  

  `createVectorStoreFileBatch(array $parameters, array $options = [])`

- **Retrieve Vector Store File Batch** – [API Reference](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/getBatch) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/vector-store-file-batches/retrieveVectorStoreFileBatch.php)  

  `retrieveVectorStoreFileBatch(array $parameters)`

- **Cancel Vector Store File Batch** – [API Reference](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/cancelBatch) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/vector-store-file-batches/cancelVectorStoreFileBatch.php)  

  `cancelVectorStoreFileBatch(array $parameters)`

- **List Vector Store Files in Batch** – [API Reference](https://platform.openai.com/docs/api-reference/vector-stores-file-batches/listBatchFiles) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/assistants/vector-store-file-batches/listVectorStoreFilesInBatch.php)  

  `listVectorStoreFilesInBatch(array $parameters)`

### Administration

#### Invites

- **List Invites** – [API Reference](https://platform.openai.com/docs/api-reference/invite/list) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/invites/listInvites.php)  

  `listInvites()`

- **Create Invite** – [API Reference](https://platform.openai.com/docs/api-reference/invite/create) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/invites/createInvite.php)  

  `createInvite(array $options = [])`

- **Retrieve Invite** – [API Reference](https://platform.openai.com/docs/api-reference/invite/retrieve) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/invites/retrieveInvite.php)  

  `retrieveInvite(array $parameters)`

- **Delete Invite** – [API Reference](https://platform.openai.com/docs/api-reference/invite/delete) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/invites/deleteInvite.php)  

  `deleteInvite(array $parameters)`

#### Users

- **List Users** – [API Reference](https://platform.openai.com/docs/api-reference/org-users/list) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/org-users/listUsers.php)  

  `listUsers()`

- **Modify User** – [API Reference](https://platform.openai.com/docs/api-reference/org-users/modify) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/org-users/modifyUser.php)  

  `modifyUser(array $parameters, array $options = [])`

- **Retrieve User** – [API Reference](https://platform.openai.com/docs/api-reference/org-users/listget) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/org-users/retrieveUser.php)  

  `retrieveUser(array $parameters)`

- **Delete User** – [API Reference](https://platform.openai.com/docs/api-reference/org-users/delete) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/org-users/deleteUser.php)  

  `deleteUser(array $parameters)`

#### Admin API Keys

- **List Admin API Keys** – [API Reference](https://platform.openai.com/docs/api-reference/admin-api-keys/list) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/admin-api-keys/listAdminApiKeys.php)  

  `listAdminApiKeys(array $options = [])`

- **Create Admin API Key** – [API Reference](https://platform.openai.com/docs/api-reference/admin-api-keys/create) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/admin-api-keys/createAdminApiKey.php)  

  `createAdminApiKey(array $options = [])`

- **Retrieve Admin API Key** – [API Reference](https://platform.openai.com/docs/api-reference/admin-api-keys/listget) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/admin-api-keys/retrieveAdminApiKey.php)  

  `retrieveAdminApiKey(array $parameters)`

- **Delete Admin API Key** – [API Reference](https://platform.openai.com/docs/api-reference/admin-api-keys/delete) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/admin-api-keys/deleteAdminApiKey.php)  

  `deleteAdminApiKey(array $parameters)`

#### Certificates

- **Upload Certificate** – [API Reference](https://platform.openai.com/docs/api-reference/certificates/uploadCertificate) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/certificates/uploadCertificate.php)  

  `uploadCertificate(array $options = [])`

- **List Certificates** – [API Reference](https://platform.openai.com/docs/api-reference/certificates/listOrganizationCertificates) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/certificates/listCertificates.php)  

  `listCertificates(array $options = [])`

- **Get Certificate** – [API Reference](https://platform.openai.com/docs/api-reference/certificates/getCertificate) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/certificates/getCertificate.php)  

  `getCertificate(array $parameters)`

- **Modify Certificate** – [API Reference](https://platform.openai.com/docs/api-reference/certificates/modifyCertificate) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/certificates/modifyCertificate.php)  

  `modifyCertificate(array $parameters, array $options = [])`

- **Delete Certificate** – [API Reference](https://platform.openai.com/docs/api-reference/certificates/deleteCertificate) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/certificates/deleteCertificate.php)  

  `deleteCertificate(array $parameters)`

- **List Project Certificates** – [API Reference](https://platform.openai.com/docs/api-reference/certificates/listProjectCertificates) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/certificates/listProjectCertificates.php)  

  `listProjectCertificates(array $parameters)`

- **Activate Certificates** – [API Reference](https://platform.openai.com/docs/api-reference/certificates/activateOrganizationCertificates) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/certificates/activateCertificates.php)  

  `activateCertificates(array $options = [])`

- **Deactivate Certificates** – [API Reference](https://platform.openai.com/docs/api-reference/certificates/deactivateOrganizationCertificates) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/certificates/deactivateCertificates.php)  

  `deactivateCertificates(array $options = [])`

- **Activate Project Certificates** – [API Reference](https://platform.openai.com/docs/api-reference/certificates/activateProjectCertificates) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/certificates/activateProjectCertificates.php)  

  `activateProjectCertificates(array $parameters)`

- **Deactivate Project Certificates** – [API Reference](https://platform.openai.com/docs/api-reference/certificates/deactivateProjectCertificates) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/certificates/deactivateProjectCertificates.php)  

  `deactivateProjectCertificates(array $parameters)`

#### Rate Limits

- **List Project Rate Limits** – [API Reference](https://platform.openai.com/docs/api-reference/project-rate-limits/list) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/rate-limits/listProjectRateLimits.php)  

  `listProjectRateLimits(array $parameters)`

- **Modify Project Rate Limit** – [API Reference](https://platform.openai.com/docs/api-reference/project-rate-limits/update) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/rate-limits/modifyProjectRateLimit.php)  

  `modifyProjectRateLimit(array $parameters, array $options = [])`

#### Usage

- **Get Completions Usage** – [API Reference](https://platform.openai.com/docs/api-reference/usage/completions) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/usage/getCompletionsUsage.php)  

  `getCompletionsUsage(array $parameters = [])`

- **Get Embeddings Usage** – [API Reference](https://platform.openai.com/docs/api-reference/usage/embeddings) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/usage/getEmbeddingsUsage.php)  

  `getEmbeddingsUsage(array $parameters = [])`

- **Get Moderations Usage** – [API Reference](https://platform.openai.com/docs/api-reference/usage/moderations) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/usage/getModerationsUsage.php)  

  `getModerationsUsage(array $parameters = [])`

- **Get Images Usage** – [API Reference](https://platform.openai.com/docs/api-reference/usage/images) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/usage/getImagesUsage.php)  

  `getImagesUsage(array $parameters = [])`

- **Get Audio Speeches Usage** – [API Reference](https://platform.openai.com/docs/api-reference/usage/audio_speeches) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/usage/getAudioSpeechesUsage.php)  

  `getAudioSpeechesUsage(array $parameters = [])`

- **Get Vector Stores Usage** – [API Reference](https://platform.openai.com/docs/api-reference/usage/vector_stores) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/usage/getVectorStoresUsage.php)  

  `getVectorStoresUsage(array $parameters = [])`

- **Get Costs** – [API Reference](https://platform.openai.com/docs/api-reference/usage/costs) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/usage/getCosts.php)  

  `getCosts(array $parameters = [])`

#### Projects

- **List Projects** – [API Reference](https://platform.openai.com/docs/api-reference/projects/list) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/projects/listProjects.php)  

  `listProjects()`

- **Create Project** – [API Reference](https://platform.openai.com/docs/api-reference/projects/create) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/projects/createProject.php)  

  `createProject(array $options = [])`

- **Retrieve Project** – [API Reference](https://platform.openai.com/docs/api-reference/projects/retrieve) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/projects/retrieveProject.php)  

  `retrieveProject(array $parameters)`

- **Modify Project** – [API Reference](https://platform.openai.com/docs/api-reference/projects/modify) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/projects/modifyProject.php)  

  `modifyProject(array $parameters, array $options = [])`

- **Archive Project** – [API Reference](https://platform.openai.com/docs/api-reference/projects/archive) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/projects/archiveProject.php)  

  `archiveProject(array $parameters)`

#### Project Users

- **List Project Users** – [API Reference](https://platform.openai.com/docs/api-reference/project-users/list) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/project-users/listProjectUsers.php)  

  `listProjectUsers(array $parameters)`

- **Create Project User** – [API Reference](https://platform.openai.com/docs/api-reference/project-users/create) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/project-users/createProjectUser.php)  

  `createProjectUser(array $parameters, array $options = [])`

- **Retrieve Project User** – [API Reference](https://platform.openai.com/docs/api-reference/project-users/retrieve) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/project-users/retrieveProjectUser.php)  

  `retrieveProjectUser(array $parameters)`

- **Modify Project User** – [API Reference](https://platform.openai.com/docs/api-reference/project-users/modify) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/project-users/modifyProjectUser.php)  

  `modifyProjectUser(array $parameters, array $options = [])`

- **Delete Project User** – [API Reference](https://platform.openai.com/docs/api-reference/project-users/delete) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/project-users/deleteProjectUser.php)  

  `deleteProjectUser(array $parameters)`

#### Project Service Accounts

- **List Project Service Accounts** – [API Reference](https://platform.openai.com/docs/api-reference/project-service-accounts/list) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/project-service-accounts/listProjectServiceAccounts.php)  

  `listProjectServiceAccounts(array $parameters)`

- **Create Project Service Account** – [API Reference](https://platform.openai.com/docs/api-reference/project-service-accounts/create) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/project-service-accounts/createProjectServiceAccount.php)  

  `createProjectServiceAccount(array $parameters, array $options = [])`

- **Retrieve Project Service Account** – [API Reference](https://platform.openai.com/docs/api-reference/project-service-accounts/retrieve) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/project-service-accounts/retrieveProjectServiceAccount.php)  

  `retrieveProjectServiceAccount(array $parameters)`

- **Delete Project Service Account** – [API Reference](https://platform.openai.com/docs/api-reference/project-service-accounts/delete) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/project-service-accounts/deleteProjectServiceAccount.php)  

  `deleteProjectServiceAccount(array $parameters)`

#### Project API Keys

- **List Project API Keys** – [API Reference](https://platform.openai.com/docs/api-reference/project-api-keys/list) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/project-api-keys/listProjectApiKeys.php)  

  `listProjectApiKeys(array $parameters)`

- **Retrieve Project API Key** – [API Reference](https://platform.openai.com/docs/api-reference/project-api-keys/retrieve) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/project-api-keys/retrieveProjectApiKey.php)  

  `retrieveProjectApiKey(array $parameters)`

- **Delete Project API Key** – [API Reference](https://platform.openai.com/docs/api-reference/project-api-keys/delete) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/project-api-keys/deleteProjectApiKey.php)  

  `deleteProjectApiKey(array $parameters)`

#### Audit Logs

- **List Audit Logs** – [API Reference](https://platform.openai.com/docs/api-reference/audit-logs/list) – [Example](https://github.com/SoftCreatR/php-openai-sdk/blob/main/examples/administration/audit-logs/listAuditLogs.php)  

  `listAuditLogs(array $options = [])`

## Changelog

For a detailed list of changes and updates, please refer to the [CHANGELOG.md](https://github.com/SoftCreatR/php-openai-sdk/blob/main/CHANGELOG.md) file. We adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and document notable changes for each release.

## Known Problems and Limitations

### Streaming Support

Streaming is now supported for real-time token generation in chat completions. Please make sure you are handling streams correctly using a callback, as demonstrated in the examples.

## License

This library is licensed under the ISC License. See the [LICENSE](https://github.com/SoftCreatR/php-openai-sdk/blob/main/LICENSE.md) file for more information.

## Maintainers 🛠️

    

        

            

            


            _{Sascha Greuel}

        

    

## Contributors ✨
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/softcreatr/php-openai-sdk

Awesome Lists containing this project

README
