API Overview

The Pictify API is a RESTful JSON API for generating images, GIFs, and PDFs programmatically.

Base URL

https://api.pictify.io

Authentication

All requests require a Bearer token:

curl https://api.pictify.io/image \
  -H "Authorization: Bearer YOUR_API_KEY"

See Authentication for details.

Request Format

Content-Type: application/json
Request bodies are JSON
Dates use ISO 8601 format

curl -X POST https://api.pictify.io/image \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "html": "<h1>Hello World</h1>",
    "width": 1200,
    "height": 630
  }'

Response Format

Successful responses return JSON with relevant data:

{
  "url": "https://cdn.pictify.io/renders/abc123.png",
  "id": "img_abc123",
  "width": 1200,
  "height": 630,
  "createdAt": "2026-01-29T10:30:00Z"
}

Error responses are plain JSON with a human-readable message under message or error (see Error Handling for every shape):

{
  "message": "Template not found"
}

Rate Limits and Credits

Two separate limits apply, and — for historical reasons — they surface under different status codes per endpoint family:

Monthly credits — every render (image, GIF, PDF page, video) consumes credits. When they run out, the image, GIF, HTML-template and batch endpoints return 429 with code: "quota_exceeded", while the video and workflow endpoints return 402 with the same code. Treat quota_exceeded as “wait for the monthly reset or upgrade” — never as “retry with backoff”: no amount of retrying refills a monthly quota.
Per-endpoint rate limits — a few endpoints (unauthenticated public rendering, template previews) carry fixed per-minute limits. These return 429 without a quota_exceeded code and DO send standard x-ratelimit-* headers and retry-after — those are genuinely retryable after backing off.

So the rule for 429 is: check the code field first. quota_exceeded means credits, not rate.

Pagination

List endpoints return paginated results:

curl "https://api.pictify.io/templates?page=2&limit=20" \
  -H "Authorization: Bearer $API_KEY"

Response includes pagination metadata:

{
  "templates": [...],
  "pagination": {
    "page": 2,
    "limit": 20,
    "total": 45,
    "totalPages": 3,
    "hasNext": true,
    "hasPrev": true
  }
}

HTTP Status Codes

Code	Description
200	Success
201	Created
202	Accepted (async operation started)
400	Bad Request (validation error)
401	Unauthorized (invalid API key)
403	Forbidden (access denied)
404	Not Found
422	Unprocessable Entity
429	Rate Limit Exceeded
500	Internal Server Error

Idempotency

POST requests can include an Idempotency-Key header for safe retries:

curl -X POST https://api.pictify.io/image \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: unique-request-id-123" \
  -H "Content-Type: application/json" \
  -d '{"html": "..."}'

The same key with the same request will return the cached response for 24 hours.

Versioning

The API does not currently use URL-based versioning. All endpoints are accessed directly from the base URL. Breaking changes will be communicated in advance via release notes.

SDK Libraries

Official SDKs handle authentication, retries, and error handling:

Endpoints

Generation

Endpoint	Method	Description
`/image`	POST	Generate an image
`/image/canvas`	POST	Image from FabricJS canvas
`/image/agent-screenshot`	POST	AI-powered screenshot
`/templates/{uid}/render`	POST	Render template to image
`/gif`	POST	Generate a GIF
`/gif/capture`	POST	Capture GIF from URL
`/pdf/render`	POST	Generate a PDF
`/pdf/multi-page`	POST	Multi-page PDF

Templates

Endpoint	Method	Description
`/templates`	GET	List templates
`/templates`	POST	Create template
`/templates/{uid}`	GET	Get template
`/templates/{uid}`	PUT	Update template
`/templates/{uid}`	DELETE	Delete template
`/templates/{uid}/render`	POST	Render template
`/templates/{uid}/variables`	GET	Get variables

Batch Operations

Endpoint	Method	Description
`/templates/{uid}/batch-render`	POST	Start batch job
`/templates/batch/{id}/results`	GET	Get batch results
`/templates/batch/{id}/cancel`	POST	Cancel batch

Webhooks

Endpoint	Method	Description
`/webhook-subscriptions`	GET	List subscriptions
`/webhook-subscriptions`	POST	Create subscription
`/webhook-subscriptions/{uid}`	GET	Get subscription
`/webhook-subscriptions/{uid}`	PUT	Update subscription
`/webhook-subscriptions/{uid}`	DELETE	Delete subscription

Bindings

Endpoint	Method	Description
`/bindings`	GET	List bindings
`/bindings`	POST	Create binding
`/bindings/{uid}`	GET	Get binding
`/bindings/{uid}`	PUT	Update binding
`/bindings/{uid}`	DELETE	Delete binding

Overview

Images

GIFs

PDFs

Templates

Batch

URL Rendering

Video

Workflows

Webhooks

Bindings

API Overview

API Overview

Base URL

Authentication

Request Format

Response Format

Rate Limits and Credits

HTTP Status Codes

Idempotency

Versioning

SDK Libraries

Endpoints

Generation

Templates

Batch Operations

Webhooks

Bindings

​API Overview

​Base URL

​Authentication

​Request Format

​Response Format

​Rate Limits and Credits

​Pagination

​HTTP Status Codes

​Idempotency

​Versioning

​SDK Libraries

​Endpoints

​Generation

​Templates

​Batch Operations

​Webhooks

​Bindings

API Overview

Base URL

Authentication

Request Format

Response Format

Rate Limits and Credits

Pagination

HTTP Status Codes

Idempotency

Versioning

SDK Libraries

Endpoints

Generation

Templates

Batch Operations

Webhooks

Bindings