Generation

Generate an image

Generate a still with optional referenceUrls (up to 5 images: your uploads or public HTTPS images). provider accepts grok, openai or auto (default). Google models are not offered through the API: provider vertex is refused with a 400. quoteOnly:true returns the initial and maximum credits without spending. Retain provider:auto with the quoted maxCredits to allow safe quota fallback; explicit providers never switch. OpenAI GPT Image 2.5 Flare costs 128 at 1k or 256 at 2k plus 8 per reference. Only the successful asset is charged. Studio.

post/ai/images

Request

  • Base URL: https://api.vidmoat.com/v1
  • URL: https://api.vidmoat.com/v1/ai/images
  • Auth: HTTP bearer

Request body

promptstring required

Up to 800 characters.

provider'auto' | 'grok' | 'openai'

Who generates it. Auto picks the lowest compatible quote between Grok and OpenAI.

resolution'1k' | '2k'

Affects OpenAI prices.

aspectRatiostring

For example 16:9, 9:16, 1:1, 4:5, 21:9.

referenceUrlsstring[]

Up to 5 reference images: your upload URLs (png, jpg, webp, avif) or public HTTPS URLs.

maxCreditsnumber

Never spend more than this.

quoteOnlyboolean

true returns the route and price without generating or charging.

Response

Generate an image

urlstring

The image. Use as a clip src.

routeobject

The provider route chosen: provider, model, credits, maxCredits, reason and policy (and voiceId for speech).

creditsobject

{ charged, remaining }: what this call cost and the balance after it.

hintstring

What to do with it.

Changes

No recorded changes to this operation across all 1 revision of this API.