GENEFIS MEDIA's NOEMA

Документация World API

World API v1

HTTP JSON API для интеграций с данными конкретного мира. Базовый URL: https://noema.quest/api/v1. В справочнике ниже — 123 маршрутов (источник правды в коде: WorldApiRouteCatalog).

Аутентификация

Токен мира выдаётся при создании мира или перегенерируется в настройках дашборда (шестерёнка → API-токен). Передавайте его только по HTTPS:

Authorization: Bearer nwm_…
  • Токен привязан к одному миру; все пути работают в его контексте без world_id в URL.
  • Скрытый мир (onoff = false) по API недоступен — ответ 401.
  • Чужие сущности другого мира по id не отдаются — ответ 404, не 403.
  • После перегенерации старый bearer сразу недействителен.

Полная машиночитаемая справка (правила PUT, разметка, схемы тел) — только с валидным токеном: GET https://noema.quest/api/v1/docs.

Редактирование (кратко)

Биографии и бестиарий — частичный PUT; связи биографий — частичный PUT по группам; фракции — PUT с обязательными name и type и риском сброса необязательных полей.

Маршруты по модулям

bestiary (6)

Метод Путь
GET /api/v1/bestiary/creatures
GET /api/v1/bestiary/creatures/{creature}
POST /api/v1/bestiary/creatures
PUT /api/v1/bestiary/creatures/{creature}
DELETE /api/v1/bestiary/creatures/{creature}
GET /api/v1/bestiary/species-kinds

biographies (23)

Метод Путь
GET /api/v1/biographies
GET /api/v1/biographies/{biography}
POST /api/v1/biographies
PUT /api/v1/biographies/{biography}
DELETE /api/v1/biographies/{biography}
GET /api/v1/biographies/{biography}/relations
PUT /api/v1/biographies/{biography}/relations
POST /api/v1/biographies/{biography}/relatives
DELETE /api/v1/biographies/{biography}/relatives/{relatedBiography}
POST /api/v1/biographies/{biography}/friends
DELETE /api/v1/biographies/{biography}/friends/{relatedBiography}
POST /api/v1/biographies/{biography}/enemies
DELETE /api/v1/biographies/{biography}/enemies/{relatedBiography}
POST /api/v1/biographies/{biography}/timeline/create-line
DELETE /api/v1/biographies/{biography}/timeline/line
POST /api/v1/biographies/{biography}/timeline/push-event
GET /api/v1/biographies/{biography}/events
POST /api/v1/biographies/{biography}/events
PUT /api/v1/biographies/{biography}/events/{biographyEvent}
DELETE /api/v1/biographies/{biography}/events/{biographyEvent}
GET /api/v1/biographies/{biography}/timeline-events
POST /api/v1/biographies/{biography}/timeline-events
DELETE /api/v1/biographies/{biography}/timeline-events/{timelineEvent}

connections (15)

Метод Путь
GET /api/v1/connections
POST /api/v1/connections
GET /api/v1/connections/catalog/timeline-lines
GET /api/v1/connections/catalog/timeline-lines/{line}/events
GET /api/v1/connections/catalog/stories
GET /api/v1/connections/catalog/stories/{story}/cards
GET /api/v1/connections/catalog/creatures
GET /api/v1/connections/catalog/biographies
GET /api/v1/connections/{connectionBoard}
DELETE /api/v1/connections/{connectionBoard}
POST /api/v1/connections/{connectionBoard}/nodes
PUT /api/v1/connections/{connectionBoard}/nodes/{node}
DELETE /api/v1/connections/{connectionBoard}/nodes/{node}
POST /api/v1/connections/{connectionBoard}/edges
DELETE /api/v1/connections/{connectionBoard}/edges/{edge}

encyclopedia (19)

Метод Путь
GET /api/v1/encyclopedia
GET /api/v1/encyclopedia/{encyclopediaEntry}
POST /api/v1/encyclopedia
PUT /api/v1/encyclopedia/{encyclopediaEntry}
DELETE /api/v1/encyclopedia/{encyclopediaEntry}
GET /api/v1/encyclopedia/{encyclopediaEntry}/relations
PUT /api/v1/encyclopedia/{encyclopediaEntry}/relations
GET /api/v1/encyclopedia/{encyclopediaEntry}/map-sprite
PUT /api/v1/encyclopedia/{encyclopediaEntry}/map-sprite
GET /api/v1/encyclopedia/{encyclopediaEntry}/events
POST /api/v1/encyclopedia/{encyclopediaEntry}/events
PUT /api/v1/encyclopedia/{encyclopediaEntry}/events/{encyclopediaEntryEvent}
DELETE /api/v1/encyclopedia/{encyclopediaEntry}/events/{encyclopediaEntryEvent}
POST /api/v1/encyclopedia/{encyclopediaEntry}/timeline/create-line
DELETE /api/v1/encyclopedia/{encyclopediaEntry}/timeline/line
POST /api/v1/encyclopedia/{encyclopediaEntry}/timeline/push-event
GET /api/v1/encyclopedia/{encyclopediaEntry}/timeline-events
POST /api/v1/encyclopedia/{encyclopediaEntry}/timeline-events
DELETE /api/v1/encyclopedia/{encyclopediaEntry}/timeline-events/{timelineEvent}

factions (14)

Метод Путь
GET /api/v1/factions
GET /api/v1/factions/{faction}
POST /api/v1/factions
PUT /api/v1/factions/{faction}
DELETE /api/v1/factions/{faction}
POST /api/v1/factions/{faction}/timeline/create-line
DELETE /api/v1/factions/{faction}/timeline/line
POST /api/v1/factions/{faction}/timeline/push-event
GET /api/v1/factions/{faction}/events
POST /api/v1/factions/{faction}/events
PUT /api/v1/factions/{faction}/events/{factionEvent}
DELETE /api/v1/factions/{faction}/events/{factionEvent}
POST /api/v1/factions/{faction}/members
DELETE /api/v1/factions/{faction}/members/{biography}

maps (17)

Метод Путь
GET /api/v1/maps/sprite-catalog
GET /api/v1/maps
POST /api/v1/maps
PUT /api/v1/maps/{map}/canvas
POST /api/v1/maps/{map}/fill
GET /api/v1/maps/{map}/fill
GET /api/v1/maps/{map}/coordinates
POST /api/v1/maps/{map}/coordinates/resolve
GET /api/v1/maps/{map}
PUT /api/v1/maps/{map}
DELETE /api/v1/maps/{map}
POST /api/v1/maps/{map}/sprites
PUT /api/v1/maps/{map}/sprites/{sprite}
DELETE /api/v1/maps/{map}/sprites/{sprite}
POST /api/v1/maps/{map}/labels
PUT /api/v1/maps/{map}/labels/{label}
DELETE /api/v1/maps/{map}/labels/{label}

markup (2)

Метод Путь
GET /api/v1/markup/entities
POST /api/v1/markup/resolve

meta (1)

Метод Путь
GET /api/v1/docs

notes (5)

Метод Путь
GET /api/v1/notes
POST /api/v1/notes
GET /api/v1/notes/{note}
PUT /api/v1/notes/{note}
DELETE /api/v1/notes/{note}

stories (12)

Метод Путь
GET /api/v1/stories
POST /api/v1/stories
GET /api/v1/stories/{story}
PUT /api/v1/stories/{story}
DELETE /api/v1/stories/{story}
POST /api/v1/stories/{story}/decompose-all
POST /api/v1/stories/{story}/cards/reorder
POST /api/v1/stories/{story}/cards
PUT /api/v1/stories/{story}/cards/{card}
DELETE /api/v1/stories/{story}/cards/{card}
POST /api/v1/stories/{story}/cards/{card}/decompose
POST /api/v1/stories/{story}/cards/{card}/highlight

timeline (9)

Метод Путь
GET /api/v1/timeline/lines
POST /api/v1/timeline/lines
PUT /api/v1/timeline/lines/{line}
DELETE /api/v1/timeline/lines/{line}
POST /api/v1/timeline/lines/{line}/move
POST /api/v1/timeline/clear
POST /api/v1/timeline/events
PUT /api/v1/timeline/events/{timelineEvent}
DELETE /api/v1/timeline/events/{timelineEvent}

Журналы активности, PDF, AI-подсказки и настройки аккаунта в World API не входят. Отдельный контур Witness — /api/v1/witness/* с другим типом токена.