apitemplate.io compatible create-image
POST/compat/apitemplate/create-image
Accepts apitemplate.io's request and returns its response shape. The body is the template's data. Each image is a render of its own, made one after the other, so all makes two and costs two units, and a PNG that fails after the JPEG succeeded answers with its error while the JPEG render stays in the log. total_pages is always null. Waiting, errors and ignored parameters as for create-pdf. Needs render:create. Migration only.
Request
Responses
- 200
- 302
- 429
- 504
- default
The images.
export_type=file: the document's link, the download_url the JSON answer would carry. No body.
Response Headers
The document's signed link.
rate_limited: the workspace's bucket of the plan's requests per second is empty (Free test keys also have 30 a minute). The problem names the bucket's limit and its window_seconds. Retry after Retry-After seconds.
Response Headers
Seconds until a request is let through again.
Size of the workspace's request bucket: the plan's requests per second. Free test keys are also held to 30 requests a minute, and the headers then describe whichever bucket is closer to empty.
Requests left in the bucket.
Seconds until the bucket is full again.
render_timeout in apitemplate.io's shape: the render was still running two minutes after it went to the background. transaction_ref names it; fetch it with GET /renders/{id} rather than sending the request again, which would render the document a second time.
An error of the apitemplate.io shim. What the render, the scope, the plan and the quota refuse comes back in apitemplate.io's shape (application/json), with the HTTP status of the underlying problem and a Retry-After where it has one (503). A missing or invalid key, a browser origin the key does not allow, a missing template_id, body or url, an unknown output_image_type and an unexpected error answer as problem details.