WorldGenerationResult

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

Experimental

Result of world generation. JSON-serializable so a server route can return it to a browser.

Live adapters (Reactor): status: 'ready' with token and token expiresAt. The browser uses token + model to open the session.

Job adapters (World Labs): status: 'ready' with viewer url and worldId, or status: 'waiting' with operationId and no url. expiresAt on a job is operation expiry, not a session token.

World generation is an experimental feature and may change.

Properties#

assets?#

optional assets?: WorldGenerationAssets;

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

Experimental

Assets when a world job has finished and the provider returned them

expiresAt?#

optional expiresAt?: number;

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

Experimental

Expiry as milliseconds since epoch. Live adapters: session token. Job adapters: operation expiry when the provider sends it.

id#

id: string;

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

Experimental

Unique identifier for this generation

model#

model: string;

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

Experimental

Model used for generation (provider connect slug or model id)

operationId?#

optional operationId?: string;

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

Experimental

Provider operation id for a long-running world job

prompt#

prompt: string;

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

Experimental

Prompt used to generate the world, or the prompt the client should send

sessionId?#

optional sessionId?: string;

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

Experimental

Provider session id, when the adapter created one

status#

status: "ready" | "waiting";

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

Experimental

Status after the server half finishes

token?#

optional token?: string;

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

Experimental

Short-lived session token for a live client connection

url?#

optional url?: string;

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

Experimental

Viewer URL for a finished world job (not an asset download URL)

usage?#

optional usage?: TokenUsage<ProviderUsageDetails>;

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

Experimental

Token usage / billing, when the adapter can report it

worldId?#

optional worldId?: string;

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

Experimental

Provider world id for a finished or in-progress job