Prompt → Diagram (AI)

post

https://app.eraser.io/api/render/prompt

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

text

string

required

The prompt. The input code or natural language which describes a diagram.

diagramType

string

enum

Select desired diagram type. Will automatically detect diagram type when unspecified.

Allowed:

mode

string

enum

Select "standard" for GPT-4.1 or "premium" for o4-mini-high. Defaults to "standard"

Allowed:

priorRequestId

string

ID of a previous request to edit. When provided, the API will edit the diagram from that request.

attachments

array of objects

File attachments to provide context for diagram generation. Accepts PNG, JPEG, and PDF files.

attachments

contextId

string

ID of a reference library to use as context for generation. Find contextId in the reference library page (https://app.eraser.io/dashboard/ai-context).

git

object

deprecated

Deprecated. Use gitContexts instead.

gitContexts

array

Git repository contexts for diagram generation. Supports one or more repositories. Use publicRepoUrl for public repos, or repoName and orgName for private repos connected to your team.

gitContexts

returnImageAsFile

boolean

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

returnFile

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.

background

boolean

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

theme

string

enum

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

Allowed:

imageQuality

integer

enum

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

Allowed:

scale

integer

enum

deprecated

Deprecated. Use imageQuality instead.

Allowed:

Responses

400

The request is missing required parameters or validation failed

403

Unauthorized

404

Prior request or context not found

500

Eraser was unable to generate a result

503

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

200The result of the diagram generation