Imgix APIsGenerations APIOverview

Generations API

The Generations API is a set of RESTful endpoints under /v1/generations/ for AI-powered operations on your images, such as generating video from a still image or generating alt text for accessibility.

These operations are exposed as REST endpoints — rather than rendering URL parameters — so they can handle long-running work and large prompt inputs that don’t fit comfortably in a URL.

Operations

OperationEndpointMethodStyle
Video Generation/v1/generations/videoPOSTAsynchronous
Alt Text Generation/v1/generations/alt-textGETSynchronous

Synchronous vs. asynchronous

  • Synchronous operations (such as Alt Text Generation) return their result directly in the response.
  • Asynchronous operations (such as Video Generation) return a job, which you poll until it is ready or errored.

Authentication

All calls to the Generations API require an API key with any permission (billing, asset manager read, etc). To create a key, navigate to the API Keys view in your Dashboard.

Source capabilities and credits

Generation operations require the matching AI capability to be enabled on your Source, and most are metered against your account’s AI credits. See each operation’s page for the specific capability and error responses.