Skip to main content
POST
Search 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
query
string
required

Natural language or keyword search query to find matching content in the world.

Minimum string length: 1
limit
integer
default:20

Maximum number of results to return (1–100). Defaults to 20. The response is capped at this value after ranking; the engine's internal candidate pool is at least this large.

Required range: 1 <= x <= 100
minScore
number

Override the world's minimum relevance score on the normalized 0–1 scale (1.0 = best). Results below this threshold are omitted after ranking.

Required range: 0 <= x <= 1
filter
object

Include/exclude quad filters applied before ranking (SDK QuadFilter semantics).

Response

Search results

results
object[]
required

Ranked search results, best first.

mode
enum<string>
required

Search mode that actually ran: keyword (full-text), semantic (vector), hybrid (both), or fallback (LIKE) when the primary engine is unavailable.

Available options:
semantic,
keyword,
hybrid,
fallback