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 Files API

Create and manage Eraser files

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

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

This API exposes 5 operations across 2 paths, and defines 12 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.

5 operations 2 paths 12 schemas 1 DELETE2 GET1 POST1 PUT

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 Files 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 5

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

Files 5

Create and manage Eraser files

POST
/api/files
Create a new file
createFile body → 200400401403500
GET
/api/files
List files
listFiles 5 params → 200400401403500
GET
/api/files/{fileId}
Get a file
getFile 1 param → 200400401403404500
PUT
/api/files/{fileId}
Update a file
updateFile 1 param body → 200400401403404500
DELETE
/api/files/{fileId}
Archive a file
archiveFile 1 param → 200400401403404500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are File (8 properties), CanvasElement (7 properties), CreateFileRequest (5 properties), UpdateFileRequest (3 properties). Each schema is shown below with its type and property counts.

CanvasElement
object
7 properties 1 required
FileList
object
2 properties 1 required
FileWithContent
CreateFileRequest
object
5 properties
LinkAccess
string
File link access permission level
FileContent
object
2 properties
UpdateFileRequest
object
3 properties
DiagramType
string
Type of Eraser diagram
CanvasElementWithId
File
object
8 properties 7 required
Error
object
1 property
ArchiveFileResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

eraser-files-api-openapi.yml Raw ↑

Other APIs Eraser publishes across the network.

Eraser AI Requests API
Eraser Audit Logs API
Eraser Diagram Elements API
Eraser Diagrams (AI) API
Eraser Folders API
Eraser Usage Metrics API