Other
/api/v1/open-graph-checkerPacketFlo Open Graph Checker API
Preview a URL's share card — Open Graph and Twitter Card tags.
| Parameter | Type | Required | Description |
|---|---|---|---|
url | string | Yes | Full URL to fetch (https:// included). |
Example request
curl "https://packetflo.io/api/v1/open-graph-checker?url=https://example.com&api_key=YOUR_API_KEY"
Example response
{ "ok": true, "data": { "requestedUrl": "https://example.com", "finalUrl": "https://example.com/", "statusCode": 200, "fetched": true, "title": "Example — Build for the agent era", "og": { "title": "Example — Build for the agent era", "description": "Welcome to Example.", "image": "https://example.com/preview.png", "url": "https://example.com/", "type": "website", "site_name": null }, "twitter": { "card": "summary_large_image", "title": "Example — Build for the agent era", "description": "Welcome to Example.", "image": "https://example.com/preview.png", "site": null } }, "meta": { "tool": "open-graph-checker", "version": "v1" } }
Reading the result
fetched means the page returned a successful HTTP response. It can be true even if no social metadata was found; inspect og and twitter separately.
Response fields
| Field | What it tells you |
|---|---|
requestedUrl / finalUrl / statusCode | Requested page, destination after redirects and target HTTP status. |
title / og / twitter | HTML title and extracted social tags. Missing tags are null; unsuccessful fetch responses return empty tag objects. |
| Image / URL tags | Relative links are resolved against the final page URL. |
Scope and limits
Fetches HTML with up to six requests and six-second fetch timeouts, reading roughly the first 300 KB. It does not execute JavaScript or verify how social platforms render or cache a preview. Non-2xx target responses can still return a completed API result with fetched: false.
Authentication and errors
Send your key in the x-api-key header, or the supported api_key query parameter. Each request uses 2 credits from the key's shared 300-credit rolling 24-hour budget. Credits are charged before parameter validation. Successful responses and quota errors include usage headers; GET and OPTIONS support CORS.
| API status | Meaning |
|---|---|
200 | The diagnostic returned a result in data, with ok: true and version information in meta. Read the diagnostic fields to determine the target's condition. |
400 | Invalid or blocked input, or a lookup/check failure that could not be returned as a diagnostic result. Read error for details. |
401 | Missing, invalid or revoked API key. |
429 | The request would exceed the key's available credit budget. |