API & Integration -> API Reference

REST API

Creatomate provides a REST API for integration. To begin generating images or video, you'll only need a single API endpoint.

Authentication with the API requires an API key, found in your project settings. From there, you can also set up a webhook to be notified when a render is complete.

Managing templates

Besides rendering, the API lets you manage the templates in your project: create, retrieve, update, and delete them programmatically.

Errors

Every error answers with a JSON body that tells you what to do: hint describes the problem in plain words, and documentation links to the page that covers it. 400 Bad Request is a malformed request or a RenderScript value the engine rejects, 401 Unauthorized a missing or invalid API key, 402 Payment Required an exhausted credit balance (this one carries the hint only), 404 Not Found a template or render that doesn't exist in your project, and 429 Too Many Requests the rate limit. Request bodies are limited to 2 MB.