Import Video Post
postnitro_import_videoCreate a video post (postType VIDEO) from your own scene content. Returns an embedPostId to track progress.
Scenes use the SAME slide array as a carousel: exactly 1 starting_slide, at least 1 body_slide, exactly 1 ending_slide — each slide becomes a scene. Infographic layouts work as they do on carousel slides.
Output: 'DESIGN' (default) creates the design without rendering; 'MP4' renders the video file and requires videoSettings (duration, optional audio track).
templateId, brandId, and responseType are optional if you've saved defaults via postnitro_set_defaults.
Use postnitro_check_status to monitor, then postnitro_get_output to retrieve. Or use postnitro_import_video_and_wait for one step.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slides | Yes | The scenes, as an array of 3+ typed slides (exactly 1 starting_slide first, 1+ body_slide, exactly 1 ending_slide last). | |
| brandId | No | Brand ID (optional if saved via postnitro_set_defaults) | |
| templateId | No | Template ID (optional if saved via postnitro_set_defaults) | |
| requestorId | No | Optional custom tracking ID | |
| responseType | No | Output format for a video. 'DESIGN' (default) creates the design without rendering — fastest, and enough for scheduling or finishing in the editor. 'MP4' renders the video file and requires videoSettings. A video cannot be rendered as PDF or PNG. | |
| videoSettings | No | Video render settings. REQUIRED when responseType is 'MP4' (a render needs a duration); optional for 'DESIGN'. When this video is later scheduled as a reel, the API reuses these settings automatically. | |
| generateImages | No | Optional AI image generation — include this object to enable it, omit it for no images. When included, `context` is required and you (the agent) must author it from the post. Best-effort: the post still COMPLETES if images fail or aren't permitted (free plan / exhausted AI-image quota); check the GENERATE_IMAGES step via postnitro_check_status. Requires a paid plan, consumes the org's AI-image quota (separate from post credits), and adds latency. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | Initial job status ('PENDING') | |
| message | No | Message returned by the PostNitro API | |
| success | Yes | True when the job was accepted | |
| nextStep | Yes | The suggested follow-up call | |
| warnings | No | Non-fatal issues worth surfacing to the user (e.g. AI image generation did not complete) | |
| embedPostId | Yes | Generation-job ID — pass to postnitro_check_status, then postnitro_get_output | |
| usedDefaults | Yes | The values actually applied — explicit arguments, saved defaults, or an auto-selected sole candidate |