render_template
Render Template
Render a previously saved template. Optionally provide merge field replacements to personalize the output. Use this for mass video personalization.
render_template
Render a previously saved template. Optionally provide merge field replacements to personalize the output. Use this for mass video personalization.
get_hosted_asset
Retrieve details of a hosted asset by its asset ID. Returns the CDN URL, status, and metadata. Assets are stored on Shotstack's CDN by default.
transfer_asset
Fetch a file from a public URL and distribute it to one or more hosting destinations. Supports Shotstack CDN, AWS S3, Mux, Google Cloud Storage, Google Drive, and Vimeo.
request_upload_url
Request a signed URL for direct file upload. Upload your file to the returned URL with a PUT request. Optionally specify renditions to apply after upload.
render_video
Submit a video, image, or audio edit for rendering. Define a timeline with tracks, clips, transitions, effects, and filters. Supports output in MP4, GIF, JPG, PNG, BMP, and MP3 formats at various resolutions. Use merge fields to substitute dynamic values into the edit. Configure output destinations including Shotstack CDN, AWS S3, Mux, Google Cloud Storage, Google Drive, and Vimeo.
get_assets_by_render
Look up all hosted assets for a render job (video, poster, thumbnail). Up to 3 assets may be returned per render.
generate_ai_asset
Generate images, videos, speech, or text using built-in or third-party AI providers. **Built-in Shotstack providers:** - **text-to-speech**: Generate speech audio from text with multiple voices and languages. - **text-to-image**: Generate images from text prompts. - **image-to-video**: Convert still images into videos. - **text-generator**: Generate text content powered by GPT-4. **Third-party providers** (require API keys configured in the Shotstack dashboard): - **elevenlabs**: Realistic text-to-speech. - **d-id**: Talking avatar generation from text. - **stability-ai**: Image generation using Stable Diffusion engines. - **heygen**: Avatar video generation.
probe_media
Inspect a media file at a given URL and retrieve its metadata. Returns format, duration, codec, resolution, and other technical details. Useful for validating media before rendering.
get_template
Retrieve a template's full details including the edit configuration. Use this to inspect or duplicate a template.
ingest_source
Fetch and ingest a media file from a URL. Optionally apply transformations (renditions) like format conversion, resizing, and speed changes. The source is stored by Shotstack and can be used directly in edits.
list_sources
List all ingested sources. Returns source IDs, status, and metadata sorted by most recent first.
delete_hosted_asset
Permanently delete a hosted asset from the Shotstack CDN.
get_render
Check the status and details of a render job. Returns the current status, output URL (when complete), poster and thumbnail URLs, and timing information.
create_template
Save a reusable edit configuration as a template. Templates can include merge field placeholders for dynamic content substitution at render time.
update_template
Update an existing template's name and/or edit configuration.
get_generated_asset
Check the status of an AI-generated asset. When complete, returns the output URL for the generated image, video, speech, or text.
delete_source
Permanently delete an ingested source and its stored files.
delete_template
Permanently delete a saved template.
list_templates
Retrieve a list of all saved templates. Returns template IDs, names, and timestamps.
get_source
Retrieve details of an ingested source including status, dimensions, duration, rendition outputs, and transcription results.
Programmatically edit and generate videos, images, and audio using a JSON-based timeline model. Arrange clips with transitions, effects, filters, and overlays. Create reusable templates with merge fields for mass video personalization. Ingest and transform source assets (resize, convert formats, adjust frame rates). Host and distribute rendered assets via CDN or to AWS S3, Google Cloud Storage, Google Drive, Mux, and Vimeo. Generate AI-powered assets including text-to-image, text-to-speech, image-to-video, text generation, talking avatars (D-ID), realistic voice synthesis (ElevenLabs), and Stable Diffusion image generation. Inspect media file metadata such as format, duration, and codecs. Receive webhook callbacks for render, hosting, and ingestion completion events.
Common questions about connecting Shotstack to AI agents with Metorial.