Sign in

Get a diagram

Retrieves a specific diagram from a file.

get/api/files/{fileId}/diagrams/{diagramId}

Path parameters

fileIdstring required

ID of the file containing the diagram

diagramIdstring required

ID of the diagram to retrieve

Response

The diagram

idstring required

Unique identifier for the diagram

diagramUrlstring required

URL to view the diagram in the Eraser canvas

diagramType'sequence-diagram' | 'entity-relationship-diagram' | 'cloud-architecture-diagram' | 'flowchart-diagram' | 'bpmn-diagram' required

Type of the diagram

codestring required

Eraser DSL code for the diagram

updatedAtstring date-time required

ISO 8601 timestamp of when the diagram was last updated

Example response

{
  "diagramUrl": "https://app.eraser.io/workspace/abc123?diagram=def456&layout=canvas"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.