Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
animationType
enum<string>

Animation Preset

Available options:
fadeIn,
slideLeft,
slideRight,
slideBottom,
scaleUp,
rotateIn,
revealClip
timelineType
enum<string>

Timeline

Available options:
view,
scroll
animationRange
enum<string>

Animation Range

Available options:
0% 100%,
entry 0% cover 100%,
entry 0% entry 100%,
cover 0% cover 100%,
0% 50%

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.