Interface: GenerateSFXOptions

Defined in: packages/agentos/src/api/generateSFX.ts:208

Options for a generateSFX call.

At minimum, a prompt is required. The provider is resolved from opts.provider, opts.apiKey, or the first SFX-capable env var found (ELEVENLABS_API_KEY -> STABILITY_API_KEY -> REPLICATE_API_TOKEN -> FAL_API_KEY -> local AudioGen).

Properties

apiKey?

optional apiKey: string

Defined in: packages/agentos/src/api/generateSFX.ts:250

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

---

durationSec?

optional durationSec: number

Defined in: packages/agentos/src/api/generateSFX.ts:226

Desired output duration in seconds. SFX clips are typically 1-15s.

---

model?

optional model: string

Defined in: packages/agentos/src/api/generateSFX.ts:223

Model identifier within the provider. When omitted, the provider's default model is used.

---

n?

optional n: number

Defined in: packages/agentos/src/api/generateSFX.ts:241

Number of audio clips to generate. Defaults to 1.

---

onProgress()?

optional onProgress: (event) => void

Defined in: packages/agentos/src/api/generateSFX.ts:247

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

Parameters

event

AudioProgressEvent

Returns

void

---

outputFormat?

optional outputFormat: AudioOutputFormat

Defined in: packages/agentos/src/api/generateSFX.ts:229

Output audio format (e.g. "mp3", "wav"). Defaults to provider default.

---

prompt

prompt: string

Defined in: packages/agentos/src/api/generateSFX.ts:210

Text prompt describing the desired sound effect.

---

provider?

optional provider: string

Defined in: packages/agentos/src/api/generateSFX.ts:217

Explicit provider identifier (e.g. "elevenlabs-sfx", "stable-audio", "audiogen-local"). When omitted, auto-detection from environment variables is used.

---

providerOptions?

optional providerOptions: Record<string, unknown>

Defined in: packages/agentos/src/api/generateSFX.ts:256

Arbitrary provider-specific options.

---

providerPreferences?

optional providerPreferences: MediaProviderPreference

Defined in: packages/agentos/src/api/generateSFX.ts:263

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

---

seed?

optional seed: number

Defined in: packages/agentos/src/api/generateSFX.ts:232

Random seed for reproducible generation (provider-dependent).

---

timeoutMs?

optional timeoutMs: number

Defined in: packages/agentos/src/api/generateSFX.ts:238

Maximum time in milliseconds to wait for generation to complete. Provider-dependent — polling providers enforce this directly.

---

usageLedger?

optional usageLedger: AgentOSUsageLedgerOptions

Defined in: packages/agentos/src/api/generateSFX.ts:266

Optional durable usage ledger configuration for accounting.

---

userId?

optional userId: string

Defined in: packages/agentos/src/api/generateSFX.ts:253

Optional user identifier forwarded to the provider for billing.