Skip to main content

Data Objects

Data objects are used to import any type of binary data. This may be used in conjuction with the low level API store function, or the data may be embedded directly.

Store Objects

When referencing a stored object, the data object is specified as a string by the server-provided "object_id". The object must have been uploaded prior to the API action in which it is being referenced.

Example

{
 "file": "<object ID>"
}

Embedded Objects

The content of an object may be embedded in JSON.

Text

Example

{
 "file": {
  "type": "text",
  "content": "<plain text>"
 }
}

Base64

Example

{
 "file": {
  "type": "base64",
  "content": "<plain text>"
 }
}