API Documentation

The URLPreview API allows you to retrieve clean, structured metadata for any public URL, including title, description, images, and favicon.

Base Endpoint

GET https://app.urlpreview.com/api/v1/preview

Authentication

You can authenticate in one of two ways:

• Query parameter: ?url=https://example.com&apiKey=YOUR_API_KEY
• Authorization header: Use your API key as a Bearer token:

Authorization: Bearer YOUR_API_KEY

You can find your API key in your dashboard after signing up.

Query Parameters

• url (required): The full URL you want to preview.
• apiKey (optional): Only required if not using the Authorization header.

Example Request (Query)

curl "https://app.urlpreview.com/api/v1/preview?url=https://example.com&apiKey=YOUR_API_KEY"

Example Request (Bearer Token)

curl -H "Authorization: Bearer YOUR_API_KEY" \
"https://app.urlpreview.com/api/v1/preview?url=https://example.com"

Example Response

{
    "url": "https://example.com",
    "title": "Example Domain",
    "description": "This domain is for use in illustrative examples in documents.",
    "image": "https://example.com/og-image.jpg",
    "favicon": "https://example.com/favicon.ico"
}

Usage Limits

Your plan determines your monthly quota:

• Free plan: 1000 requests/month (limited to 10 per hour)
• Paid plans: No hourly throttling. Use your monthly quota any way you prefer.

Error Handling

On error, the API responds with a JSON object containing an error field.

{
    "error": "Invalid or unreachable URL"
}

Support

For help, contact us at support@urlpreview.com.