Skip to content

OnlyWorlds Docs

An open schema for world data, and the API, SDKs and agent interfaces to build on it.

List the Characters in Hyperion, the public example world. Its demo key 0000000000 is read-only and reads without a PIN; Moppetopia’s demo key is listed on Keys and PINs.

Terminal window
curl -H "API-Key: 0000000000" \
"https://www.onlyworlds.com/api/v2/character/?fields=id,name"
{
"data": [
{ "id": "068e92dc-10ec-7225-8000-7efd678bd862", "name": "Mr. Steinway" },
{ "id": "068e92db-4c40-79eb-8000-8ef44c0d52b4", "name": "Rachmaninov" },
{ "id": "068e2ddb-83c6-71a7-8000-a45b8b711e25", "name": "The Consul" }
],
"has_more": false,
"next_cursor": null
}

Swap in a key for your own world and the same call reads it. Getting Started walks through keys and the first write.

Looking for tools to build a world with, rather than to build on? Start at onlyworlds.com/start, or open Atlas.