ruscoe/openai-php

PHP library for the OpenAI API

2.0.0 2026-08-16 20:33 UTC

Requires

• php: >=8.1.0
• guzzlehttp/guzzle: ^7.5

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.11

MIT

• Dan Ruscoe

Published on Packagist.org on 2026-08-16 20:34 UTC

README

An unofficial library for OpenAI's API.

Requirements

• PHP 8.1 or above
• Composer
• An OpenAI API key

Quick set up

git clone [e-mail]:ruscoe/openai-php.git

cd openai-php

composer install

Usage examples

The following examples assume you store your API key in an environment variable. To do this on a Linux or MacOS system, run:

export OPENAI_API_KEY=sk-XA0yN...

Be sure to substitute your own API key after OPENAI_API_KEY=.

Completions

This example asks the gpt-4o model to describe a computer keyboard. It instructs the OpenAI API to use more than the default number of tokens so a reasonable length description can be returned.

<?php

require __DIR__ . '/vendor/autoload.php';

// @see https://developers.openai.com/api/reference/overview#authentication
$api_key = getenv('OPENAI_API_KEY');

$api = new OpenAI\OpenAICompletions($api_key);

$parameters = [
    'max_completion_tokens' => 128,
];

$messages = [
    (object) ['role' => 'user', 'content' => 'Briefly describe a computer keyboard']
];

$response = $api->create('gpt-4o', $messages, 1, $parameters);

var_dump($response->choices[0]->message->content);

The response:

string(648) "A computer keyboard is an input device used to enter text, numbers, and commands into a computer or other electronic devices. It is composed of an array of keys that includes the standard QWERTY layout for typing letters and numbers, along with various function keys, control keys, and special keys. Keyboards often feature additional keys or combinations for shortcuts and can vary in design, including wired or wireless models, ergonomic designs, and gaming keyboards with customizable keys and backlighting. They may also include a numeric keypad, arrow keys, and other keys like Escape, Tab, Caps Lock, Shift, Ctrl, Alt, and Enter, each serving"

Chat

This example sends a simple chat message.

<?php

require __DIR__ . '/vendor/autoload.php';

// @see https://developers.openai.com/api/reference/overview#authentication
$api_key = getenv('OPENAI_API_KEY');

$api = new OpenAI\OpenAIChat($api_key);

$messages = [
    (object) ['role' => 'user', 'content' => 'Hello, friend!'],
];

$response = $api->create('gpt-4o', $messages);

var_dump($response->choices[0]->message->content);

The response:

string(34) "Hello! How can I assist you today?"

Images

Create image

This example asks for an image of a jungle waterfall.

<?php

require __DIR__ . '/vendor/autoload.php';

// @see https://developers.openai.com/api/reference/overview#authentication
$api_key = getenv('OPENAI_API_KEY');

$api = new OpenAI\OpenAIImages($api_key);

$response = $api->createAsFile('gpt-image-2', 'A jungle waterfall', 'waterfall.png', 1, '1024x1024');

The response:

Create image edit

<?php

require __DIR__ . '/vendor/autoload.php';

// @see https://developers.openai.com/api/reference/overview#authentication
$api_key = getenv('OPENAI_API_KEY');

$api = new OpenAI\OpenAIImages($api_key);

$response = $api->createEditAsFile('gpt-image-2', 'samples/car.png', 'a duck driving a car', 'edit.png', 'samples/car_mask.png', 1, '1024x1024');

The source and response:

<?php

require __DIR__ . '/vendor/autoload.php';

// @see https://developers.openai.com/api/reference/overview#authentication
$api_key = getenv('OPENAI_API_KEY');

$api = new OpenAI\OpenAIImages($api_key);

$response = $api->createEditAsFile('gpt-image-2', 'samples/skull.png', 'create a color pencil version of this image', 'skull_variation.png', NULL, 1, '1024x1024');

The source and response:

Audio

Transcribe audio

<?php

require __DIR__ . '/vendor/autoload.php';

// @see https://developers.openai.com/api/reference/overview#authentication
$api_key = getenv('OPENAI_API_KEY');

$api = new OpenAI\OpenAIAudio($api_key);

$response = $api->transcribe('samples/museum.ogg');

var_dump($response->text);

The response:

string(140) "The British Museum in London is the United Kingdom's and one of the world's largest and most important museums of human history and culture."

Available functions

Models

Class	Function	Description
OpenAIModels	getModels	Gets available OpenAI models.
OpenAIModels	getModel	Gets a specific OpenAI model.

Completions

Class	Function	Description
OpenAICompletions	create	Creates one or more completions from a given input.

Chat

Class	Function	Description
OpenAIChat	create	Creates one or more completions from a chat conversation.

Edits

Class	Function	Description
OpenAIEdits	create	Performs an edit on a given input.

Images

Class	Function	Description
OpenAIImages	createAsFile	Generates a number of images as files.
OpenAIImages	createAsBase64	Generates a number of images and returns Base64 encoded image(s).
OpenAIImages	createEditAsFile	Generates a number of image edits as files.
OpenAIImages	createEditAsBase64	Generates a number of image edits and returns Base64 encoded image(s).
OpenAIImages	createEdit	Generates a number of image edits from a given image.

Embeddings

Class	Function	Description
OpenAIEmbeddings	create	Creates an embedding vector from given input.

Audio

Class	Function	Description
OpenAIAudio	transcribe	Transcribes text from an audio file.

Files

Class	Function	Description
OpenAIFiles	getFiles	Gets files owned by the user's organization.
OpenAIFiles	uploadFile	Uploads a file.
OpenAIFiles	deleteFile	Deletes a file.
OpenAIFiles	getFile	Gets information about a file.
OpenAIFiles	getFileContent	Gets the content of a file.

Moderations

Class	Function	Description
OpenAIModerations	create	Requests a moderation result from OpenAI.

License

MIT