Images, Copies and Libraries

Worked examples for the rest of a file: images, pictures, copies and your libraries.

Applies To

livediagram and livehuddle

A tab's elements change through changesets, but a file holds more than elements: the images it shows, pictures of its tabs, copies of it. Each has its own endpoints, shown here with curl. The examples assume your API token is in $TOKEN and a file id in $DOC; /api/openapi.json has every field.

Every write here reaches anyone with the file open straight away, credited to you.

Images

Upload the raw bytes of a PNG, JPEG, WebP or GIF, up to 10 MB, with its pixel size in two headers:

{
  "image": {
    "id": "9f2c…",
    "contentType": "image/png",
    "byteSize": 48211,
    "width": 1200,
    "height": 800,
    "originalName": "architecture.png",
    "createdAt": 1760180000000
  },
  "deduped": false
}

Uploading the same bytes again answers the image you already have, with "deduped": true. Then put it on a tab with a changeset that adds a whole image element:

GET /images lists your uploads, GET /images/usage maps each to the files that use it, GET /images/{id} downloads one, and DELETE /images/{id} removes it from your gallery. Refusals are 415 unsupported_type, 413 file_too_large, and on a host that sets a gallery limit, 403 gallery_full.

A Tab as a Picture

Copy a File

Makes a copy in your own files and answers 201 with the new document. Leave out name for <name> (copy). Anything you can read can be copied; share links are not copied with it.

Shape Libraries

Was this article helpful?

Still need help?

Try Troubleshooting, or tell us what you were trying to do.

Contact us