Skip to main content
GET
GIF of an animated diagram

Authorizations

Authorization
string
header
required

An API key (aid_…) from Settings › API.

Path Parameters

id
string<uuid>
required

Query Parameters

quality
enum<string>
default:medium

Resolution and frame rate.

Available options:
low,
medium,
high
size
enum<string>

The frame the animation is fitted into. Left out, the frame of the diagram's preset (ad square, social portrait, blog, data_story and explainer_video landscape), or chat.

Available options:
chat,
square,
portrait,
story,
landscape,
wide
page
integer

One page of a multi-page diagram. Left out, every page plays in order in one video; a long set's still pages hold for less so it fits (at least 1.5 seconds), and one too long even so is refused with 422 too_long, saying how many pages fit.

Required range: 1 <= x <= 100

Response

The file.

The response is of type file.