Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Eraser Diagrams (AI) API

Generate diagrams from natural language prompts or Eraser DSL using AI

Eraser Diagrams (AI) API is one of 7 APIs that Eraser publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Diagrams (AI). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 2 operations across 2 paths, and defines 13 schemas. It is described by OpenAPI 3.0.3, at version v1.0.

Requests are made against a single base URL, https://app.eraser.io.

2 operations 2 paths 13 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1.0
Base URL
https://app.eraser.io
Authentication
HTTP Bearer, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Eraser Diagrams (AI) API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as Authorization (auditApiKey). By default, every request must be authenticated.

  • bearerAuth — Team-specific API bearer token from Eraser settings
  • auditApiKey — Audit-specific API key for accessing audit log endpoints

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Diagrams (AI) 2

Generate diagrams from natural language prompts or Eraser DSL using AI

POST
/api/render/prompt
Generate diagram from natural language prompt (AI)
generateDiagramFromPrompt body → 200400403404500503
POST
/api/render/elements
Generate diagram from Eraser DSL code
generateDiagramFromEraserDsl body → 200400403500503

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are GenerateFromPromptRequest (14 properties), GenerateFromDslRequest (7 properties), GenerateFromPromptResponse (6 properties), DslElement (4 properties). Each schema is shown below with its type and property counts.

DslElement
object
4 properties 2 required
GenerateFromPromptResponse
object
6 properties
GitContext
object
3 properties
GenerateFromPromptRequest
object
14 properties 1 required
FileOptions
object
2 properties
LinkAccess
string
File link access permission level
GenerateFromDslResponse
object
3 properties
GeneratedDiagram
object
2 properties
InlineCodeEdit
object
2 properties 2 required
DiagramTypeWithFreeform
string
Type of Eraser diagram (including freeform)
FileAttachment
object
3 properties 3 required
Error
object
1 property
GenerateFromDslRequest
object
7 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

eraser-diagrams-ai-api-openapi.yml Raw ↑

Other APIs Eraser publishes across the network.

Eraser AI Requests API
Eraser Audit Logs API
Eraser Diagram Elements API
Eraser Files API
Eraser Folders API
Eraser Usage Metrics API