API Reference

Eraser DSL → Diagram

post
https://app.eraser.io/api/render/elements
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
elements
array of objects
required

Eraser canvas element objects

elements*
boolean

Select transparent (false) or solid (true) background. Defaults to false.

string
enum

Select "light" or "dark" theme. Defaults to "light".

Allowed:
integer
enum

Image quality/resolution multiplier. Use 1 (low), 2 (medium), or 3 (high). Defaults to 2.

Allowed:
integer
enum
deprecated

Deprecated. Use imageQuality instead.

Allowed:
boolean

When true, returns the image as a file stream instead of a URL.

boolean
deprecated

Deprecated. Use returnImageAsFile instead.

fileOptions
object

Options for creating an Eraser file immediately with granular link access settings, rather than returning a URL for manual creation.

string

Title for the created Eraser file. Only applies when fileOptions.create is true. If not provided, title is derived from the diagram code.

Responses

400

The request is missing the 'text' parameter

403

Unauthorized

500

Eraser was unable to generate a result

503

Service temporarily unavailable. This may be the result of too many requests.

Updated 6 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago