API Reference - Content object
All successful requests for content info return a content
object. In the non-RESTful variant of the API, this content
object is available as the content field of the returned
response
object.
Fields
id [string]: the content's Zoom.it ID. These IDs are case-sensitive alphanumeric, i.e. base-62.
url [string]: the content's source URL. This begins with either "http://" or "https://".
ready [boolean]: whether the content is ready or not. In other words, whether Zoom.it has successfully finished processing this content.
failed [boolean]: whether the content failed or not.
This will only be true if ready is false.
progress [double]: how far along the processing of this content is, as a number between 0 and 1 inclusive.
shareUrl [string]: the Zoom.it URL for sharing this content. Currently, this is of the form "http://zoom.it/{id}".
embedHtml [string]: the HTML snippet for embedding the Zoom.it viewer for this content.
title [string, optional]: the content's title, if Zoom.it was able to derive it. Otherwise, this field isn't present.
attributionText [string, optional]: the attribution text to display with this content, if Zoom.it was able to derive it. Otherwise, this field isn't present.
attributionUrl [string, optional]: the URL to link to for attributing this content, if Zoom.it was able to derive it. Otherwise, this field isn't present.
dzi [DZI, optional]: the content's DZI info, if Zoom.it successfully finished processing it. Otherwise, this field isn't present.
