> ## Documentation Index
> Fetch the complete documentation index at: https://docs.schemagen.io/llms.txt
> Use this file to discover all available pages before exploring further.
# GET /api/embed — Fetch Schemas as Renderable HTML
> Retrieve published schemas as an HTML string of JSON-LD script tags, ready to drop into server-side templates, WordPress themes, or Shopify Liquid files.
The embed endpoint delivers published schemas as a ready-to-render HTML string instead of JSON. The response contains one or more `
```
If multiple schemas are published for the URL, they are concatenated with no separator:
```html theme={null}
```
## Response headers
| Header | Description |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `X-Schemagen-Duration` | Server-side processing time in milliseconds. |
| `X-Schemagen-ID` | A unique UUID identifying this request. |
| `Content-Type` | Always `text/html; charset=utf-8`. |
| `Cache-Control` | Responses are cached. Unlike `/api/inject`, embed responses may be served from cache to improve server rendering performance. |
## Code examples
```bash cURL theme={null}
curl -G "https://schemagen.io/api/embed" \
--data-urlencode "clientId=your-client-uuid" \
--data-urlencode "url=https://example.com/products/widget"
```
```javascript Node.js (fetch) theme={null}
const params = new URLSearchParams({
clientId: 'your-client-uuid',
url: 'https://example.com/products/widget',
});
const response = await fetch(`https://schemagen.io/api/embed?${params}`);
const html = await response.text();
// `html` is ready to insert into your server-rendered page
```
```php PHP theme={null}
$clientId,
'url' => $url,
]);
$schemas = file_get_contents($apiUrl);
// Output directly in your template
echo $schemas;
```
### WordPress usage
Call the embed API in your theme's `functions.php` and output the result in the `` using the `wp_head` action:
```php theme={null}
add_action('wp_head', function () {
$clientId = 'your-client-uuid';
$url = get_permalink() ?: home_url($_SERVER['REQUEST_URI']);
$apiUrl = add_query_arg(
['clientId' => $clientId, 'url' => rawurlencode($url)],
'https://schemagen.io/api/embed'
);
$response = wp_remote_get($apiUrl);
if (!is_wp_error($response)) {
echo wp_remote_retrieve_body($response);
}
});
```
## Error responses
When the request is invalid or an error occurs, the embed endpoint returns an empty body with the appropriate HTTP status code. It does not return a JSON error body.
| Status | Cause |
| ------ | ------------------------------------------ |
| `400` | `clientId` or `url` is missing or invalid. |
| `500` | An unexpected server error occurred. |
All error responses still include the `X-Schemagen-ID` header so you can trace the request.
Because the embed endpoint returns an empty string when no schemas match the URL (rather than an error), you can safely output its response in every page template without a null check. Pages with no published schemas will simply have no extra output.