Docs / Templates / Twitter/X Post Image template

Twitter/X Post Image template

The twitter-post template renders a social 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/twitter-post
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
`title`	string	Yes	Main headline shown in the image.	`We just shipped real-time collaboration`
`subtitle`	string	No	Secondary line of text shown below the title.	`Edit docs together with sub-100ms latency, on every plan.`
`eyebrow`	string	No	Text value for the eyebrow.	`PRODUCT UPDATE`
`author_name`	string	No	Author or brand name displayed alongside the image.	`Acme Engineering`
`author_handle`	string	No	Text value for the author handle.	`@acmeeng`
`author_avatar_url`	url	No	URL of the author avatar to include in the rendered image.	`https://i.pravatar.cc/160?img=12`
`logo_url`	url	No	URL of the logo to include in the rendered image.	`—`
`background_color`	string	No	Hex colour code for the background.	`#0B1220`
`accent_color`	string	No	Hex colour code for the accent.	`#1D9BF0`

Defaults

Defaults applied automatically when not overridden in the request:

Option	Default value
`width`	`1200`
`height`	`675`

Code examples

curl -X POST https://app.html2img.com/api/v1/templates/twitter-post \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"We just shipped real-time collaboration","subtitle":"Edit docs together with sub-100ms latency, on every plan.","eyebrow":"PRODUCT UPDATE","author_name":"Acme Engineering","author_handle":"@acmeeng","author_avatar_url":"https://i.pravatar.cc/160?img=12","background_color":"#0B1220","accent_color":"#1D9BF0"}'

<?php
$response = \Illuminate\Support\Facades\Http::withHeaders([
    'X-API-Key' => 'YOUR_API_KEY',
])->post('https://app.html2img.com/api/v1/templates/twitter-post', ['title' => 'We just shipped real-time collaboration', 'subtitle' => 'Edit docs together with sub-100ms latency, on every plan.', 'eyebrow' => 'PRODUCT UPDATE', 'author_name' => 'Acme Engineering', 'author_handle' => '@acmeeng', 'author_avatar_url' => 'https://i.pravatar.cc/160?img=12', 'background_color' => '#0B1220', 'accent_color' => '#1D9BF0']);

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

const response = await fetch('https://app.html2img.com/api/v1/templates/twitter-post', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "title": "We just shipped real-time collaboration",
    "subtitle": "Edit docs together with sub-100ms latency, on every plan.",
    "eyebrow": "PRODUCT UPDATE",
    "author_name": "Acme Engineering",
    "author_handle": "@acmeeng",
    "author_avatar_url": "https://i.pravatar.cc/160?img=12",
    "background_color": "#0B1220",
    "accent_color": "#1D9BF0"
}),
});

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

import requests

response = requests.post(
    'https://app.html2img.com/api/v1/templates/twitter-post',
    headers={'X-API-Key': 'YOUR_API_KEY'},
    json={'title': 'We just shipped real-time collaboration', 'subtitle': 'Edit docs together with sub-100ms latency, on every plan.', 'eyebrow': 'PRODUCT UPDATE', 'author_name': 'Acme Engineering', 'author_handle': '@acmeeng', 'author_avatar_url': 'https://i.pravatar.cc/160?img=12', 'background_color': '#0B1220', 'accent_color': '#1D9BF0'},
)

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": "twitter-post"
}

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

Instagram Square Post — Bold square images sized for the Instagram feed
Open Graph Image — Generate dynamic Open Graph images from JSON
YouTube Thumbnail — High-contrast 16:9 thumbnails optimized for click-through
Facebook Post Image — Bold share images sized for Facebook feed posts

See the Twitter/X Post Image template in our gallery for sample renders and use cases.

Documentation