Skip to main content
PATCH
Update world

Authorizations

Authorization
string
header
required

Worlds API data-plane token.

Path Parameters

id
string
required

The canonical world_uid, e.g. w_.

Body

application/json
displayName
string

New display name for the world.

Minimum string length: 1
embeddingModel
string

New embedding model. Changing this triggers a reindex of existing data.

chunkSize
integer

New chunk size for vector search indexing.

Required range: x > 0
topK
integer

New default top-K for search queries.

Required range: x > 0
minScore
number

New default minimum score threshold for search results.

Required range: 0 <= x <= 1

Response

Updated World

name
string
required

Resource name in the form worlds/, e.g. worlds/w_a1b2c3d4.

uid
string
required

Unique world identifier, e.g. w_.

displayName
string
required

User-facing display name for the world. Set on creation or update.

state
string
required

Lifecycle state: active, deleted, or suspended. Deleted worlds enter a 30-day grace period before permanent purge.

storage
enum<string>
required

Storage backend for the world. All worlds share a single Cloudflare D1 database, separated by world_uid.

Available options:
d1
embeddingModel
string
required

Embedding model identifier used for vector search indexing, e.g. openai/text-embedding-3-small.

chunkSize
integer
required

Maximum number of RDF quads per chunk when indexing for vector search.

topK
integer
required

Default number of top search results to return when the caller does not override.

minScore
number
required

Default minimum relevance score (0–1) for search results. Results below this threshold are omitted.

createTime
string
required

ISO 8601 timestamp when the world was created.

updateTime
string
required

ISO 8601 timestamp when the world was last updated.

deleteTime
string

ISO 8601 timestamp when the world was soft-deleted. Null if not deleted.

expireTime
string

ISO 8601 timestamp when the world will be permanently purged after the grace period. Null if not scheduled for purge.