README

Official OpenRouter provider for the PHP AI SDK. Uses the shared OpenAI-compatible wire adapter.

Installation

composer require aisdk/openrouter

Basic Usage

use AiSdk\Generate;
use AiSdk\OpenRouter;

$result = Generate::text()
    ->model(OpenRouter::model('openai/gpt-4o'))
    ->instructions('Write short, clear answers.')
    ->prompt('Explain closures in PHP.')
    ->run();

echo $result->text;

Routed model IDs pass through unchanged and do not need to be registered. This package does not ship a model inventory; the SDK performs internal adapter validation before OpenRouter validates support for the selected route.

Embeddings

use AiSdk\Generate;
use AiSdk\OpenRouter;

$result = Generate::embedding(['Search query', 'Document text'])
    ->model(OpenRouter::embedding('openai/text-embedding-3-small'))
    ->dimensions(256)
    ->run();

$queryVector = $result->embeddings[0]->vector;
$documentVector = $result->embeddings[1]->vector;

OpenRouter embedding model IDs pass through unchanged. The v0.5 portable embedding API accepts text or a list of texts; provider-specific multimodal embedding inputs are outside this contract.

Image Generation

use AiSdk\Generate;
use AiSdk\OpenRouter;

$result = Generate::image()
    ->model(OpenRouter::image('openai/gpt-image-1'))
    ->prompt('A clean app icon for a PHP AI SDK')
    ->size('1024x1024')
    ->run();

$result->output->save(__DIR__.'/icon.png');

Speech Generation

use AiSdk\Generate;
use AiSdk\OpenRouter;

$result = Generate::speech()
    ->model(OpenRouter::speech('microsoft/mai-voice-2'))
    ->input('Welcome to the release.')
    ->voice('en-US-Harper:MAI-Voice-2')
    ->format('mp3')
    ->run();

$result->output->save(__DIR__.'/speech.mp3');

Transcription

use AiSdk\Content;
use AiSdk\Generate;
use AiSdk\OpenRouter;

$result = Generate::transcription(Content::audio(__DIR__.'/meeting.mp3'))
    ->model(OpenRouter::transcription('openai/whisper-large-v3'))
    ->run();

echo $result->output->text;

Configuration

Video Generation

$result = Generate::video('A time-lapse of a flower blooming')
    ->model(OpenRouter::video('google/veo-3.1'))
    ->resolution('1080p')
    ->aspectRatio('16:9')
    ->run(timeout: 600);

Variable	Description	Default
`OPENROUTER_API_KEY`	API key for authentication	Required
`OPENROUTER_BASE_URL`	Base URL for API requests	`https://openrouter.ai/api/v1`

OpenRouter::create([
    'apiKey' => 'or-...',
    'headers' => [
        'HTTP-Referer' => 'https://example.com',
        'X-OpenRouter-Title' => 'Example App',
    ],
]);

Provider-Specific Options

$result = Generate::text('Hello')
    ->model(OpenRouter::model('anthropic/claude-sonnet-4'))
    ->providerOptions('openrouter', [
        'raw' => [
            'provider' => ['order' => ['Anthropic']],
            'reasoning' => ['effort' => 'medium'],
        ],
    ])
    ->run();

Embedding-specific fields use the same provider namespace. For example, models that distinguish queries from documents can receive OpenRouter's documented input_type field:

$result = Generate::embedding('Document text')
    ->model(OpenRouter::embedding('provider/embedding-model'))
    ->providerOptions('openrouter', ['input_type' => 'search_document'])
    ->run();

Testing

composer test

aisdk / openrouter

Maintainers

Package info

Statistics

Security