Interface: GenerateVideoOptions

Defined in: packages/agentos/src/api/generateVideo.ts:203

Options for a generateVideo call.

At minimum, a prompt is required. The provider is resolved from opts.provider, opts.apiKey, or the first video-capable env var found (RUNWAY_API_KEY -> REPLICATE_API_TOKEN -> FAL_API_KEY).

Properties

apiKey?

optional apiKey: string

Defined in: packages/agentos/src/api/generateVideo.ts:255

Override the provider API key instead of reading from env vars.

---

aspectRatio?

optional aspectRatio: VideoAspectRatio

Defined in: packages/agentos/src/api/generateVideo.ts:231

Desired aspect ratio (e.g. "16:9", "9:16").

---

baseUrl?

optional baseUrl: string

Defined in: packages/agentos/src/api/generateVideo.ts:258

Override the provider base URL.

---

durationSec?

optional durationSec: number

Defined in: packages/agentos/src/api/generateVideo.ts:228

Desired output duration in seconds.

---

image?

optional image: Buffer

Defined in: packages/agentos/src/api/generateVideo.ts:212

Source image for image-to-video generation. When provided, the request is dispatched to imageToVideo() instead of generateVideo(). Accepts a raw Buffer.

---

model?

optional model: string

Defined in: packages/agentos/src/api/generateVideo.ts:225

Model identifier within the provider (e.g. "gen3a_turbo", "klingai/kling-v1"). When omitted, the provider's default model is used.

---

negativePrompt?

optional negativePrompt: string

Defined in: packages/agentos/src/api/generateVideo.ts:237

Negative prompt describing content to avoid.

---

onProgress()?

optional onProgress: (event) => void

Defined in: packages/agentos/src/api/generateVideo.ts:252

Optional progress callback invoked during long-running generation. Called with a VideoProgressEvent at each status transition.

Parameters

event

VideoProgressEvent

Returns

void

---

prompt

prompt: string

Defined in: packages/agentos/src/api/generateVideo.ts:205

Text prompt describing the desired video content.

---

provider?

optional provider: string

Defined in: packages/agentos/src/api/generateVideo.ts:218

Explicit provider identifier (e.g. "runway", "replicate", "fal"). When omitted, auto-detection from environment variables is used.

---

providerPreferences?

optional providerPreferences: MediaProviderPreference

Defined in: packages/agentos/src/api/generateVideo.ts:265

Provider preferences for reordering or filtering the fallback chain. When supplied, the available video providers are reordered according to preferred and filtered by blocked before building the chain.

---

resolution?

optional resolution: string

Defined in: packages/agentos/src/api/generateVideo.ts:234

Desired output resolution (e.g. "1280x720", "720p").

---

seed?

optional seed: number

Defined in: packages/agentos/src/api/generateVideo.ts:240

Random seed for reproducible generation (provider-dependent).

---

timeoutMs?

optional timeoutMs: number

Defined in: packages/agentos/src/api/generateVideo.ts:246

Maximum time in milliseconds to wait for generation to complete. Provider-dependent — not all providers honour client-side timeouts.

---

usageLedger?

optional usageLedger: AgentOSUsageLedgerOptions

Defined in: packages/agentos/src/api/generateVideo.ts:268

Optional durable usage ledger configuration for accounting.