API Playground
Try it now.
Pick a template, fill in the variables, get a live share link.
info
Playground limits apply. Organisations are limited in
generation credits per hour and per day. This demo environment
allows only a small number of requests per minute, enough
to try it out, not for production use. Sign up for a full API key
to remove restrictions.
Format:
Preview:
Request
curl
-X POST
$API/v1/shares
\
-H
"Content-Type: application/json"
\
-H
"x-organisation-id: demo-org"
\
-H
"x-api-key: <YOUR_KEY>"
\
-d
'{'
}'
◻
Card renders here
Rendering
POST
/v1/templates
Create a template
Returns a
templateId used
for all subsequent operations. Templates are versioned, you
never edit HTML in place, you add a new version.
Body
namestringrequired
spaceIdstringoptional
cURL
curl
-X POST
$API/v1/templates
\
-H
"x-organisation-id: $ORG"
\
-H
"x-api-key: $KEY"
\
-d
'{"name": "Score Card"}'
← { "id": "uuid", "name": "Score Card" }
POST
/v1/templates/:id/versions
Add a template version
Each call creates a new version (v1, v2, …). Canvas is
1200×630 (OG) or
1080×1920 (Story). Use
{{variable}}
tokens. Inline all CSS for fast renders (50–150ms with Satori).
Body
htmlstringrequired
variablesarrayoptional
stylesstringoptional
format"og" | "story"optional (default: "og")
previewTypeimage | video | bothoptional
cURL
curl
-X POST
$API/v1/templates/$ID/versions
\
-H
"x-organisation-id: $ORG"
\
-H
"x-api-key: $KEY"
\
-d
'{'
"html": $(jq -Rs . < template.html),
"variables": [
{ "name":
"playerName",
"required":
true }
]
}'
← { "id": "uuid", "version": 1 }
GET
/v1/templates
List templates
Returns your org's templates plus all system templates (
organisationId: "_system"). System templates are always visible to every org.
cURL
curl
$API/v1/templates
\
-H
"x-organisation-id: $ORG"
\
-H
"x-api-key: $KEY"
← { "items": [ { "id": "...", "name": "Score Card" } ]
}
POST
/v1/shares
Create a share
Rendering is async, returns
status: "pending"
immediately. Poll
GET /v1/shares/:id until
status === "ready". The
format field selects which
template format to render:
og (1200×630) or
story (1080×1920). Defaults
to og.
Body
templateIdstringrequired
payloadobjectrequired
destinationUrlstringrequired
format"og" | "story"optional (default: "og")
attributionDataobjectoptional
expirySecondsnumberoptional
cURL
curl
-X POST
$API/v1/shares
\
-H
"x-organisation-id: $ORG"
\
-H
"x-api-key: $KEY"
\
-d
'{'
"templateId": "$TEMPLATE_ID",
"payload": { "playerName": "Alice", "score": "42" },
"destinationUrl": "https://example.com"
}'
← { "shareId": "...", "status": "pending", "shareUrl":
"..." }
GET
/v1/shares/:id
Poll share status
Poll every 2s until
status === "ready".
Inline-CSS templates: 3–5s. Google Fonts: up to ~30s. Once
ready, shareUrl and
renderArtifactId are
populated.
Status values
pendingqueued
renderingin progress
readycomplete
failedall retries exhausted
cURL
curl
$API/v1/shares/$SHARE_ID
\
-H
"x-organisation-id: $ORG"
\
-H
"x-api-key: $KEY"
← {
"status": "ready",
"shareUrl": "https://…/s/ax7kp"
}
DELETE
/v1/shares/:id
Delete a share
Permanently removes the share, its render artifact, and stored
media. The
shareUrl returns
404 immediately after deletion.
cURL
curl
-X DELETE
$API/v1/shares/$SHARE_ID
\
-H
"x-organisation-id: $ORG"
\
-H
"x-api-key: $KEY"
← 204 No Content
bolt
Data-Driven Cards are rendered server-side from live sports
data. No template or payload required — just a fixture ID. The URL
itself is the card; embed it as
og:image
or display directly.
Card type:
Select a fixture above
Open ↗