Skip to main content
The Worlds Data API client (@worlds/client) is a typed HTTP client generated from the canonical Worlds Data API OpenAPI document. It mirrors the management-plane client pattern: @wazoo/client talks to the platform API, @worlds/client talks to the data plane. Use it for remote data-plane operations: world lifecycle, import, export, search, SPARQL, and reindexing against worlds-api.wazoo.dev. For an embeddable, provider-swappable interface over the same operations, use the Worlds SDK instead.

Install

Create a client

Data-plane requests authenticate with a wzw_ world token:

List worlds

The data-plane search endpoint performs hybrid retrieval across a world:
Results return the matching subject and predicate IRIs plus the literal content, so an agent can bind the exact entity before running SPARQL.

Import data

SPARQL

Export and reindex

Self-hosting

Point the client at a self-hosted Worlds Data API instance by overriding baseUrl:

Generated code

The package is generated with @hey-api/openapi-ts from a committed OpenAPI snapshot in the wazootech/worlds-client-ts repository. Run deno task sync:openapi to refresh the snapshot, and deno task generate to regenerate src/generated/. CI fails if the checked-in snapshot drifts from the canonical document.