# PHP Integration — RenderPix
**API Endpoint:** `POST https://renderpix.dev/v1/render`
---
## Authentication
Pass your API key in the `X-API-Key` header on every request.
```php
define('RENDERPIX_API_KEY', 'rpx_your_api_key');
define('RENDERPIX_ENDPOINT', 'https://renderpix.dev/v1/render');
```
---
## Basic Example — HTML to PNG (cURL)
```php
$html,
'width' => 1200,
'height' => 630,
'format' => 'png',
]);
$ch = curl_init('https://renderpix.dev/v1/render');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $payload,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTPHEADER => [
'X-API-Key: rpx_your_api_key',
'Content-Type: application/json',
],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status !== 200) {
$error = json_decode($body, true);
throw new RuntimeException("RenderPix error {$status}: " . ($error['message'] ?? 'unknown'));
}
file_put_contents($outputFile, $body);
echo "Saved to {$outputFile}\n";
}
renderHtml('Hello, RenderPix!
');
```
---
## Real-World Example — OG Image Generator
```php
{$domain}
{$title}
{$description}
HTML;
$payload = json_encode(['html' => $html, 'width' => 1200, 'height' => 630, 'format' => 'png']);
$ch = curl_init('https://renderpix.dev/v1/render');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $payload,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTPHEADER => [
'X-API-Key: rpx_your_api_key',
'Content-Type: application/json',
],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($status !== 200) {
$error = json_decode($body, true);
throw new RuntimeException("Render failed ({$status}): " . ($error['message'] ?? 'unknown'));
}
file_put_contents($outputFile, $body);
return $outputFile;
}
// Usage
$file = generateOgImage(
title: 'Build Faster with RenderPix',
description: 'HTML to image in one API call. No puppeteer, no headless browser.',
domain: 'renderpix.dev',
);
echo "OG image saved: {$file}\n";
```
---
## Response Handling
A successful render returns the image binary directly (`Content-Type: image/png`).
```php
$html, 'width' => 1200, 'height' => 630]);
$ch = curl_init('https://renderpix.dev/v1/render');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $payload,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTPHEADER => ['X-API-Key: rpx_your_api_key', 'Content-Type: application/json'],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$curlErr = curl_error($ch);
curl_close($ch);
if ($curlErr) {
error_log("Network error: {$curlErr}");
return null;
}
$error = json_decode($body, true);
match ($status) {
401 => throw new RuntimeException('Invalid API key — check X-API-Key header'),
429 => throw new RuntimeException('Rate limit exceeded — slow down or upgrade plan'),
422 => throw new InvalidArgumentException('Invalid request: ' . ($error['message'] ?? '')),
200 => null, // ok
default => throw new RuntimeException("Render failed ({$status}): " . ($error['message'] ?? 'unknown')),
};
return $body;
}
// Laravel / Symfony — serve as response
$imageBytes = renderSafe('Hello
');
if ($imageBytes) {
return response($imageBytes, 200, ['Content-Type' => 'image/png']);
}
```