Developer Documentation
Feedback

Render API

Introduction

The Render API renders images or PDFs. Unlike the template API, the render API does not require you to create template beforehand. The following is a list of the available endpoints:

Base URL
https://api.tailrender.com
MethodURLCreditsDescription
POST/render1Render an image or PDF
GET/render/{renderId}0Get the result of a previously rendered file

Basic usage

  • POST /render
curl
curl --location --request POST 'https://api.tailrender.com/render' \
--header 'Authorization: {{ YOUR_API_KEY_HERE }}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "type": "pdf",
  "html": "<div class=\"text-green-600\">My first PDF render.</div>"
}'
  • POST /render response
json
{
    "id": "MELxPXnwI5EDIuXAnm9Q",
    "props": {},
    "status": "COMPLETED",
    "result": {
        "pdfUrl": "https://tailrender-api.s3.amazonaws.com/pdf/MELxPXnwI5EDIuXAnm9Q.pdf",
        "url": "https://tailrender-api.s3.amazonaws.com/pdf/MELxPXnwI5EDIuXAnm9Q.pdf"
    }
}