Generate Your First Render

Learn how to generate images using the API or integrations

Now that you have a template and API key, you can start generating images. You have two options: use the REST API directly, or use a no-code integration.

Using REST API#

1. Get Your Template ID#

Go to your templates page and copy the template ID.

The quickest way to generate an image or PDF from a template is to first go to Template's Playground

On the playground, you'll see all the details on how you can integrate this template. From Rest API to integrations, this page will give you examples and walkthrough for each use case

Template Playground Page:

2. Make a Render Request#

Send a POST request with your template ID and the values you want to change:

curl -X POST "https://api.orshot.com/v1/studio/render" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "templateId": "YOUR_TEMPLATE_ID",
    "modifications": {
      "title": "Hello World",
      "subtitle": "Welcome to Orshot",
      "authorPhoto": "https://example.com/photo.jpg"
    },
    "response": {
      "type": "url",
      "format": "png"
    }
  }'

Response Types#

Choose how you want to receive the image:

Type	Description	Use Case
`url`	Returns a hosted URL to the image	Web applications, sharing
`base64`	Returns base64-encoded image data	Email, inline embedding
`binary`	Returns raw image binary data	Direct file download

Response Formats#

Choose your output format:

png - Best for graphics with transparency
jpg - Smaller file size, no transparency
webp - Modern format, smaller size
pdf - For printable documents

Learn more about response options →

Example Response#

{
  "data": {
    "content": "https://storage.orshot.com/renders/user123/image-456.png",
    "type": "url",
    "format": "png",
    "responseTime": 1234.56
  }
}