Get character world

GET

/v1/characters/:slug/world

GET

/v1/characters/:slug/world

$ curl https://api.loreos.app/v1/characters/slug/world \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "characterId": "char_9f8b7c6d5e4a3b2c1d0e",
3   "name": "Elysia Starwind",
4   "description": "A skilled elven ranger from the Whispering Woods, protector of ancient secrets.",
5   "world": {
6     "name": "Whispering Woods",
7     "region": "Eldoria",
8     "climate": "Temperate forest",
9     "notableLocations": [
10       {
11         "name": "Silverleaf Glade",
12         "description": "A serene clearing where the moonlight dances on silver leaves."
13       },
14       {
15         "name": "The Ancient Oak",
16         "description": "A massive, centuries-old tree said to be the heart of the forest."
17       }
18     ],
19     "inhabitants": [
20       {
21         "species": "Elf",
22         "population": 1200,
23         "traits": [
24           "agile",
25           "keen senses",
26           "long-lived"
27         ]
28       },
29       {
30         "species": "Forest Sprite",
31         "population": 300,
32         "traits": [
33           "mischievous",
34           "magical",
35           "small"
36         ]
37       }
38     ]
39   },
40   "lastUpdated": "2024-06-10T09:45:00Z"
41 }

Read-only world projection for one app-owned character.

Authentication

AuthorizationBearer

LoreOS API key, sent as Authorization: Bearer <key>.

Path parameters

slugstringRequired

Query parameters

limitintegerOptional1-100Defaults to 25

Response

Successful Response

Errors

422

Unprocessable Entity Error