open-graph-image-api

API endpoints

POST : /api/og
POST : /api/generate-avatar
GET : /api/healthcheck

Curl invocation

curl --location https://og-image-api-three.vercel.app/api/og' \
--header 'Content-Type: application/json' \
--data '{
  "title" : "{dummy_title}",
  "img_url" : "{sample_image_url}",
  "slots" : {slot_count},
  "template" : "commissions"
}'

Note: Substitute {dummy_title}, {sample_image_url}, {slot_count} with actual values to invoke commissions og-image. Refer sample invocation for more details.

Input Parameters

Parameter	Type	Description
title	string	Title of the content, in template
name	string	User's original name
dp_url	url	User's display picture URL
img_url	url	Template's content picture URL
user_name	url	Username (unique)
slots	number	Available slots for commissions
is_private	boolean	Set if user gallery is private or not (0 or 1)
template	string	Template name(post,commissions,extras,gallery) REQUIRED
bg_color	string	Template Background Theme color (hexcode)
page_color	string	Project Page Color hexcode
name_initials	string	Initials of supporter name

Available Templates (Sample Invocations)

Post

{
"title": "Basic Premise for Citadel Series",
"name": "Julie Helen",
"dp_url": "https://images.unsplash.com/photo-1438761681033-6461ffad8d80?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxzZWFyY2h8Mnx8cGVyc29ufGVufDB8fDB8fHww&w=1000&q=80",
"template": "post"
}

Gallery

{
"title": "Character Illustrations",
"img_url": "https://cdn.dribbble.com/users/1338391/screenshots/16081797/media/d6b9acaf5599fa5c2e5e57d4c462a970.jpg",
"dp_url": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcS6fN3fQYT4v44UcLmMAyudCfBMiweCc-OgBw&usqp=CAU",
"name": "Julia Helen",
"is_private": 0,
"template": "gallery"
}

Extras

{
"title": "Free chai recipe ebook low cost",
"img_url": "https://images.unsplash.com/photo-1528287942171-fbe365d1d9ac?ixlib=rb-1.2.1&q=85&fm=jpg&crop=entropy&w=1200&cs=srgb&ixid=eyJhcHBfaWQiOjE0NTg5fQ",
"user_name": "juliehelen",
"template": "extras"
}

Commissions

{
"title": "Character Illustration Combo Pack",
"img_url": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRG44uLYgcyaXCV3mrzuUdAM7ZHZd_Y-250KNS26AudD83v_K3IKRP9ZVt_zfDRqU8e7dI&usqp=CAU",
"slots": 10,
"template": "commissions"
}

Creator Page

{
"title" : "Julie Noman is creating music videos",
"user_name" : "julienomanos",
"dp_url" :"https://avada.com/wp-content/uploads/2018/11/person_sample_3.jpg",
"bg_color" :  "#FFFCE5",
"template" : "creator"
}

Supporter Avatar generator

Request format

{
"page_color" : "#EFC16D",
"name_initials" : "KK"
}