Create one project from approved text
The example submits a brief and keeps its returned video ID with the source record.
Send an approved brief from your application to ngram, keep the returned video ID beside the customer record, and deliver the right version when it is ready. Use a preview for review or an MP4 when the destination needs a file.
- Create once — Send a brief or source URL with a stable request key.
- Track the job — Read the current status, project link and available result.
- Export a version — Request an MP4 for the version and resolution your account can deliver.
Three example API operations
Check what the job produced
Use the job ID to inspect the current result and distinguish a preview from an MP4 ready for delivery.
Export the reviewed version
Select a specific version and allowed resolution, then wait for the export URL before sending it onward.
How it works
From a request to a reviewed file
Use an account-scoped key and a stable job reference so the result returns to the right caller.
01
Check the account and key
Create a bearer key in Settings → API Keys and keep it on your server. Call GET /api/v1/account to check the linked account. API-key video creation requires Basic or a higher paid plan and available credits.
02
Submit an approved brief
POST to /api/v1/videos:fromText for a text brief or /api/v1/videos:fromUrl for a public source URL. Use one Idempotency-Key for this logical request. Save the returned video ID with the record that started it.
03
Inspect the existing job
GET /api/v1/videos/{id} returns the current status. A 202 create response means the job was accepted. For a job waiting on a plan or question, inspect state and pending before submitting another request.
04
Deliver the intended version
For MP4 delivery, read the finished result URL. For a preview-first job, inspect live_preview or export the reviewed version with POST /api/v1/videos/{id}/exports. Check export status before forwarding a file.
What the server exposes
Create, check and export through HTTP
Use these operations to keep the project linked to the record that requested it.
Account-scoped credentials
Create, rotate and revoke API keys in Settings. Keep a key on the server that owns the integration. Requests see the resources belonging to the connected ngram account.
Create from text or a URL
Use the text route for approved copy and the URL route when a public page is the source. Choose MP4 delivery for a file or preview delivery for an editable review step.
Status and review
Use the video ID from the create response. Check processing, completion or failure, and inspect any pending question when the request uses plan review.
Version-specific export
Request an allowed resolution and include version_id when the file must match a reviewed cut. Poll the export until ready. A newer edit may require a new export.
Where it fits
When application code should start the video
Use a request from your server when the brief already lives in an application record. Choose chat for a brief that still needs discussion.
Generate a draft when a report is approved
Create a customer update from the approved figures in your system. Store the source record and job ID together so the right editor can review the result.
Explore the workflowExplain a change from a release URL
Submit the approved release page when a shipped feature needs a short explanation. Check the result against the current product before giving it to customers.
Explore the workflowBuild a review step into a customer portal
Use preview delivery when a person must inspect a version before receiving a file. Export the approved version only when the portal needs an MP4.
Explore the workflowThe rest of ngram
Explore all features What to review in the video project
These features apply to the ngram project itself. Choose the relevant creation inputs and review the finished video before delivery.
AI Visuals
Define the visuals the approved request needs before you create it.
Explore featureAI Voiceover
Listen for phrases the narration must pronounce correctly before accepting the version.
See featureScript Generation
Check script claims against the source bound to this project.
See featureVideo Editing
Make a specific correction, then inspect the project’s newest version before export.
See featureMotion Graphics
Use an explanatory diagram when the source describes a process.
See featureCaptions
Inspect captions in the version the customer will receive.
See featureBrand Kit
Choose a Brand Kit when creating a customer-facing project that needs its own identity.
See featureTranslation
Create a separate language version and keep its ID with the original customer record.
See featureChoose source material
All converters Where should the video brief come from?
Choose a source that contains the facts to explain. A text or URL creation request is useful when the input is already approved.
More ngram tools
All ngram tools Tools for a separate project edit
Use these Studio tools to prepare or revise the video when the job needs a creative change.
Create from approved materialStart from approved material
Text to Video
Create a separate draft from approved copy.
Open toolAI Avatar Video Generator
Open Studio when the project needs a different presenter.
Open toolAI Voice Generator
Check a voice reading before requesting the next version.
Open toolAI Image Generator
Prepare a visual source to accompany the brief.
Open toolReview a finished projectReview the first preview
Auto Subtitle Generator
Add subtitles before choosing a final export.
Open toolBackground Noise Remover
Remove noise in source footage before building the request.
Open toolVideo Translator
Make a separate language version of the reviewed video.
Open toolEye Contact AI
Correct a presenter shot in Studio.
Open toolTrim or revise the cutFinish a project in Studio
Video Cutter
Trim the source recording before a new project request.
Open toolVideo Editor
Inspect the finished project and make a targeted correction.
Open toolAdd Subtitles to Video
Review the subtitle track before selecting export captions.
Open toolAdd Music to Video
Choose music for a project that will be exported.
Open toolBuilt for teams
All solutions Who owns the request and result?
Assign the job to the team that can validate the source, check the correct customer destination and respond when the job needs attention.
Developer Relations
Keep a sample request beside its expected response for developer onboarding.
Customer Success
Match the right customer record with its onboarding video.
By industry
Other ways to trigger ngram
All integrations Choose the trigger or delivery mechanism
Pick the starting surface and the result-handling mechanism independently. A request to create a video and a notification about its result do different jobs.
Webhookspublish
Receive completion and failure notifications after creating an API job.
Explore webhooks
MCP ServercreateUse a compatible assistant for creative decisions and revisions in conversation.
Explore MCP
ZapiercreateStart and route a job through a managed workflow with supported trigger and action fields.
Explore Zapier
n8ncreateUse the ngram node when a team already owns conditional routing and workflow operations in n8n.
Explore n8nHow it compares
Choose how your application starts and follows a job
Public API Create and read | Webhooks Terminal notification | MCP Assistant | Zapier Workflow | |
|---|---|---|---|---|
| Who initiates | Your server | ngram on completion or failure | A person in chat | A trigger in a Zap |
| Result reference | Job and version IDs | Job and version IDs | Project or preview link | Mapped action result |
| Where it fits | Application-owned creation | Background notifications | A changing creative brief | Managed workflow routing |
| Next step | Store and review the result | Authenticate the event | Review in conversation | Continue the configured Zap |
FAQ
Questions about the public video API
Key management is self-service for signed-in users. Video creation using an API key requires Basic or a higher paid plan, available credits and an allowed model. Check GET /api/v1/account and GET /api/v1/options before creating.
Still curious? Read the setup guide
Public API
Start with one approved request
Create a server-side key, check the account and keep the first video ID with its source record.