Getting Started
REST API
Endpoints available to manage your PixelPapers.
CREATE A PixelPaper
Overview
Hit the POST /api/paper endpoint to create a PixelPaper.
Request
curl -X POST https://api.pixelpaper.io/api/paper \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {your_api_key}' \
-d '{"name": "My First PixelPaper"}'
Parameters
name string required
A human-readable name to identify this PixelPaper.
template string optional
A Paper identifier to use as a 'template' for this new PixelPaper. When used, this PixelPaper will have the contents
of the 'template' at the time it was created. See the Templates section for full details.
Response
Response
{
"identifier": "433142b2-a30d-4336-b8b9-914f1bfcbd21"
"name": "My First PixelPaper"
"source": "api"
}
The
identifier is the key thing here. It's used to identify a single PixelPaper. Anyone joining the same PixelPaper will
be able to see one another and collaborate.DELETE A PixelPaper
Hit the DELETE /api/paper/{identifier} endpoint to delete a PixelPaper. The identifier was the one
returned to you when you originally created the paper.
Request
curl -X DELETE https://api.pixelpaper.io/api/paper/{identifier} \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {your_api_key}' \
Once a PixelPaper has been deleted, there is no way to recover the data.