OpenAI PHP for Laravel

https://github.com/openai-php/laravel
Admin
A community-maintained PHP API client for Laravel that allows interaction with the OpenAI API,...
Tokens:25,367
Snippets:203
Trust Score:8.9
License:MIT
Update:2 days ago
Show doc for...
Tokens:
Raw
### Install development dependencies

Source: https://github.com/openai-php/laravel/blob/main/CONTRIBUTING.md

Run this command after cloning your fork to install the necessary development dependencies.

```bash
composer install
```

--------------------------------

### boot() method signature

Source: https://github.com/openai-php/laravel

Public method signature for boot(). Runs only in console mode to publish config and register the install command.

```php
public function boot(): void
```

--------------------------------

### Example — used by InstallCommand

Source: https://github.com/openai-php/laravel

Shows how to use View::render() with renderUsing() to set the output and render multiple view components. The example renders a badge, a new line, and a two-column detail with data arrays.

```php
namespace OpenAI\Laravel\Commands;

class InstallCommand extends Command
{
    public function handle(): void
    {
        View::renderUsing($this->output);

        View::render('components.badge', [
            'type' => 'INFO',
            'content' => 'Installing OpenAI for Laravel.',
        ]);

        View::render('components.new-line');

        View::render('components.two-column-detail', [
            'left' => 'config/openai.php',
            'right' => 'File created.',
        ]);
    }
}
```

--------------------------------

### Run the openai:install artisan command

Source: https://github.com/openai-php/laravel/blob/main/README.md

Executes the package's install command, which creates a config/openai.php configuration file and appends blank environment variables for the API key and organization to your .env file.

```bash
php artisan openai:install
```

--------------------------------

### Install openai-php/laravel via Composer

Source: https://github.com/openai-php/laravel/blob/main/README.md

Run this command to install the OpenAI PHP Laravel package using Composer. Requires PHP 8.2 or higher.

```bash
composer require openai-php/laravel
```

--------------------------------

### openRepositoryInBrowser() method signature

Source: https://github.com/openai-php/laravel

Opens the repository URL in the default browser using the platform-specific command: open on Darwin, start on Windows, xdg-open on Linux.

```php
private function openRepositoryInBrowser(): void
```

--------------------------------

### Run openai:install artisan command

Source: https://github.com/openai-php/laravel

Triggers the InstallCommand to prepare the Laravel application for the OpenAI client. Only available in console mode.

```bash
php artisan openai:install
```

--------------------------------

### Environment variables appended by openai:install

Source: https://github.com/openai-php/laravel

The `openai:install` command appends these blank variables to `.env` and `.env.example` only if not already present and the file is writable.

```env
OPENAI_API_KEY=
OPENAI_ORGANIZATION=

```

--------------------------------

### Use the OpenAI facade to create a response

Source: https://github.com/openai-php/laravel/blob/main/README.md

Example of using the OpenAI facade to call the responses API with the gpt-5 model. The response object provides the outputText property.

```php
use OpenAI\Laravel\Facades\OpenAI;

$response = OpenAI::responses()->create([
    'model' => 'gpt-5',
    'input' => 'Hello!',
]);

echo $response->outputText; // Hello! How can I assist you today?
```

--------------------------------

### Basic usage through the facade

Source: https://github.com/openai-php/laravel

Example of using OpenAI::fake() to mock a completion response and then calling the completions API.

```php
use OpenAI\Laravel\Facades\OpenAI;
use OpenAI\Responses\Completions\CreateResponse;

OpenAI::fake([
    CreateResponse::fake([
        'choices' => [['text' => 'awesome!']],
    ]),
]);

$completion = OpenAI::completions()->create([
    'model' => 'gpt-3.5-turbo-instruct',
    'prompt' => 'PHP is ',
]);

echo $completion['choices'][0]['text']; // awesome!
```

--------------------------------

### Example — basic fake

Source: https://github.com/openai-php/laravel

Shows how to use OpenAI::fake() with a single fake response and then make a request. The fake response is returned and its outputText is echoed. Requires the OpenAI Laravel facade and the CreateResponse fake.

```php
use OpenAI\Laravel\Facades\OpenAI;
use OpenAI\Responses\Responses\CreateResponse;

OpenAI::fake([
    CreateResponse::fake([
        'output_text' => 'Hello from the fake!',
    ]),
]);

$response = OpenAI::responses()->create([
    'model' => 'gpt-5',
    'input' => 'Hi',
]);

echo $response->outputText; // Hello from the fake!
```

--------------------------------

### InstallCommand class declaration

Source: https://github.com/openai-php/laravel

Defines the artisan command with signature 'openai:install' and description 'Prepares the OpenAI client for use.'. Includes link constants and private helper method signatures.

```php
namespace OpenAI\Laravel\Commands;

class InstallCommand extends Command
{
    private const LINKS = [
        'Repository' => 'https://github.com/openai-php/laravel',
        'OpenAI PHP Docs' => 'https://github.com/openai-php/client#readme',
        'Join us on Telegram' => 'https://t.me/+66GDs6UM6RcxY2U8',
    ];

    private const FUNDING_LINKS = [
        'Sponsor Sandro' => 'https://github.com/sponsors/gehrisandro',
        'Sponsor Nuno' => 'https://github.com/sponsors/nunomaduro',
    ];

    protected $signature = 'openai:install';

    protected $description = 'Prepares the OpenAI client for use.';

    public function handle(): void
    // private helpers:
    private function copyConfig(): void
    private function addEnvKeys(string $envFile): void
    private function askToStarRepository(): bool
    private function openRepositoryInBrowser(): void
    private function showLinks(): void
}
```

--------------------------------

### Command output

Source: https://github.com/openai-php/laravel

Termwind-rendered output from a typical run, showing the created files, added environment variables, and links. After this, fill in the .env values as shown in the next example.

```text
INFO Installing OpenAI for Laravel.

config/openai.php     ......................... File created.
.env                   ......................... OPENAI_API_KEY and OPENAI_ORGANIZATION variables added.
.env.example           ......................... OPENAI_API_KEY and OPENAI_ORGANIZATION variables added.

Repository             ......................... https://github.com/openai-php/laravel
OpenAI PHP Docs        ......................... https://github.com/openai-php/client#readme
Join us on Telegram    ......................... https://t.me/+66GDs6UM6RcxY2U8

INFO Open your .env and add your OpenAI API key and organization id.
```

--------------------------------

### Catching ApiKeyIsMissing with try-catch

Source: https://github.com/openai-php/laravel

Example of catching the exception when calling the OpenAI facade. The exception surfaces lazily on first container resolution.

```php
use OpenAI\Laravel\Exceptions\ApiKeyIsMissing;
use OpenAI\Laravel\Facades\OpenAI;

try {
    OpenAI::models()->list();
} catch (ApiKeyIsMissing $exception) {
    // Configuration problem, e.g. before `php artisan openai:install` was run
    // or before OPENAI_API_KEY was set. Tell the user to configure the key.
    logger->error('OpenAI is not configured: {message}', $exception->getMessage());
}
```

--------------------------------

### Environment variables to fill in

Source: https://github.com/openai-php/laravel

After installation, set your OpenAI API key and organization ID in the .env file. The placeholders sk-... and org-... must be replaced with actual values.

```env
OPENAI_API_KEY=sk-...
OPENAI_ORGANIZATION=org-...
```

--------------------------------

### Environment variables for API key and organization

Source: https://github.com/openai-php/laravel/blob/main/README.md

These blank environment variables are appended to your .env file by the install command. Fill them with your OpenAI API key and organization ID from your OpenAI dashboard.

```env
OPENAI_API_KEY=sk-...
OPENAI_ORGANIZATION=org-...
```

--------------------------------

### Asserting requests were sent

Source: https://github.com/openai-php/laravel

Example showing how to assert that requests were sent using callback, count, and resource-level assertion forms.

```php
use OpenAI\Laravel\Facades\OpenAI;
use OpenAI\Resources\Completions;
use OpenAI\Responses\Completions\CreateResponse;

OpenAI::fake([
    CreateResponse::fake(),
    CreateResponse::fake(),
]);

OpenAI::completions()->create(['model' => 'gpt-3.5-turbo-instruct', 'prompt' => 'PHP is ']);
OpenAI::completions()->create(['model' => 'gpt-3.5-turbo-instruct', 'prompt' => 'PHP is ']);

// Callback form — returns true when the request matches:
OpenAI::assertSent(Completions::class, function (string $method, array $parameters): bool {
    return $method === 'create' && $parameters['model'] === 'gpt-3.5-turbo-instruct';
});

// Count form:
OpenAI::assertSent(Completions::class, 2);

// Or assert on the resource itself:
OpenAI::completions()->assertSent(function (string $method, array $parameters): bool {
    return $method === 'create';
});
```

--------------------------------

### Fake OpenAI API responses with the fake() method

Source: https://github.com/openai-php/laravel/blob/main/README.md

Use the OpenAI facade's fake() method to return fake responses in the order provided. The example fakes a response with a specific choice text and then asserts the outputText equals 'awesome!'.

```php
use OpenAI\Laravel\Facades\OpenAI;
use OpenAI\Responses\Responses\CreateResponse;

OpenAI::fake([
    CreateResponse::fake([
        'choices' => [�
            [�
                'text' => 'awesome!',�
            ],�
        ],�
    ]),�
]);�

$response = OpenAI::responses()->create([�
    'model' => 'gpt-5',�
    'input' => 'PHP is ',�
]);�

expect($response->outputText)->toBe('awesome!');
```

--------------------------------

### Example — fake plus request assertions

Source: https://github.com/openai-php/laravel

Demonstrates using OpenAI::fake() with a fake response and then asserting the exact request sent via OpenAI::assertSent(). The assertion checks the method and parameters of the request.

```php
use OpenAI\Laravel\Facades\OpenAI;
use OpenAI\Resources\Responses;
use OpenAI\Responses\Responses\CreateResponse;

OpenAI::fake([
    CreateResponse::fake(['output_text' => 'ok']),
]);

OpenAI::responses()->create([
    'model' => 'gpt-5',
    'input' => 'Hello!',
]);

// Assert the exact request that was sent:
OpenAI::assertSent(Responses::class, function (string $method, array $parameters): bool {
    return $method === 'create'
        && $parameters['model'] === 'gpt-5'
        && $parameters['input'] === 'Hello!';
});
```

--------------------------------

### Assert a request was sent with assertSent

Source: https://github.com/openai-php/laravel/blob/main/README.md

After sending requests, use assertSent to verify that a specific request was made. The example checks that the create method was called with the expected model and prompt parameters.

```php
use OpenAI\Resources\Responses;

// assert completion create request was sent
OpenAI::assertSent(Responses::class, function (string $method, array $parameters): bool {
    return $method === 'create' &&
        $parameters['model'] === 'gpt-5' &&
        $parameters['prompt'] === 'PHP is ';
});
```

--------------------------------

### Error handling when no fake response left

Source: https://github.com/openai-php/laravel

Example showing that a second request after the fake response queue is exhausted throws 'No fake responses left'.

```php
use OpenAI\Laravel\Facades\OpenAI;
use OpenAI\Responses\Completions\CreateResponse;

OpenAI::fake([CreateResponse::fake()]);

OpenAI::completions()->create(['model' => 'gpt-3.5-turbo-instruct', 'prompt' => 'PHP is ']);

// Second request moves past the end of the queue:
OpenAI::completions()->create(['model' => 'gpt-3.5-turbo-instruct', 'prompt' => 'PHP is ']);
// → throws: "No fake responses left"
```

--------------------------------

### Example — rendering an error badge

Source: https://github.com/openai-php/laravel

Demonstrates rendering an error badge inside a try/catch block. Note that View::render never swallows template errors; exceptions propagate to the caller, and the Termwind renderer is restored by the finally block.

```php
try {
    View::render('components.badge', [
        'type' => 'ERROR',
        'content' => 'Something went wrong while installing.',
    ]);
} catch (Throwable $error) {
    // View::render never swallows template errors; a misbehaving template
    // surfaces the underlying PHP error, and the Termwind renderer is
    // restored by the finally block.
    fwrite(STDERR, (string) $error);
}
```

--------------------------------

### boot() implementation - publish config and register command

Source: https://github.com/openai-php/laravel

Conditional logic inside boot() that publishes the package config and registers InstallCommand when running in console.

```php
if ($this->app->runningInConsole()) {
    $this->publishes([
        __DIR__.'/../config/openai.php' => config_path('openai.php'),
    ]);

    $this->commands([
        InstallCommand::class,
    ]);
}
```

--------------------------------

### showLinks() method signature

Source: https://github.com/openai-php/laravel

Renders support links from LINKS and FUNDING_LINKS as a two-column detail view. Funding links order is randomized per run.

```php
private function showLinks(): void
```

--------------------------------

### askToStarRepository() method signature

Source: https://github.com/openai-php/laravel

Prompts the user to star the repository on GitHub. Returns false immediately when the console input is not interactive.

```php
private function askToStarRepository(): bool
```

--------------------------------

### handle() method signature

Source: https://github.com/openai-php/laravel

Entry point for the artisan command. Renders view output, publishes config, adds env keys, prompts to star the repository, and opens the browser if agreed.

```php
public function handle(): void
```

--------------------------------

### Run all tests

Source: https://github.com/openai-php/laravel/blob/main/CONTRIBUTING.md

Execute the full test suite for the project.

```bash
composer test
```

--------------------------------

### Resolving the client from the container

Source: https://github.com/openai-php/laravel

Shows three equivalent ways to resolve the singleton client instance from the container, all returning the same object.

```php
use Illuminate\Support\Facades\App;
use OpenAI\Client;
use OpenAI\Contracts\ClientContract;

// Equivalent calls — all three resolve to the same singleton instance:
$client = app(Client::class);
$client = app(ClientContract::class);
$client = app('openai');
```

--------------------------------

### fineTuning()

Source: https://github.com/openai-php/laravel

Returns the FineTuning resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

```APIDOC
## fineTuning()

### Description
Returns the FineTuning resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

### Method
Static method

### Endpoint
`OpenAI\Laravel\Facades\OpenAI::fineTuning()`

### Parameters
None

### Response
Returns `OpenAI\Resources\FineTuning`
```

--------------------------------

### Singleton registration with API key check

Source: https://github.com/openai-php/laravel

Binds ClientContract as a singleton, reading config values and throwing ApiKeyIsMissing if the API key is invalid. Uses OpenAI::factory() with optional project and base URI, and injects a GuzzleHttp client with a timeout.

```php
$this->app->singleton(ClientContract::class, static function (): Client {
    $apiKey = config('openai.api_key');
    $organization = config('openai.organization');
    $project = config('openai.project');
    $baseUri = config('openai.base_uri');

    if (! is_string($apiKey) || ($organization !== null && ! is_string($organization))) {
        throw ApiKeyIsMissing::create();
    }

    $client = OpenAI::factory()
        ->withApiKey($apiKey)
        ->withOrganization($organization)
        ->withHttpClient(new \GuzzleHttp\Client(['timeout' => config('openai.request_timeout', 30)]));

    if (is_string($project)) {
        $client->withProject($project);
    }

    if (is_string($baseUri)) {
        $client->withBaseUri($baseUri);
    }

    return $client->make();
});
```

--------------------------------

### copyConfig() method signature

Source: https://github.com/openai-php/laravel

Publishes config/openai.php unless it already exists. If the file exists, renders 'File already exists.' and does nothing else; otherwise renders 'File created.' and calls vendor:publish silently.

```php
private function copyConfig(): void
```

--------------------------------

### provides() method signature with docblock

Source: https://github.com/openai-php/laravel

Full signature of provides() including its docblock, indicating it returns an array of service identifiers.

```php
/**
 * Get the services provided by the provider.
 *
 * @return array<int, string>
 */
public function provides(): array
```

--------------------------------

### Container aliases for ClientContract

Source: https://github.com/openai-php/laravel

Creates two aliases so the client can be resolved via the string 'openai' or the concrete Client class, all pointing to the same singleton.

```php
$this->app->alias(ClientContract::class, 'openai');
$this->app->alias(ClientContract::class, Client::class);
```

--------------------------------

### Check types

Source: https://github.com/openai-php/laravel/blob/main/CONTRIBUTING.md

Run static type analysis on the codebase.

```bash
composer test:types
```

--------------------------------

### fineTunes()

Source: https://github.com/openai-php/laravel

Returns the FineTunes resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

```APIDOC
## fineTunes()

### Description
Returns the FineTunes resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

### Method
Static method

### Endpoint
`OpenAI\Laravel\Facades\OpenAI::fineTunes()`

### Parameters
None

### Response
Returns `OpenAI\Resources\FineTunes`
```

--------------------------------

### Run unit tests

Source: https://github.com/openai-php/laravel/blob/main/CONTRIBUTING.md

Execute only the unit tests for the project.

```bash
composer test:unit
```

--------------------------------

### addEnvKeys() method signature

Source: https://github.com/openai-php/laravel

Adds OPENAI_API_KEY and OPENAI_ORGANIZATION variables to the given env file. Returns early if the file is not writable, reading fails, or the keys already exist.

```php
private function addEnvKeys(string $envFile): void
```

--------------------------------

### audio()

Source: https://github.com/openai-php/laravel

Returns the Audio resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

```APIDOC
## audio()

### Description
Returns the Audio resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

### Method
Static method

### Endpoint
`OpenAI\Laravel\Facades\OpenAI::audio()`

### Parameters
None

### Response
Returns `OpenAI\Resources\Audio`
```

--------------------------------

### Basic usage without fakes using OpenAI facade

Source: https://github.com/openai-php/laravel

Use the OpenAI facade to create a chat response with the 'gpt-5' model and echo the output text. Requires the OpenAI Laravel package and proper configuration.

```php
use OpenAI\Laravel\Facades\OpenAI;

$response = OpenAI::responses()->create([
    'model' => 'gpt-5',
    'input' => 'Hello!',
]);

echo $response->outputText; // Hello! How can I assist you today?
```

--------------------------------

### Appending env keys to file

Source: https://github.com/openai-php/laravel

Appends OPENAI_API_KEY and OPENAI_ORGANIZATION placeholders to the env file. Called when the file is writable and does not already mention OPENAI_API_KEY.

```php
file_put_contents(base_path($envFile), PHP_EOL.'OPENAI_API_KEY='.PHP_EOL.'OPENAI_ORGANIZATION='.PHP_EOL, FILE_APPEND);
```

--------------------------------

### register()

Source: https://github.com/openai-php/laravel

Registers the OpenAI client as a singleton on the Laravel container. It binds the ClientContract interface to a factory that builds the client, and creates aliases for resolving the client under multiple keys.

```APIDOC
## register()

### Description
Registers the OpenAI client as a singleton on the Laravel container. It binds the ClientContract interface to a factory that builds the client, and creates aliases for resolving the client under multiple keys.

### Method
register()

### Signature
public function register(): void

### Parameters
None.

### Return Type
void

### Throws
- **OpenAI\Laravel\Exceptions\ApiKeyIsMissing** - Thrown when resolution of the ClientContract singleton is attempted and `openai.api_key` is not a string, or `openai.organization` is neither null nor a string. Registration itself only defines the factory; the exception is thrown on first `$app->get(...)` / facade resolution.

### Example — resolving the client from the container
```php
use Illuminate\Support\Facades\App;
use OpenAI\Client;
use OpenAI\Contracts\ClientContract;

// Equivalent calls — all three resolve to the same singleton instance:
$client = app(Client::class);
$client = app(ClientContract::class);
$client = app('openai');
```

### Example — error handling
```php
use Illuminate\Support\Facades\App;
use OpenAI\Contracts\ClientContract;
use OpenAI\Laravel\Exceptions\ApiKeyIsMissing;

try {
    $client = app(ClientContract::class);
} catch (ApiKeyIsMissing $exception) {
    // "The OpenAI API Key is missing. Please publish the [openai.php]
    // configuration file and set the [api_key]."
    reportMissingKey($exception->getMessage());
}
```
```

--------------------------------

### renderUsing() method signature

Source: https://github.com/openai-php/laravel

Sets the console output implementation used for rendering. The output is stored in the private static property self::$output for the duration of the process.

```php
/**
 * Renders views using the given Output instance.
 */
public static function renderUsing(OutputInterface $output): void
```

--------------------------------

### completions()

Source: https://github.com/openai-php/laravel

Returns the Completions resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

```APIDOC
## completions()

### Description
Returns the Completions resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

### Method
Static method

### Endpoint
`OpenAI\Laravel\Facades\OpenAI::completions()`

### Parameters
None

### Response
Returns `OpenAI\Resources\Completions`
```

--------------------------------

### assistants()

Source: https://github.com/openai-php/laravel

Returns the Assistants resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

```APIDOC
## assistants()

### Description
Returns the Assistants resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

### Method
Static method

### Endpoint
`OpenAI\Laravel\Facades\OpenAI::assistants()`

### Parameters
None

### Response
Returns `OpenAI\Resources\Assistants`
```

--------------------------------

### vendor:publish call inside copyConfig()

Source: https://github.com/openai-php/laravel

Invokes the artisan vendor:publish command silently with the OpenAI service provider. Used when the config file does not already exist.

```php
$this->callSilent('vendor:publish', [
    '--provider' => ServiceProvider::class,
]);
```

--------------------------------

### files()

Source: https://github.com/openai-php/laravel

Returns the Files resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

```APIDOC
## files()

### Description
Returns the Files resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

### Method
Static method

### Endpoint
`OpenAI\Laravel\Facades\OpenAI::files()`

### Parameters
None

### Response
Returns `OpenAI\Resources\Files`
```

--------------------------------

### Lint code

Source: https://github.com/openai-php/laravel/blob/main/CONTRIBUTING.md

Use this command to ensure your code adheres to the project's coding style.

```bash
composer lint
```

--------------------------------

### View::render() method signature

Source: https://github.com/openai-php/laravel

Public static method that renders a view template. Accepts a dot-notation view path relative to resources/views/ and optional data array. Returns void, writing output to the configured OutputInterface.

```php
/**
 * Renders the given view.
 *
 * @param  array<string, mixed>  $data
 */
public static function render(string $path, array $data = []): void
```

--------------------------------

### responses()

Source: https://github.com/openai-php/laravel

Returns the Responses resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

```APIDOC
## responses()

### Description
Returns the Responses resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

### Method
Static method

### Endpoint
`OpenAI\Laravel\Facades\OpenAI::responses()`

### Parameters
None

### Response
Returns `OpenAI\Resources\Responses`
```

--------------------------------

### provides() return value - service identifiers

Source: https://github.com/openai-php/laravel

The array returned by provides(), listing the container service identifiers: Client, ClientContract, and 'openai'.

```php
return [
    Client::class,
    ClientContract::class,
    'openai',
];
```

--------------------------------

### assertNothingSent()

Source: https://github.com/openai-php/laravel

Asserts that no requests were sent at all.

```APIDOC
## [METHOD] assertNothingSent()

### Description
Asserts that no requests were sent at all.

### Method
METHOD

### Parameters
None

### Response
#### Success Response (200)
- Returns `void`; throws `PHPUnit\Framework\ExpectationFailedException` otherwise
```

--------------------------------

### realtime()

Source: https://github.com/openai-php/laravel

Returns the Realtime resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

```APIDOC
## realtime()

### Description
Returns the Realtime resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

### Method
Static method

### Endpoint
`OpenAI\Laravel\Facades\OpenAI::realtime()`

### Parameters
None

### Response
Returns `OpenAI\Resources\Realtime`
```

--------------------------------

### containers()

Source: https://github.com/openai-php/laravel

Returns the Containers resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

```APIDOC
## containers()

### Description
Returns the Containers resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

### Method
Static method

### Endpoint
`OpenAI\Laravel\Facades\OpenAI::containers()`

### Parameters
None

### Response
Returns `OpenAI\Resources\Containers`
```

--------------------------------

### Configuration environment variables for API key and organization

Source: https://github.com/openai-php/laravel/blob/main/README.md

Specify your OpenAI API key and organization via environment variables. These are used to authenticate with the OpenAI API.

```env
OPENAI_API_KEY=
OPENAI_ORGANIZATION=
```

--------------------------------

### create() factory method signature

Source: https://github.com/openai-php/laravel

Static factory method that returns a new ApiKeyIsMissing instance. The message is fixed and matches the guard condition exactly.

```php
/**
 * Create a new exception instance.
 */
public static function create(): self
```

--------------------------------

### vectorStores()

Source: https://github.com/openai-php/laravel

Returns the VectorStores resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

```APIDOC
## vectorStores()

### Description
Returns the VectorStores resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

### Method
Static method

### Endpoint
`OpenAI\Laravel\Facades\OpenAI::vectorStores()`

### Parameters
None

### Response
Returns `OpenAI\Resources\VectorStores`
```

--------------------------------

### OpenAI::fake() method implementation

Source: https://github.com/openai-php/laravel

The fake() method creates an OpenAIFake instance with the given responses, swaps it into the container, and returns it.

```php
public static function fake(array $responses = []): OpenAIFake
{
    $fake = new OpenAIFake($responses);
    self::swap($fake);
    return $fake;
}
```

--------------------------------

### Error handling for missing API key

Source: https://github.com/openai-php/laravel

Catches ApiKeyIsMissing when resolving the client, with a comment showing the exception message about publishing the openai.php config file.

```php
use Illuminate\Support\Facades\App;
use OpenAI\Contracts\ClientContract;
use OpenAI\Laravel\Exceptions\ApiKeyIsMissing;

try {
    $client = app(ClientContract::class);
} catch (ApiKeyIsMissing $exception) {
    // "The OpenAI API Key is missing. Please publish the [openai.php]
    // configuration file and set the [api_key]."
    reportMissingKey($exception->getMessage());
}
```

--------------------------------

### models()

Source: https://github.com/openai-php/laravel

Returns the Models resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

```APIDOC
## models()

### Description
Returns the Models resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

### Method
Static method

### Endpoint
`OpenAI\Laravel\Facades\OpenAI::models()`

### Parameters
None

### Response
Returns `OpenAI\Resources\Models`
```

--------------------------------

### fake() behavior implementation

Source: https://github.com/openai-php/laravel

Internal implementation of fake(): creates an OpenAIFake instance and swaps it into the container via self::swap(). Fake responses are consumed in order; assertion helpers are inherited from OpenAI\Testing\ClientFake.

```php
$fake = new OpenAIFake($responses);
self::swap($fake);
return $fake;
```

--------------------------------

### images()

Source: https://github.com/openai-php/laravel

Returns the Images resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

```APIDOC
## images()

### Description
Returns the Images resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

### Method
Static method

### Endpoint
`OpenAI\Laravel\Facades\OpenAI::images()`

### Parameters
None

### Response
Returns `OpenAI\Resources\Images`
```

--------------------------------

### batches()

Source: https://github.com/openai-php/laravel

Returns the Batches resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

```APIDOC
## batches()

### Description
Returns the Batches resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

### Method
Static method

### Endpoint
`OpenAI\Laravel\Facades\OpenAI::batches()`

### Parameters
None

### Response
Returns `OpenAI\Resources\Batches`
```

--------------------------------

### Class declaration for ApiKeyIsMissing

Source: https://github.com/openai-php/laravel

The final class extends InvalidArgumentException and has no public constructor; instances are created via the static factory create(). Marked @internal.

```php
namespace OpenAI\Laravel\Exceptions;

use InvalidArgumentException;

/**
 * @internal
 */
final class ApiKeyIsMissing extends InvalidArgumentException
{
    public static function create(): self
}
```

--------------------------------

### fake()

Source: https://github.com/openai-php/laravel

Swaps the real client for a test double (OpenAIFake) in the container. Accepts an optional ordered list of fake responses, and returns the fake instance for further assertions.

```APIDOC
## fake()

### Description
Swaps the real client for a test double (OpenAIFake) in the container. Accepts an optional ordered list of fake responses, and returns the fake instance for further assertions.

### Method
`fake`

### Signature
```php
public static function fake(array $responses = []): OpenAIFake
```

### Parameters
- `$responses` (array<array-key, ResponseContract|StreamResponse|string>) - Optional - Default: `[]` - Ordered list of fake responses returned by the fake client. Each element is a response contract instance (e.g. `OpenAI\Responses\Completions\CreateResponse`), a `StreamResponse`, or a raw `string` payload.

### Return Type
`OpenAIFake` — the installed test double, kept so callers can call further assertion methods if desired.

### Throws
- `PHPUnit\Framework\ExpectationFailedException` - When an `assertSent`/`assertNotSent`/`assertNothingSent` assertion fails (via the inherited fake).
- `ErrorException` (upstream message `No fake responses left`) - When a request is made but no fake response remains in the queue.

### Request Example
```php
use OpenAI\Laravel\Facades\OpenAI;
use OpenAI\Responses\Responses\CreateResponse;

OpenAI::fake([
    CreateResponse::fake([
        'output_text' => 'Hello from the fake!',
    ]),
]);

$response = OpenAI::responses()->create([
    'model' => 'gpt-5',
    'input' => 'Hi',
]);

echo $response->outputText; // Hello from the fake!
```

### Request Example (with assertions)
```php
use OpenAI\Laravel\Facades\OpenAI;
use OpenAI\Resources\Responses;
use OpenAI\Responses\Responses\CreateResponse;

OpenAI::fake([
    CreateResponse::fake(['output_text' => 'ok']),
]);

OpenAI::responses()->create([
    'model' => 'gpt-5',
    'input' => 'Hello!',
]);

// Assert the exact request that was sent:
OpenAI::assertSent(Responses::class, function (string $method, array $parameters): bool {
    return $method === 'create'
        && $parameters['model'] === 'gpt-5'
        && $parameters['input'] === 'Hello!';
});
```
```

--------------------------------

### addResponses(array $responses)

Source: https://github.com/openai-php/laravel

Appends more fake responses to the queue.

```APIDOC
## [METHOD] addResponses(array $responses)

### Description
Appends more fake responses to the queue.

### Method
METHOD

### Parameters
#### Request Body
- `$responses` (array) - Required - Fake responses to append

### Response
#### Success Response (200)
- Returns `void`
```

--------------------------------

### OpenAI::fake()

Source: https://github.com/openai-php/laravel

Creates an OpenAIFake instance with the given fake responses and swaps it into the Laravel container. This is the primary factory method for the test double.

```APIDOC
## [FACTORY] OpenAI::fake()

### Description
Creates an OpenAIFake instance with the given fake responses and swaps it into the Laravel container. This is the primary factory method for the test double.

### Method
FACTORY

### Parameters
#### Request Body
- `$responses` (array<array-key, ResponseContract|StreamResponse|string>) - Optional - Fake responses returned in the order provided

### Response
#### Success Response (200)
- Returns an `OpenAIFake` instance

### Request Example
```php
OpenAI::fake([
    CreateResponse::fake([
        'choices' => [['text' => 'awesome!']],
    ]),
]);
```
```

--------------------------------

### register() method signature

Source: https://github.com/openai-php/laravel

Declares the public register method with no parameters, returning void. It is called by Laravel's container during service provider registration.

```php
public function register(): void
```

--------------------------------

### Configuration environment variable for API base URL

Source: https://github.com/openai-php/laravel/blob/main/README.md

Override the default OpenAI API base URL (api.openai.com/v1) by setting the OPENAI_BASE_URL environment variable.

```env
OPENAI_BASE_URL=
```

--------------------------------

### Resource-level assertSent / assertNotSent

Source: https://github.com/openai-php/laravel

Same assertions callable on the resource object returned by the facade.

```APIDOC
## [METHOD] Resource-level assertSent / assertNotSent

### Description
Same assertions callable on the resource object returned by the facade.

### Method
METHOD

### Parameters
#### Request Body
- `$callback` (callable) - Required - Callback `(string $method, array $parameters): bool` to filter requests

### Response
#### Success Response (200)
- Returns `void`; throws `PHPUnit\Framework\ExpectationFailedException` on failure

### Request Example
```php
OpenAI::completions()->assertSent(function (string $method, array $parameters): bool {
    return $method === 'create';
});
```
```

--------------------------------

### chat()

Source: https://github.com/openai-php/laravel

Returns the Chat resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

```APIDOC
## chat()

### Description
Returns the Chat resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

### Method
Static method

### Endpoint
`OpenAI\Laravel\Facades\OpenAI::chat()`

### Parameters
None

### Response
Returns `OpenAI\Resources\Chat`
```

--------------------------------

### Class declaration for OpenAI\Laravel\Support\View

Source: https://github.com/openai-php/laravel

Internal final class that compiles Blade-style views and renders them via Termwind. It is stateless except for a static output implementation and has no public constructor.

```php
namespace OpenAI\Laravel\Support;

use Symfony\Component\Console\Output\OutputInterface;
use Termwind\Termwind;

use function Termwind\render;
use function Termwind\renderUsing;

/**
 * @internal
 */
final class View
{
    private static OutputInterface $output;

    public static function renderUsing(OutputInterface $output): void
    public static function render(string $path, array $data = []): void
    private static function compile(string $path, array $data): string
}
```

--------------------------------

### Configuration environment variable for request timeout

Source: https://github.com/openai-php/laravel/blob/main/README.md

Set the maximum number of seconds to wait for a response using the OPENAI_REQUEST_TIMEOUT environment variable. The default timeout is 30 seconds.

```env
OPENAI_REQUEST_TIMEOUT=
```

--------------------------------

### fake() signature with docblock

Source: https://github.com/openai-php/laravel

Swaps the real OpenAI client for a test double. Accepts an ordered list of fake responses (response contracts, StreamResponse, or raw strings). The @phpstan-ignore-line suppresses a static-analysis complaint; the effective runtime type is OpenAIFake.

```php
/**
 * @param  array<array-key, ResponseContract|StreamResponse|string>  $responses
 */
public static function fake(array $responses = []): OpenAIFake /** @phpstan-ignore-line */
```

--------------------------------

### Configuration environment variable for OpenAI project

Source: https://github.com/openai-php/laravel/blob/main/README.md

Set the OpenAI project ID via the OPENAI_PROJECT environment variable for implementations that require a project ID.

```env
OPENAI_PROJECT=proj_...
```

--------------------------------

### assertNotSent(ClassName $resource)

Source: https://github.com/openai-php/laravel

Asserts that no request was sent for the given resource.

```APIDOC
## [METHOD] assertNotSent(ClassName $resource)

### Description
Asserts that no request was sent for the given resource.

### Method
METHOD

### Parameters
#### Request Body
- `$resource` (ClassName) - Required - The resource class to assert against

### Response
#### Success Response (200)
- Returns `void`; throws `PHPUnit\Framework\ExpectationFailedException` if a request was sent
```

--------------------------------

### Test asserting the exception is thrown

Source: https://github.com/openai-php/laravel

Pest test that verifies the exception is thrown with the exact message when the API key is missing.

```php
it('requires an api key', function () {
    $app = app();
    $app->bind('config', fn () => new Repository([]));
    (new ServiceProvider($app))->register();
    $app->get(Client::class);
})->throws(
    ApiKeyIsMissing::class,
    'The OpenAI API Key is missing. Please publish the [openai.php] configuration file and set the [api_key].',
);
```

--------------------------------

### Catch ExpectationFailedException from OpenAI::assertSent

Source: https://github.com/openai-php/laravel

Use this to catch failed request assertions when using the OpenAI facade with the fake client. The exception is thrown when recorded requests do not match the assertion.

```php
use PHPUnit\Framework\ExpectationFailedException;

try {
    OpenAI::assertSent(Responses::class, fn (string $method, array $parameters): bool => true);
} catch (ExpectationFailedException $exception) {
    // mismatch between expected and actually-sent requests
}
```

--------------------------------

### threads()

Source: https://github.com/openai-php/laravel

Returns the Threads resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

```APIDOC
## threads()

### Description
Returns the Threads resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

### Method
Static method

### Endpoint
`OpenAI\Laravel\Facades\OpenAI::threads()`

### Parameters
None

### Response
Returns `OpenAI\Resources\Threads`
```

--------------------------------

### View::render()

Source: https://github.com/openai-php/laravel

Renders a view template with the given data. It compiles the view, captures the current Termwind renderer, sets the package's stored output as the active renderer, and restores the previous renderer after rendering.

```APIDOC
## View::render()

### Description
Renders a view template with the given data. It compiles the view, captures the current Termwind renderer, sets the package's stored output as the active renderer, and restores the previous renderer after rendering.

### Method
`render`

### Signature
```php
public static function render(string $path, array $data = []): void
```

### Parameters
- `$path` (string) - Required - Dot-notation view path relative to `resources/views/`, e.g. `components.badge`
- `$data` (array<string, mixed>) - Optional - Default: `[]` - Variables extracted into scope for the template (e.g. `type`, `content`, `left`, `right`)

### Return Type
`void` (output is written to the configured `OutputInterface`).

### Behavior
1. Compiles the view via the private `compile()`.
2. Captures the currently registered Termwind renderer (`Termwind::getRenderer()`).
3. Sets the package's stored `$output` as the active renderer.
4. Renders the compiled contents inside `try`/`finally`, always restoring the previous Termwind renderer in `finally`.

### Request Example
```php
View::render('components.badge', [
    'type' => 'INFO',
    'content' => 'Installing OpenAI for Laravel.',
]);
```

### Response Example
No response example provided in the source.
```

--------------------------------

### moderations()

Source: https://github.com/openai-php/laravel

Returns the Moderations resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

```APIDOC
## moderations()

### Description
Returns the Moderations resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

### Method
Static method

### Endpoint
`OpenAI\Laravel\Facades\OpenAI::moderations()`

### Parameters
None

### Response
Returns `OpenAI\Resources\Moderations`
```

--------------------------------

### Default config/openai.php

Source: https://github.com/openai-php/laravel

Published configuration file for the OpenAI Laravel package. Each option maps to an environment variable via Laravel's env() helper. The request_timeout defaults to 30 seconds when OPENAI_REQUEST_TIMEOUT is unset.

```php
return [

    'api_key' => env('OPENAI_API_KEY'),
    'organization' => env('OPENAI_ORGANIZATION'),

    'project' => env('OPENAI_PROJECT'),

    'base_uri' => env('OPENAI_BASE_URL'),

    'request_timeout' => env('OPENAI_REQUEST_TIMEOUT', 30),
];
```

--------------------------------

### getFacadeAccessor() signature

Source: https://github.com/openai-php/laravel

Returns the container key 'openai' for the facade. The Laravel Facade base class uses this to resolve the underlying service on every static call, making the facade and app('openai') interchangeable.

```php
protected static function getFacadeAccessor(): string
```

--------------------------------

### assertSent(ClassName $resource, callable $callback)

Source: https://github.com/openai-php/laravel

Asserts that a matching request was sent for a resource. The callback filters requests by method and parameters.

```APIDOC
## [METHOD] assertSent(ClassName $resource, callable $callback)

### Description
Asserts that a matching request was sent for a resource. The callback filters requests by method and parameters.

### Method
METHOD

### Parameters
#### Request Body
- `$resource` (ClassName) - Required - The resource class to assert against
- `$callback` (callable) - Required - Callback `(string $method, array $parameters): bool` to filter requests

### Response
#### Success Response (200)
- Returns `void`; throws `PHPUnit\Framework\ExpectationFailedException` when no request matches

### Request Example
```php
OpenAI::assertSent(Completions::class, function (string $method, array $parameters): bool {
    return $method === 'create' && $parameters['model'] === 'gpt-3.5-turbo-instruct';
});
```
```

--------------------------------

### assertSent(ClassName $resource, int $times)

Source: https://github.com/openai-php/laravel

Asserts that exactly the given number of matching requests were sent for a resource.

```APIDOC
## [METHOD] assertSent(ClassName $resource, int $times)

### Description
Asserts that exactly the given number of matching requests were sent for a resource.

### Method
METHOD

### Parameters
#### Request Body
- `$resource` (ClassName) - Required - The resource class to assert against
- `$times` (int) - Required - The exact number of matching requests expected

### Response
#### Success Response (200)
- Returns `void`; throws `PHPUnit\Framework\ExpectationFailedException` on mismatch

### Request Example
```php
OpenAI::assertSent(Completions::class, 2);
```
```

--------------------------------

### embeddings()

Source: https://github.com/openai-php/laravel

Returns the Embeddings resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

```APIDOC
## embeddings()

### Description
Returns the Embeddings resource object from the openai-php/client package. This accessor takes no parameters and returns the resource configured with the singleton client.

### Method
Static method

### Endpoint
`OpenAI\Laravel\Facades\OpenAI::embeddings()`

### Parameters
None

### Response
Returns `OpenAI\Resources\Embeddings`
```
Tokens:
Raw