Classic API
The original API remains available and unchanged at /api/worldapi/. It is supported for existing clients and many older tools, guides and SDK releases use it. New work should use the current API (API Reference). The two dialects serve the same data and differ most in how link fields are named.
Base URL: https://www.onlyworlds.com/api/worldapi/
Authentication: the same API-Key and API-Pin headers. Legacy 10-digit keys and prefixed keys both work. See Keys and PINs.
Operations
Section titled “Operations”Routes use the singular category slug (/character/, /location/).
| Method | Route | Purpose |
|---|---|---|
| GET | /{type}/ |
List elements: a bare JSON array, with no envelope and no pagination |
| POST | /{type}/ |
Create |
| GET | /{type}/{uuid}/ |
Get one element |
| PATCH | /{type}/{uuid}/ |
Partial update |
| PUT | /{type}/{uuid}/ |
Full replace |
| DELETE | /{type}/{uuid}/ |
Delete |
The trailing slash is required on single-element routes. GET /character/{uuid} without it answers a 301 redirect with an empty body. curl does not follow it without -L; Python’s requests follows it for GET by default. GET /character/{uuid}/ answers 200 directly.
curl -s "https://www.onlyworlds.com/api/worldapi/character/{uuid}/" \ -H "API-Key: {key}" -H "API-Pin: {pin}"Link Fields
Section titled “Link Fields”Multi-link fields use different names for reading and writing:
| Direction | Field name | Shape |
|---|---|---|
| GET (read) | characters |
The linked elements, as stub objects {id, name, …} |
| POST, PATCH (write) | characters_ids |
A list of UUIDs |
Single-link fields take the _id suffix on write (for example location_id). The current API has no such asymmetry: see Link Fields.
Errors
Section titled “Errors”The Classic API answers errors in its own envelope, not the one on the error reference:
- Most errors:
{"detail": "…"}(a string) or{"detail": [ … ]}(a list of field validation errors). - Authentication failures add a nested object:
{ "detail": "Unauthorized", "error": { "code": "unauthorized", "detail": "Authentication required." } }Unknown fields, including world in a body, are a 422 naming the field, in the {"detail": [ … ]} shape.