Reference for the p5.js Web Editor API

documentation.md

p5.js Web Editor API

• Base URL: https://editor.p5js.org/

Some Important Points:

• Only the success responses are mentioned below. For each of the following, in case of an error, an error message will be present in the response, in the format

  {
    "message": "error message"
  }

• For Authenticating the requests, a cookie is required which can be obtained from the Login endpoint.

Login - POST /editor/login

• Auth: None
• Body:

  {
    "email": "p5 email or username",
    "password": "p5 password"
  }

• Response:
  • 200 - UserInfo Object

In this request, save the value of the set-cookie response header for further requests. In all authenticated requests, the Cookie header must be filled with this value.

Get Session - GET /editor/session

• Auth - REQUIRED
• Response:
  • 200 - UserInfo Object

Get All Sketches - GET /editor/{username}/projects

• Auth - None
• Response:
  • 200 - [SketchInfo]

Get Sketch - GET /editor/{username}/projects/{sketchId}

• Auth - None
• Response:
  • 200 - SketchInfo

Update Sketch - PUT /editor/projects/{sketchId}

• Auth - REQUIRED
• Body:

  {
    "files": [SketchFile],
    "id": "sketchId",
    "isSaving": false,
    "owner": SketchOwner,
    "updatedAt": DateTime
  }

• Response:
  • 200 - SketchInfo

Interfaces

UserInfo

{
  "email": "email",
  "username": "username",
  "preferences": {
    "fontSize": number,
    "lineNumbers": bool,
    "indentationAmount": number,
    "isTabIndent": bool,
    "autosave": bool,
    "linewrap": bool,
    "lintWarning": bool,
    "textOutput": bool,
    "gridOutput": bool,
    "theme": string,
    "autorefresh": bool,
    "language": string,
    "autocloseBracketsQuotes": bool,
    "soundOutput": bool
  },
  "apiKeys": [],
  "verified": "verified",
  "id": string,
  "totalSize": number,
  "cookieConsent": string
}

SketchInfo

{
  "name": "Sketch Name",
  "serveSecure": bool,
  "_id": string,
  "user": SketchOwner,
  "updatedAt": DateTime,
  "files": [SketchFile],
  "createdAt": DateTime,
  "slug": string,
  "__v": 0,
  "id": string
}

SketchOwner

{
  "_id": string,
  "username": string,
  "id": string
}

SketchFile

{
  "name": "filename/foldername",
  "content": "file contents",
  "children": [], // array of file ids present in this folder
  "fileType": "file" | "folder",
  "_id": string,
  "createdAt": DateTime,
  "updatedAt": DateTime,
  "id": string
}