> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Ngram

> Ngram creates AI-generated videos and images, manages rendering jobs, and delivers completion events through webhooks.

![Ngram logo](https://mintcdn.com/composio-preview/9YPuzjEU4UlMnwGq/images/toolkits/ngram.svg?fit=max\&auto=format\&n=9YPuzjEU4UlMnwGq\&q=85\&s=be238892ef0bd64831b4ec74334eb5df)

* **Category:** ai content generation
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 14
* **Triggers:** 0
* **Slug:** `NGRAM`
* **Version:** 20261101\_00

## Tools

> [accordion] Cancel Video
>
> **Slug:** `NGRAM_CANCEL_VIDEO`
>
> Irreversibly 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
>
> **video\_id** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Webhook Subscription
>
> **Slug:** `NGRAM_CREATE_WEBHOOK_SUBSCRIPTION`
>
> Subscribe 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
>
> **event\_type** `string ("video.completed" | "video.failed")` *required*
>
> Account-wide Ngram video event to deliver.
>
> **target\_url** `string` *required*
>
> Public HTTPS callback URL that will receive matching account-wide events.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Webhook Subscription
>
> **Slug:** `NGRAM_DELETE_WEBHOOK_SUBSCRIPTION`
>
> Delete an Ngram webhook subscription by ID. The operation is idempotent: a missing subscription returns deleted=false rather than an error.
>
> #### Input Parameters
>
> **subscription\_id** `string` *required*
>
> Ngram webhook subscription ID beginning with sub\_, returned by webhook subscription creation or listing.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Image
>
> **Slug:** `NGRAM_GENERATE_IMAGE`
>
> Spend 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
>
> **prompt** `string` *required*
>
> Description of the image to generate or the changes to make to reference images, from 1 to 6000 characters.
>
> **model\_id** `string`
>
> Image model ID from NGRAM\_GET\_RENDER\_OPTIONS.
>
> **style\_id** `string`
>
> Image style ID from NGRAM\_GET\_RENDER\_OPTIONS. Supported only for text-only generation without reference\_image\_urls.
>
> **template\_id** `string`
>
> Image template ID from NGRAM\_GET\_RENDER\_OPTIONS. Supported only for text-only generation without reference\_image\_urls.
>
> **aspect\_ratio** `string`
>
> Image aspect ratio from NGRAM\_GET\_RENDER\_OPTIONS.
>
> **idempotency\_key** `string` *required*
>
> Stable unique key for this intended image job. Reuse it when retrying the same request to reduce duplicate jobs or charges.
>
> **confirm\_credit\_spend** `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.
>
> **reference\_image\_urls** `array`
>
> One to four public HTTPS source-image URLs to transform. Omit this field to generate an image from text only.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Video
>
> **Slug:** `NGRAM_GENERATE_VIDEO`
>
> Start 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
>
> **prompt** `string`
>
> Source text or instructions. Required and non-blank when source\_type is text; optional creative direction when source\_type is url.
>
> **duration** `integer`
>
> Requested duration in seconds from NGRAM\_GET\_RENDER\_OPTIONS.
>
> **scenario** `string`
>
> Scenario name from NGRAM\_GET\_RENDER\_OPTIONS.
>
> **style\_id** `string`
>
> Video style ID from NGRAM\_GET\_RENDER\_OPTIONS.
>
> **voice\_id** `string`
>
> Voice ID from NGRAM\_GET\_RENDER\_OPTIONS.
>
> **image\_urls** `array`
>
> Optional public HTTP(S) image URLs to use as visual source material.
>
> **story\_flow** `string`
>
> Optional narrative-flow guidance, up to 1024 characters.
>
> **source\_type** `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.
>
> **website\_url** `string`
>
> Public HTTP(S) webpage, article, product, or documentation URL. Required when source\_type is url and not allowed for text mode.
>
> **aspect\_ratio** `string`
>
> Supported video aspect ratio from NGRAM\_GET\_RENDER\_OPTIONS.
>
> **energy\_level** `string`
>
> Optional energy or pacing direction for the generated video.
>
> **video\_format** `string`
>
> Video format from NGRAM\_GET\_RENDER\_OPTIONS.
>
> **deep\_research** `boolean`
>
> Whether Ngram should perform deeper source research before rendering. Omit to use the provider default.
>
> **animation\_mode** `string`
>
> Animation mode from NGRAM\_GET\_RENDER\_OPTIONS.
>
> **idempotency\_key** `string` *required*
>
> Stable unique key for this intended render. Reuse it for retries of the same render to prevent duplicate jobs or credit charges.
>
> **video\_type\_profile** `string`
>
> Video type profile name from NGRAM\_GET\_RENDER\_OPTIONS.
>
> **confirm\_credit\_spend** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account
>
> **Slug:** `NGRAM_GET_ACCOUNT`
>
> Return the authenticated Ngram account identity, including its id, email, and name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Credits
>
> **Slug:** `NGRAM_GET_CREDITS`
>
> Return the connected account's plan and available, reserved, and effective credits. Use effective credits as the spendable balance before generation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Image
>
> **Slug:** `NGRAM_GET_IMAGE`
>
> Return an image job's current status and generated output by its UUID.
>
> #### Input Parameters
>
> **image\_id** `string` *required*
>
> UUID of the Ngram image job returned by image generation or listing.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Render Options
>
> **Slug:** `NGRAM_GET_RENDER_OPTIONS`
>
> Return 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Video
>
> **Slug:** `NGRAM_GET_VIDEO`
>
> Return a video's render status, progress, output URL, or failure information by video ID.
>
> #### Input Parameters
>
> **video\_id** `string` *required*
>
> Ngram video ID beginning with vid\_, returned by video creation or listing.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Brand Kits
>
> **Slug:** `NGRAM_LIST_BRAND_KITS`
>
> Return the brand kits available to the connected account for use in generation requests.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Images
>
> **Slug:** `NGRAM_LIST_IMAGES`
>
> Return up to 100 account image jobs matching an optional status and created-at upper bound. Ngram does not expose a continuation token.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum image jobs to return, from 1 to 100.
>
> **before** `string`
>
> Only return image jobs before this ISO-8601 temporal boundary; inclusivity is not verified.
>
> **status** `string ("processing" | "completed" | "failed")`
>
> Only return image jobs in this generation state.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Videos
>
> **Slug:** `NGRAM_LIST_VIDEOS`
>
> Return 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
>
> **limit** `integer`
>
> Maximum videos to return, from 1 to 100.
>
> **since** `string`
>
> Only return videos at or after this ISO 8601 temporal boundary. The provider's exact boundary inclusivity is not documented.
>
> **status** `string ("processing" | "completed" | "failed")`
>
> Only return videos in this render state.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Webhook Subscriptions
>
> **Slug:** `NGRAM_LIST_WEBHOOK_SUBSCRIPTIONS`
>
> Return the account's video completion and failure webhook subscriptions. Signing secrets are not returned by this list endpoint.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
