Skip to main content
Ngram logo
  • Category: ai content generation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 14
  • Triggers: 0
  • Slug: NGRAM
  • Version: 20261101_00

Tools

Slug: NGRAM_CANCEL_VIDEOIrreversibly request cancellation of an in-progress Ngram video render. Confirm the target video before calling. Ngram states that cancellation does not refund work already completed.

Input Parameters

string
required
ID of the in-progress Ngram video to cancel, beginning with vid_. Cancellation is irreversible and may not refund work already completed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NGRAM_CREATE_WEBHOOK_SUBSCRIPTIONSubscribe a public HTTPS endpoint to all account-wide Ngram video completion or failure events of one type. The response includes a signing secret that is shown only at creation and must be retained to verify webhook signatures.

Input Parameters

string ("video.completed" | "video.failed")
required
Account-wide Ngram video event to deliver.
string
required
Public HTTPS callback URL that will receive matching account-wide events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NGRAM_DELETE_WEBHOOK_SUBSCRIPTIONDelete an Ngram webhook subscription by ID. The operation is idempotent: a missing subscription returns deleted=false rather than an error.

Input Parameters

string
required
Ngram webhook subscription ID beginning with sub_, returned by webhook subscription creation or listing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NGRAM_GENERATE_IMAGESpend Ngram credits to start one image generation job from a prompt, optionally using one to four public HTTPS reference images for transformation. Inspect NGRAM_GET_CREDITS and NGRAM_GET_RENDER_OPTIONS first, then deliberately set confirm_credit_spend=true and reuse the same idempotency_key for retries. Exact cost has not been live-verified.

Input Parameters

string
required
Description of the image to generate or the changes to make to reference images, from 1 to 6000 characters.
string
Image model ID from NGRAM_GET_RENDER_OPTIONS.
string
Image style ID from NGRAM_GET_RENDER_OPTIONS. Supported only for text-only generation without reference_image_urls.
string
Image template ID from NGRAM_GET_RENDER_OPTIONS. Supported only for text-only generation without reference_image_urls.
string
Image aspect ratio from NGRAM_GET_RENDER_OPTIONS.
string
required
Stable unique key for this intended image job. Reuse it when retrying the same request to reduce duplicate jobs or charges.
boolean
required
Must be true to explicitly confirm that this call may consume Ngram credits. It is validated locally and is never sent to Ngram.
array
One to four public HTTPS source-image URLs to transform. Omit this field to generate an image from text only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NGRAM_GENERATE_VIDEOStart an asynchronous Ngram video render from text or a public URL, with explicit confirmation of potential credit spend and an idempotency key. API-key video creation requires a Basic or higher paid plan and enough credits.

Input Parameters

string
Source text or instructions. Required and non-blank when source_type is text; optional creative direction when source_type is url.
integer
Requested duration in seconds from NGRAM_GET_RENDER_OPTIONS.
string
Scenario name from NGRAM_GET_RENDER_OPTIONS.
string
Video style ID from NGRAM_GET_RENDER_OPTIONS.
string
Voice ID from NGRAM_GET_RENDER_OPTIONS.
array
Optional public HTTP(S) image URLs to use as visual source material.
string
Optional narrative-flow guidance, up to 1024 characters.
string ("text" | "url")
required
Whether to create the video from supplied text or instructions, or from research of a public webpage URL. Choose text when supplying prompt, or url when supplying website_url.
string
Public HTTP(S) webpage, article, product, or documentation URL. Required when source_type is url and not allowed for text mode.
string
Supported video aspect ratio from NGRAM_GET_RENDER_OPTIONS.
string
Optional energy or pacing direction for the generated video.
string
Video format from NGRAM_GET_RENDER_OPTIONS.
boolean
Whether Ngram should perform deeper source research before rendering. Omit to use the provider default.
string
Animation mode from NGRAM_GET_RENDER_OPTIONS.
string
required
Stable unique key for this intended render. Reuse it for retries of the same render to prevent duplicate jobs or credit charges.
string
Video type profile name from NGRAM_GET_RENDER_OPTIONS.
boolean
required
Must be true to explicitly confirm that this call may consume Ngram credits. It is validated locally and is never sent to Ngram.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NGRAM_GET_ACCOUNTReturn the authenticated Ngram account identity, including its id, email, and name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NGRAM_GET_CREDITSReturn the connected account’s plan and available, reserved, and effective credits. Use effective credits as the spendable balance before generation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NGRAM_GET_IMAGEReturn an image job’s current status and generated output by its UUID.

Input Parameters

string
required
UUID of the Ngram image job returned by image generation or listing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NGRAM_GET_RENDER_OPTIONSReturn Ngram’s live catalog of supported video and image capabilities, voices, styles, formats, durations, models, templates, and other generation options. Use this before generation instead of assuming catalog values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NGRAM_GET_VIDEOReturn a video’s render status, progress, output URL, or failure information by video ID.

Input Parameters

string
required
Ngram video ID beginning with vid_, returned by video creation or listing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NGRAM_LIST_BRAND_KITSReturn the brand kits available to the connected account for use in generation requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NGRAM_LIST_IMAGESReturn up to 100 account image jobs matching an optional status and created-at upper bound. Ngram does not expose a continuation token.

Input Parameters

integer
Maximum image jobs to return, from 1 to 100.
string
Only return image jobs before this ISO-8601 temporal boundary; inclusivity is not verified.
string ("processing" | "completed" | "failed")
Only return image jobs in this generation state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NGRAM_LIST_VIDEOSReturn up to 100 account videos matching an optional render status and created-at lower bound. This is one bounded response; Ngram provides no continuation token.

Input Parameters

integer
Maximum videos to return, from 1 to 100.
string
Only return videos at or after this ISO 8601 temporal boundary. The provider’s exact boundary inclusivity is not documented.
string ("processing" | "completed" | "failed")
Only return videos in this render state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: NGRAM_LIST_WEBHOOK_SUBSCRIPTIONSReturn the account’s video completion and failure webhook subscriptions. Signing secrets are not returned by this list endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not