Appearance
Social Share Template
Optimized for maximum engagement on social platforms.
Template ID
template: "social"Preview
Engagement-focused layout featuring:
- Bold, attention-grabbing title
- Short description
- Call-to-action button
- Author attribution
- Eye-catching design
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
title | string | Yes | Bold headline |
description | string | No | Supporting text |
author_name | string | No | Creator/author name |
author_avatar_url | string | No | Author photo |
call_to_action | string | No | CTA text (e.g., "Read More") |
theme | string | No | dark (default) or light |
logo_url | string | No | Brand logo |
Example Request
bash
curl -X POST https://ogimageapi.io/api/generate \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"title": "🚀 We just hit 10,000 users!",
"description": "Thank you for being part of our journey. Here'"'"'s what we learned...",
"author_name": "Alex from StartupXYZ",
"author_avatar_url": "https://example.com/alex.jpg",
"call_to_action": "Read the Story",
"template": "social",
"theme": "dark"
}' \
--output social-og.pngLayout Structure
┌─────────────────────────────────────────┐
│ [Logo] │
│ │
│ 🚀 We just hit 10,000 users! │
│ │
│ Thank you for being part of our │
│ journey. Here's what we learned... │
│ │
│ ┌─────────────────────┐ │
│ │ Read the Story │ │
│ └─────────────────────┘ │
│ │
│ ┌──────┐ Alex from StartupXYZ │
│ │Avatar│ │
│ └──────┘ │
│ │
└─────────────────────────────────────────┘Theme Variations
Dark Theme
- Bold, modern look
- High contrast
- Works great in Twitter/X feeds
Light Theme
- Clean, professional
- LinkedIn-friendly
- Softer appearance
Use Cases
| Content Type | Recommended Setup |
|---|---|
| Announcements | Dark + emoji in title |
| Milestones | Dark + CTA |
| Threads | Dark + author |
| Case studies | Light theme |
| Testimonials | Either theme |
Best Practices
- Use emojis strategically — One or two max
- Keep titles punchy — Under 10 words
- Include CTA — Drive clicks
- Add your face — Personal connection matters
- Test both themes — See what works for your audience
Integration Examples
Twitter/X Thread Headers
javascript
async function generateThreadHeader(thread) {
const response = await fetch('https://ogimageapi.io/api/generate', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-Key': process.env.OG_IMAGE_API_KEY
},
body: JSON.stringify({
title: thread.hook,
description: `A ${thread.tweets.length}-part thread on ${thread.topic}`,
author_name: thread.author.name,
author_avatar_url: thread.author.avatar,
call_to_action: 'Read Thread',
template: 'social',
theme: 'dark'
})
});
return response;
}Announcement Posts
javascript
async function generateAnnouncementOG(announcement) {
const response = await fetch('https://ogimageapi.io/api/generate', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-Key': process.env.OG_IMAGE_API_KEY
},
body: JSON.stringify({
title: `${announcement.emoji} ${announcement.headline}`,
description: announcement.subtext,
call_to_action: announcement.cta || 'Learn More',
logo_url: 'https://mycompany.com/logo.png',
template: 'social',
theme: 'dark'
})
});
return response;
}Popular CTA Examples
| Type | CTA Text |
|---|---|
| Blog posts | "Read Article" |
| Products | "Get Started" |
| Events | "Register Now" |
| Updates | "Learn More" |
| Launches | "Try It Free" |
Platform Optimization
| Platform | Tip |
|---|---|
| Twitter/X | Dark theme + emoji |
| Light theme, professional tone | |
| Either, include faces | |
| Discord | Dark theme |