Docs / Templates / Project Showcase template

Project Showcase template

The project-showcase template renders a developer image as a PNG. POST a JSON payload to the endpoint below and you receive a CDN URL in the response.

Endpoint

POST https://html2img.com/api/v1/templates/project-showcase
X-API-Key: <your-api-key>
Content-Type: application/json

Authentication uses the X-API-Key header. See the authentication docs for details on issuing and rotating keys.

Inputs

The full set of inputs the template accepts:

Name	Type	Required	Description	Example
`version`	string	No	Text value for the version.	`v3.2`
`title`	string	Yes	Main headline shown in the image.	`Live presence and cursor sharing`
`summary`	string	No	Text value for the summary.	`See exactly who is editing what, in real time, across every doc in your workspace.`
`eyebrow`	string	No	Text value for the eyebrow.	`CHANGELOG`
`screenshot_url`	url	No	URL of the screenshot to include in the rendered image.	`https://picsum.photos/seed/project-showcase/900/560`
`product_name`	string	No	Text value for the product name.	`Northwind Docs`
`logo_url`	url	No	URL of the logo to include in the rendered image.	`—`
`background_color`	string	No	Hex colour code for the background.	`#0B0F1A`
`accent_color`	string	No	Hex colour code for the accent.	`#22D3EE`

Defaults

Defaults applied automatically when not overridden in the request:

Option	Default value
`width`	`1600`
`height`	`900`

Code examples

curl -X POST https://app.html2img.com/api/v1/templates/project-showcase \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"version":"v3.2","title":"Live presence and cursor sharing","summary":"See exactly who is editing what, in real time, across every doc in your workspace.","eyebrow":"CHANGELOG","screenshot_url":"https://picsum.photos/seed/project-showcase/900/560","product_name":"Northwind Docs","background_color":"#0B0F1A","accent_color":"#22D3EE"}'

<?php
$response = \Illuminate\Support\Facades\Http::withHeaders([
    'X-API-Key' => 'YOUR_API_KEY',
])->post('https://app.html2img.com/api/v1/templates/project-showcase', ['version' => 'v3.2', 'title' => 'Live presence and cursor sharing', 'summary' => 'See exactly who is editing what, in real time, across every doc in your workspace.', 'eyebrow' => 'CHANGELOG', 'screenshot_url' => 'https://picsum.photos/seed/project-showcase/900/560', 'product_name' => 'Northwind Docs', 'background_color' => '#0B0F1A', 'accent_color' => '#22D3EE']);

$url = $response->json('url');

const response = await fetch('https://app.html2img.com/api/v1/templates/project-showcase', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "version": "v3.2",
    "title": "Live presence and cursor sharing",
    "summary": "See exactly who is editing what, in real time, across every doc in your workspace.",
    "eyebrow": "CHANGELOG",
    "screenshot_url": "https://picsum.photos/seed/project-showcase/900/560",
    "product_name": "Northwind Docs",
    "background_color": "#0B0F1A",
    "accent_color": "#22D3EE"
}),
});

const { url } = await response.json();

import requests

response = requests.post(
    'https://app.html2img.com/api/v1/templates/project-showcase',
    headers={'X-API-Key': 'YOUR_API_KEY'},
    json={'version': 'v3.2', 'title': 'Live presence and cursor sharing', 'summary': 'See exactly who is editing what, in real time, across every doc in your workspace.', 'eyebrow': 'CHANGELOG', 'screenshot_url': 'https://picsum.photos/seed/project-showcase/900/560', 'product_name': 'Northwind Docs', 'background_color': '#0B0F1A', 'accent_color': '#22D3EE'},
)

url = response.json()['url']

Looking for a fuller integration sketch in your language? The usage guides cover PHP, Laravel, Rails, Python, JavaScript, React and Vue.

Response

A successful render returns:

{
  "success": true,
  "id": "abc123",
  "url": "https://i.html2img.com/abc123.png",
  "credits_remaining": 1234,
  "template": "project-showcase"
}

The url field is a CDN URL for the rendered PNG. credits_remaining tracks your monthly quota. Shared response fields are documented in the API parameters reference.

Errors

The template endpoint returns the following error responses:

422 Validation failed

Returned when one or more inputs fail validation. The errors object lists field-specific messages.

{
  "success": false,
  "error": "validation_failed",
  "errors": {
    "title": ["The title field is required."]
  }
}

404 Template not found

Returned with {"code": "template_not_found"} if the slug is not registered. Check the template list for current slugs.

401 Unauthorised

Missing or invalid API key. See the authentication docs.

429 Too many requests

You have hit the rate limit or used your monthly credits. The pricing page covers higher-volume plans.

Related templates

GitHub Social Preview — Repo cards sized for GitHub social preview, share posts, and READMEs
Code Screenshot — Beautiful syntax-highlighted code screenshots with window chrome

See the Project Showcase template in our gallery for sample renders and use cases.

Documentation