Animations: API reference

GET/animations/{animation_id}

Status and result of an animation

API key or sign-inMCP: get_animation

Re-check one still "queued" or "rendering", or get its project-page link again. Same shape as creating one (with the storyboard once it has rendered).

Parameters
Name	In	Type	Description
animation_id *	path	string

Response: AnimationResponse
Field	Type	Description
animation_id *	string
duration_seconds	number \| null
error	string \| null	The render output when it failed
file_path	string \| null	Where the video is in the project's files
layout_report	string \| null
message *	string
paper_id	integer \| null
project_id	integer \| null
status *	string	queued, rendering, succeeded or failed
storyboard_png_base64	string \| null	The storyboard PNG (base64), once rendered
title	string \| null
url	string \| null	The project page that plays the video (once succeeded)

curl

curl 'https://api.papervantage.com/animations/1' \
  -H "Authorization: Bearer $PV_API_KEY"

pv animations get <animation_id>

POST/projects/{project_id}/animations

Render a short explanatory animation (an MP4) from ManimGX scene code

API key or sign-inMCP: create_animationcostly

It is saved into the project's Files (under animations/), and the result links to the project page that plays it, plus a storyboard image to check the work against. Keep it short: aim for 30 s or less (60 s is the hard limit). Rendering takes roughly 30-90 s; the request waits up to wait_seconds, after which re-check with GET /animations/{animation_id}. Members only; the project must have room for the video (up to 50 MB). Limits: 2 renders in flight and 30 per 24 hours per member (3 at once across everyone), scene_code up to 64 KB, output up to 60 s at 1920x1080, 30 fps. ManimGX reference: https://manimgx.academa.ai/llms.txt

Parameters
Name	In	Type	Description
project_id *	path	integer

Request body (JSON)
Field	Type	Description
paper_id	integer \| null	Optional PaperVantage paper the animation explains
scene_code *	string	A complete Python file using ManimGX (must `import manimgx`)
scene_name	string \| null	The Scene class to render; needed only if scene_code defines several
title *	string	Short human-readable title, e.g. "Scaled dot-product attention"
wait_seconds	integer	How long to wait for the render (0-50, default 20). Through api.<domain> keep it at 25 or less: API Gateway ends a request at 30 s. Poll GET /animations/{animation_id} after that.

Response: AnimationResponse
Field	Type	Description
animation_id *	string
duration_seconds	number \| null
error	string \| null	The render output when it failed
file_path	string \| null	Where the video is in the project's files
layout_report	string \| null
message *	string
paper_id	integer \| null
project_id	integer \| null
status *	string	queued, rendering, succeeded or failed
storyboard_png_base64	string \| null	The storyboard PNG (base64), once rendered
title	string \| null
url	string \| null	The project page that plays the video (once succeeded)

curl

curl -X POST 'https://api.papervantage.com/projects/1/animations' \
  -H "Authorization: Bearer $PV_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"scene_code":"<scene_code>","title":"<title>"}'

pv animations create <project_id> --scene-code <scene_code> --title <title>