WorldGenerationResult

Defined in: packages/ai/src/types.ts:2263

Experimental

Result of world generation. JSON-serializable so a server route can return it to a browser. The browser uses token + model to open the live session (set the prompt, start streaming, steer mid-run).

World generation is an experimental feature and may change.

Properties#

expiresAt#

expiresAt: number;

Defined in: packages/ai/src/types.ts:2271

Experimental

Token expiry as milliseconds since epoch

id#

id: string;

Defined in: packages/ai/src/types.ts:2265

Experimental

Unique identifier for this generation

model#

model: string;

Defined in: packages/ai/src/types.ts:2267

Experimental

Model used for generation (provider connect slug)

prompt#

prompt: string;

Defined in: packages/ai/src/types.ts:2273

Experimental

Prompt the client should send when it starts the session

sessionId?#

optional sessionId?: string;

Defined in: packages/ai/src/types.ts:2277

Experimental

Provider session id, when the adapter created one

status#

status: "ready" | "waiting";

Defined in: packages/ai/src/types.ts:2275

Experimental

Session status after the server half finishes

token#

token: string;

Defined in: packages/ai/src/types.ts:2269

Experimental

Short-lived session token for the client connection

usage?#

optional usage?: TokenUsage<ProviderUsageDetails>;

Defined in: packages/ai/src/types.ts:2279

Experimental

Token usage / billing, when the adapter can report it