Open Design

Octopus Format

Open Design API returns a JSON-based representation of a design file. We call this output Octopus 🐙. To learn more about how to use the API to generate it, check out the quickstart.

Once you call the artboard content endpoint, you'll see a block of JSON output with layers, colors, styles, etc. You can use the schema below to learn more about the format.

If you have any questions or feedback, please don't hestiate to contact us and we'll be happy to help.

version
object

Object describing current Octopus versions. Should contain octopus-common (required) and any other adapter. Versions should follow semver notation. Version series differ by each implementation.

timeStamp
string<date-time>

Time when this octopus file was generated

Date-time notation as defined by RFC 3339, section 5.6

object

Artboard bounds. Top/Left values of artboard bounds are always 0, so, in fact, it describes only artboard width and height.

number or string

If current artboard is a sketch symbol master, then it has this ID.

Unique identifier (for whole artboard) of an instance.

object

Artboard offset (x/y) relative to the original document.

object

Background color as RGBA (if exists) of current artboard.

hasBackgroundColor
boolean

Boolean flag describing if current artboard has background color activated or not.

includeBackgroundColorInInstance
integer<int32>
Enum:01

Property describes occurrence of background color for symbol instances.

object

Object describing horizontal and vertical rulers guides for the current artboard.

Array of objects

Array with export descriptors. Each entry is assigned to some slice or layer.

object

Object describing interactions on the current artboard.

Array of objects

An array of current artboard layers.