Appearance
FAQ
Frequently asked questions about OG Image API.
General
What is an Open Graph image?
Open Graph (OG) images are the preview images that appear when you share a link on social media platforms like Twitter, Facebook, LinkedIn, and Discord. They make your shared links more engaging and clickable.
What size are the generated images?
All images are 1200x630 pixels, the recommended size for Open Graph images. This size works well across all major social platforms.
What format are the images?
Images are returned as PNG files with full color support and no compression artifacts.
Can I use this for commercial projects?
Yes! All plans include commercial usage rights. Generate images for your clients, products, and businesses.
Technical
How fast is image generation?
Most images generate in under 500ms. Complex images with avatars may take slightly longer due to image fetching.
Is there an SDK?
We don't have official SDKs yet, but our REST API is simple to use with any HTTP client. See our code examples for integration guides.
Can I self-host this?
No, OG Image API is a hosted service only. This ensures consistent quality and performance.
What happens if my avatar URL is invalid?
If the avatar image fails to load, we display a placeholder. Your image will still generate successfully.
Do you support custom fonts?
Currently, we use a carefully selected professional font (Inter). Custom fonts are on our roadmap for Business plans.
Do you support custom templates?
Not yet, but custom templates are planned for future releases. Currently, you can choose from Default, Minimal, and Vibrant.
Account & Billing
How do I get my API key?
Subscribe to any plan (including Free) and you'll receive your API key via email immediately after checkout.
Can I change my API key?
For security reasons, API keys cannot be changed through self-service. Contact support if you need a new key.
What payment methods do you accept?
We accept all major credit/debit cards through Stripe. Regional payment methods may also be available depending on your location.
Can I get a refund?
We don't offer refunds for partial months. If you're unhappy, cancel anytime and you won't be charged again.
Do unused images roll over?
No, unused quota does not roll over to the next month. Plan your usage accordingly.
Usage
What counts toward my quota?
Only successful image generations (HTTP 200) count. Failed requests don't count against your quota.
When does my quota reset?
Quotas reset on the 1st of each month at 00:00 UTC.
Can I pre-generate all my images?
Yes! Many users generate images during their build process. This is the recommended approach for static sites.
Is there a rate limit?
Yes, in addition to monthly quotas:
- Free: 2 requests/second
- Pro: 10 requests/second
- Business: 50 requests/second
Can I cache the images?
Absolutely! We recommend caching images. Our responses include Cache-Control: public, max-age=86400 headers (24 hours).
Troubleshooting
My images look blurry on social media
Our images are high quality (1200x630). If they appear blurry, the platform may be caching an older version. Use a cache debugger to refresh.
My avatar isn't showing
Check that:
- The URL is publicly accessible
- The URL returns an image (not HTML)
- The URL uses HTTPS
- The image isn't too large (< 5MB recommended)
I'm getting a 401 error
Your API key is missing or invalid. Ensure:
- You're including the
X-API-Keyheader - The key is spelled correctly
- There are no extra spaces
I'm getting a 429 error
You've either:
- Exceeded your monthly quota (check
/api/user/usage) - Hit the per-second rate limit (slow down requests)
Images are taking too long
Generation should be < 1 second. If slower:
- Check if avatar URLs are slow to respond
- Try without avatar to isolate the issue
- Contact support if consistently slow
Contact
How do I get support?
- Documentation: You're reading it!
- Email: support@ogimageapi.io
- Response time: 24-48 hours (Pro/Business: 12 hours)
Can I request features?
Yes! Email us at feedback@ogimageapi.io. We prioritize based on customer demand.
Is there a status page?
Check ogimageapi.io/status.html for real-time service status and incident reports.