Narrative

GET/api/v1/narrative/universes

List_universes

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Query Parameters

q?string

Full-text search query

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Items per page

Formatint64

Range0 <= value

sort_by?string

Sort field (e.g. "created_at", "name")

sort_order?string

Sort direction

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/narrative/universes"

{  "items": [    {      "actor_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "event_id": "string",      "event_key": "string",      "metadata": {        "property1": null,        "property2": null      },      "session_id": "string",      "story_id": "string",      "universe_id": "string",      "value_json": null    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

POST/api/v1/narrative/universes

Create_universe

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?string|null

metadata?

name*string

settings?null|

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/narrative/universes" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "metadata": {    "property1": null,    "property2": null  },  "name": "string",  "settings": {    "allow_session_creation": true,    "allow_story_creation": true,    "max_concurrent_sessions": 0,    "max_stories": 0  },  "stats": null,  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

GET/api/v1/narrative/universes/{universe_id}

Get_universe

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/narrative/universes/string"

{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "metadata": {    "property1": null,    "property2": null  },  "name": "string",  "settings": {    "allow_session_creation": true,    "allow_story_creation": true,    "max_concurrent_sessions": 0,    "max_stories": 0  },  "stats": null,  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

PATCH/api/v1/narrative/universes/{universe_id}

Update_universe

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?|

Defaultnull

metadata?|

Defaultnull

name?|

Defaultnull

settings?|

Defaultnull

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/narrative/universes/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "metadata": {    "property1": null,    "property2": null  },  "name": "string",  "settings": {    "allow_session_creation": true,    "allow_story_creation": true,    "max_concurrent_sessions": 0,    "max_stories": 0  },  "stats": null,  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

DELETE/api/v1/narrative/universes/{universe_id}

Delete_universe

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Response Body

curl -X DELETE "https://example.com/api/v1/narrative/universes/string"

Empty

GET/api/v1/narrative/universes/{universe_id}/actor-templates

List_actor_templates

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Query Parameters

actor_type?string

Value in

"character"
"item"
"location"

publish_state?string

Value in

"draft"
"published"
"archived"

tags?string

Comma-separated tag filter

q?string

Full-text search query

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Items per page

Formatint64

Range0 <= value

sort_by?string

Sort field (e.g. "created_at", "name")

sort_order?string

Sort direction

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/narrative/universes/string/actor-templates"

{  "items": [    {      "actor_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "event_id": "string",      "event_key": "string",      "metadata": {        "property1": null,        "property2": null      },      "session_id": "string",      "story_id": "string",      "universe_id": "string",      "value_json": null    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

POST/api/v1/narrative/universes/{universe_id}/actor-templates

Create_actor_template

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

actor_type*ActorType

Value in

"character"
"item"
"location"

color?string|null

default_attribute_ids?array<string>

default_properties?null|

description?string|null

image_name?string|null

metadata?

name*string

tags?array<string>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/narrative/universes/string/actor-templates" \  -H "Content-Type: application/json" \  -d '{    "actor_type": "character",    "name": "string"  }'

{  "actor_type": "character",  "color": "string",  "created_at": "2019-08-24T14:15:22Z",  "default_attribute_ids": [    "string"  ],  "default_properties": {    "avatar_image_name": "string",    "description": "string",    "display_name": "string",    "image_name": "string"  },  "description": "string",  "image_name": "string",  "metadata": {    "property1": null,    "property2": null  },  "name": "string",  "publish_state": "draft",  "tags": [    "string"  ],  "template_id": "string",  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}

GET/api/v1/narrative/universes/{universe_id}/actor-templates/{template_id}

Get_actor_template

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

template_id*string

Template ID

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/narrative/universes/string/actor-templates/string"

{  "actor_type": "character",  "color": "string",  "created_at": "2019-08-24T14:15:22Z",  "default_attribute_ids": [    "string"  ],  "default_properties": {    "avatar_image_name": "string",    "description": "string",    "display_name": "string",    "image_name": "string"  },  "description": "string",  "image_name": "string",  "metadata": {    "property1": null,    "property2": null  },  "name": "string",  "publish_state": "draft",  "tags": [    "string"  ],  "template_id": "string",  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}

PATCH/api/v1/narrative/universes/{universe_id}/actor-templates/{template_id}

Update_actor_template

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

template_id*string

Template ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

color?|

Defaultnull

default_attribute_ids?array<string>|

Defaultnull

default_properties?|

Defaultnull

description?|

Defaultnull

image_name?|

Defaultnull

metadata?|

Defaultnull

name?|

Defaultnull

publish_state?|

Defaultnull

tags?array<string>|

Defaultnull

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/narrative/universes/string/actor-templates/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "actor_type": "character",  "color": "string",  "created_at": "2019-08-24T14:15:22Z",  "default_attribute_ids": [    "string"  ],  "default_properties": {    "avatar_image_name": "string",    "description": "string",    "display_name": "string",    "image_name": "string"  },  "description": "string",  "image_name": "string",  "metadata": {    "property1": null,    "property2": null  },  "name": "string",  "publish_state": "draft",  "tags": [    "string"  ],  "template_id": "string",  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}

DELETE/api/v1/narrative/universes/{universe_id}/actor-templates/{template_id}

Delete_actor_template

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

template_id*string

Template ID

Response Body

curl -X DELETE "https://example.com/api/v1/narrative/universes/string/actor-templates/string"

Empty

GET/api/v1/narrative/universes/{universe_id}/actors

List_actors

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Query Parameters

actor_type?string

Value in

"character"
"item"
"location"

scope?string

Value in

"universe"
"story"
"session"

story_id?string

Filter by story ID (returns story-scoped actors for this story)

session_id?string

Filter by session ID (returns session-scoped actors for this session)

tags?string

q?string

Full-text search query

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Items per page

Formatint64

Range0 <= value

sort_by?string

Sort field (e.g. "created_at", "name")

sort_order?string

Sort direction

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/narrative/universes/string/actors"

{  "items": [    {      "actor_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "event_id": "string",      "event_key": "string",      "metadata": {        "property1": null,        "property2": null      },      "session_id": "string",      "story_id": "string",      "universe_id": "string",      "value_json": null    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

POST/api/v1/narrative/universes/{universe_id}/actors

Create_actor

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Unified actor creation request. Handles:

Direct creation (no source_actor_id)
Import from another actor (source_actor_id set)
Template instantiation (template_id set)

actor_type?null|

attributes?array<>

metadata?

name?|

Actor name (required for new actors, optional for import/instance)

properties?null|

publish_state?PublishState

Value in

"draft"
"published"
"archived"

scope?ActorScope

Target scope for the actor (Universe, Story, or Session)

Value in

"universe"
"story"
"session"

session_id?|

Session ID (required if scope is Session)

source_actor_id?|

Source actor ID to import/instance from (if set, copies from this actor)

story_id?|

Story ID (required if scope is Story)

tags?array<string>

template_id?|

Template ID to instantiate from (creates actor with template snapshot)

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/narrative/universes/string/actors" \  -H "Content-Type: application/json" \  -d '{}'

{  "actor_id": "string",  "actor_type": "character",  "attributes": [    {      "attribute_id": "string",      "name": "string",      "override_properties": null,      "template_id": "string",      "updated_at": "2019-08-24T14:15:22Z",      "value": {        "type": "number",        "value": 0.1      },      "version": 0    }  ],  "control_id": "string",  "created_at": "2019-08-24T14:15:22Z",  "last_modified_by": "string",  "metadata": {    "property1": null,    "property2": null  },  "name": "string",  "player_controlled": true,  "properties": {    "avatar_image_name": "string",    "description": "string",    "display_name": "string",    "image_name": "string"  },  "publish_state": "draft",  "scope": "universe",  "session_id": "string",  "source_actor_id": "string",  "source_version": 0,  "story_id": "string",  "tags": [    "string"  ],  "template_id": "string",  "template_snapshot": null,  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}

POST/api/v1/narrative/universes/{universe_id}/actors/query

Query_actors

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

actor_type?null|

filters?array<>

include_instances?boolean

page?|

Formatint64

Range0 <= value

page_size?|

Formatint64

Range0 <= value

scope?null|

session_id?string|null

story_id?string|null

tags?array<string>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/narrative/universes/string/actors/query" \  -H "Content-Type: application/json" \  -d '{}'

{  "items": [    {      "actor_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "event_id": "string",      "event_key": "string",      "metadata": {        "property1": null,        "property2": null      },      "session_id": "string",      "story_id": "string",      "universe_id": "string",      "value_json": null    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

GET/api/v1/narrative/universes/{universe_id}/actors/{actor_id}

Get_actor

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

actor_id*string

Actor ID

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/narrative/universes/string/actors/string"

{  "actor_id": "string",  "actor_type": "character",  "attributes": [    {      "attribute_id": "string",      "name": "string",      "override_properties": null,      "template_id": "string",      "updated_at": "2019-08-24T14:15:22Z",      "value": {        "type": "number",        "value": 0.1      },      "version": 0    }  ],  "control_id": "string",  "created_at": "2019-08-24T14:15:22Z",  "last_modified_by": "string",  "metadata": {    "property1": null,    "property2": null  },  "name": "string",  "player_controlled": true,  "properties": {    "avatar_image_name": "string",    "description": "string",    "display_name": "string",    "image_name": "string"  },  "publish_state": "draft",  "scope": "universe",  "session_id": "string",  "source_actor_id": "string",  "source_version": 0,  "story_id": "string",  "tags": [    "string"  ],  "template_id": "string",  "template_snapshot": null,  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}

PATCH/api/v1/narrative/universes/{universe_id}/actors/{actor_id}

Update_actor

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

actor_id*string

Actor ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

metadata?|

Defaultnull

name?|

Defaultnull

properties?|

Defaultnull

publish_state?|

Defaultnull

tags?array<string>|

Defaultnull

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/narrative/universes/string/actors/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "actor_id": "string",  "actor_type": "character",  "attributes": [    {      "attribute_id": "string",      "name": "string",      "override_properties": null,      "template_id": "string",      "updated_at": "2019-08-24T14:15:22Z",      "value": {        "type": "number",        "value": 0.1      },      "version": 0    }  ],  "control_id": "string",  "created_at": "2019-08-24T14:15:22Z",  "last_modified_by": "string",  "metadata": {    "property1": null,    "property2": null  },  "name": "string",  "player_controlled": true,  "properties": {    "avatar_image_name": "string",    "description": "string",    "display_name": "string",    "image_name": "string"  },  "publish_state": "draft",  "scope": "universe",  "session_id": "string",  "source_actor_id": "string",  "source_version": 0,  "story_id": "string",  "tags": [    "string"  ],  "template_id": "string",  "template_snapshot": null,  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}

DELETE/api/v1/narrative/universes/{universe_id}/actors/{actor_id}

Delete_actor

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

actor_id*string

Actor ID

Response Body

curl -X DELETE "https://example.com/api/v1/narrative/universes/string/actors/string"

Empty

PATCH/api/v1/narrative/universes/{universe_id}/actors/{actor_id}/attributes/{attribute_id}

Update_actor_attribute

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

actor_id*string

Actor ID

attribute_id*string

Attribute ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

override_properties?|

Defaultnull

value?|||

Defaultnull

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/narrative/universes/string/actors/string/attributes/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "actor_id": "string",  "actor_type": "character",  "attributes": [    {      "attribute_id": "string",      "name": "string",      "override_properties": null,      "template_id": "string",      "updated_at": "2019-08-24T14:15:22Z",      "value": {        "type": "number",        "value": 0.1      },      "version": 0    }  ],  "control_id": "string",  "created_at": "2019-08-24T14:15:22Z",  "last_modified_by": "string",  "metadata": {    "property1": null,    "property2": null  },  "name": "string",  "player_controlled": true,  "properties": {    "avatar_image_name": "string",    "description": "string",    "display_name": "string",    "image_name": "string"  },  "publish_state": "draft",  "scope": "universe",  "session_id": "string",  "source_actor_id": "string",  "source_version": 0,  "story_id": "string",  "tags": [    "string"  ],  "template_id": "string",  "template_snapshot": null,  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z",  "version": 0}

GET/api/v1/narrative/universes/{universe_id}/actors/{actor_id}/control

Get_control

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

actor_id*string

Actor ID

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/narrative/universes/string/actors/string/control"

{  "actor_id": "string",  "allowed_mutations": {    "property1": true,    "property2": true  },  "control_id": "string",  "control_mode": "exclusive",  "created_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "is_expired": true,  "on_release": {    "action": "discard",    "notify_webhook": "string"  },  "player_id": "string",  "session_id": "string",  "source_scope": "universe",  "universe_id": "string"}

POST/api/v1/narrative/universes/{universe_id}/actors/{actor_id}/control

Grant_control

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

actor_id*string

Actor ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

allowed_mutations?

control_mode?ControlMode

Value in

"exclusive"
"shared"

duration_seconds?|

Formatint32

Range0 <= value

on_release?null|

player_id*string

session_id*string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/narrative/universes/string/actors/string/control" \  -H "Content-Type: application/json" \  -d '{    "player_id": "string",    "session_id": "string"  }'

{  "actor_id": "string",  "allowed_mutations": {    "property1": true,    "property2": true  },  "control_id": "string",  "control_mode": "exclusive",  "created_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "is_expired": true,  "on_release": {    "action": "discard",    "notify_webhook": "string"  },  "player_id": "string",  "session_id": "string",  "source_scope": "universe",  "universe_id": "string"}

DELETE/api/v1/narrative/universes/{universe_id}/actors/{actor_id}/control

Release_control

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

actor_id*string

Actor ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

promote?boolean

promotion_strategy?null|

Response Body

curl -X DELETE "https://example.com/api/v1/narrative/universes/string/actors/string/control" \  -H "Content-Type: application/json" \  -d '{}'

Empty

GET/api/v1/narrative/universes/{universe_id}/actors/{actor_id}/events/{event_key}

Get_event

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

actor_id*string

Actor ID

event_key*string

Event Key

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/narrative/universes/string/actors/string/events/string"

{  "actor_id": "string",  "created_at": "2019-08-24T14:15:22Z",  "event_id": "string",  "event_key": "string",  "metadata": {    "property1": null,    "property2": null  },  "session_id": "string",  "story_id": "string",  "universe_id": "string",  "value_json": null}

PATCH/api/v1/narrative/universes/{universe_id}/actors/{actor_id}/events/{event_key}

Set_event

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

actor_id*string

Actor ID

event_key*string

Event Key (idempotent)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

metadata?|

Defaultnull

session_id?|

Defaultnull

story_id?|

Defaultnull

value_json?unknown

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/narrative/universes/string/actors/string/events/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "actor_id": "string",  "created_at": "2019-08-24T14:15:22Z",  "event_id": "string",  "event_key": "string",  "metadata": {    "property1": null,    "property2": null  },  "session_id": "string",  "story_id": "string",  "universe_id": "string",  "value_json": null}

DELETE/api/v1/narrative/universes/{universe_id}/actors/{actor_id}/events/{event_key}

Delete_event

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

actor_id*string

Actor ID

event_key*string

Event Key

Response Body

curl -X DELETE "https://example.com/api/v1/narrative/universes/string/actors/string/events/string"

Empty

POST/api/v1/narrative/universes/{universe_id}/actors/{actor_id}/promote

Promote_actor

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

actor_id*string

Actor ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

fields?array<string>

Fields to promote (for selective strategy)

from_scope*ActorScope

Source scope to promote from (session or story)

Value in

"universe"
"story"
"session"

from_session_id?|

Source session ID (required if from_scope is session)

from_story_id?|

Source story ID (required if from_scope is story)

strategy?PromotionStrategy

Promotion strategy

Value in

"merge"
"replace"
"selective"

to_scope*ActorScope

Source scope to promote from (session or story)

Value in

"universe"
"story"
"session"

to_story_id?|

Target story ID (required if to_scope is story)

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/narrative/universes/string/actors/string/promote" \  -H "Content-Type: application/json" \  -d '{    "from_scope": "universe",    "to_scope": "universe"  }'

{  "actor": {    "actor_id": "string",    "actor_type": "character",    "attributes": [      {        "attribute_id": "string",        "name": "string",        "override_properties": null,        "template_id": "string",        "updated_at": "2019-08-24T14:15:22Z",        "value": {          "type": "number",          "value": 0.1        },        "version": 0      }    ],    "control_id": "string",    "created_at": "2019-08-24T14:15:22Z",    "last_modified_by": "string",    "metadata": {      "property1": null,      "property2": null    },    "name": "string",    "player_controlled": true,    "properties": {      "avatar_image_name": "string",      "description": "string",      "display_name": "string",      "image_name": "string"    },    "publish_state": "draft",    "scope": "universe",    "session_id": "string",    "source_actor_id": "string",    "source_version": 0,    "story_id": "string",    "tags": [      "string"    ],    "template_id": "string",    "template_snapshot": null,    "universe_id": "string",    "updated_at": "2019-08-24T14:15:22Z",    "version": 0  },  "conflicts_resolved": 0,  "fields_promoted": [    "string"  ],  "from_scope": "universe",  "source_actor_id": "string",  "success": true,  "target_actor_id": "string",  "to_scope": "universe"}

POST/api/v1/narrative/universes/{universe_id}/actors/{actor_id}/replicate

Replicate_actor

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

actor_id*string

Actor ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

modifications?array<>

Modifications to apply during replication

new_actor_id*string

to_scope*ActorScope

Target scope for the replica

Value in

"universe"
"story"
"session"

to_session_id?|

Target session ID (if to_scope is session)

to_story_id?|

Target story ID (if to_scope is story)

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/narrative/universes/string/actors/string/replicate" \  -H "Content-Type: application/json" \  -d '{    "new_actor_id": "string",    "to_scope": "universe"  }'

{  "actor": {    "actor_id": "string",    "actor_type": "character",    "attributes": [      {        "attribute_id": "string",        "name": "string",        "override_properties": null,        "template_id": "string",        "updated_at": "2019-08-24T14:15:22Z",        "value": {          "type": "number",          "value": 0.1        },        "version": 0      }    ],    "control_id": "string",    "created_at": "2019-08-24T14:15:22Z",    "last_modified_by": "string",    "metadata": {      "property1": null,      "property2": null    },    "name": "string",    "player_controlled": true,    "properties": {      "avatar_image_name": "string",      "description": "string",      "display_name": "string",      "image_name": "string"    },    "publish_state": "draft",    "scope": "universe",    "session_id": "string",    "source_actor_id": "string",    "source_version": 0,    "story_id": "string",    "tags": [      "string"    ],    "template_id": "string",    "template_snapshot": null,    "universe_id": "string",    "updated_at": "2019-08-24T14:15:22Z",    "version": 0  },  "new_actor_id": "string",  "source_actor_id": "string",  "success": true}

GET/api/v1/narrative/universes/{universe_id}/attribute-templates

List_attribute_templates

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Query Parameters

attribute_type?string

Value in

"number"
"string"
"boolean"

publish_state?string

Value in

"draft"
"published"
"archived"

q?string

Full-text search query

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Items per page

Formatint64

Range0 <= value

sort_by?string

Sort field (e.g. "created_at", "name")

sort_order?string

Sort direction

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/narrative/universes/string/attribute-templates"

{  "items": [    {      "actor_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "event_id": "string",      "event_key": "string",      "metadata": {        "property1": null,        "property2": null      },      "session_id": "string",      "story_id": "string",      "universe_id": "string",      "value_json": null    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

POST/api/v1/narrative/universes/{universe_id}/attribute-templates

Create_attribute_template

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

attribute_type*AttributeType

Value in

"number"
"string"
"boolean"

color?string|null

default_value?null|||

description?string|null

image_name?string|null

max_value?|

Formatdouble

metadata?

min_value?|

Formatdouble

name*string

suggested_values?array<string>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/narrative/universes/string/attribute-templates" \  -H "Content-Type: application/json" \  -d '{    "attribute_type": "number",    "name": "string"  }'

{  "attribute_type": "number",  "color": "string",  "created_at": "2019-08-24T14:15:22Z",  "default_value": null,  "description": "string",  "image_name": "string",  "max_value": 0,  "metadata": {    "property1": null,    "property2": null  },  "min_value": 0,  "name": "string",  "publish_state": "draft",  "suggested_values": [    "string"  ],  "template_id": "string",  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

GET/api/v1/narrative/universes/{universe_id}/attribute-templates/{template_id}

Get_attribute_template

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

template_id*string

Template ID

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/narrative/universes/string/attribute-templates/string"

{  "attribute_type": "number",  "color": "string",  "created_at": "2019-08-24T14:15:22Z",  "default_value": null,  "description": "string",  "image_name": "string",  "max_value": 0,  "metadata": {    "property1": null,    "property2": null  },  "min_value": 0,  "name": "string",  "publish_state": "draft",  "suggested_values": [    "string"  ],  "template_id": "string",  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

PATCH/api/v1/narrative/universes/{universe_id}/attribute-templates/{template_id}

Update_attribute_template

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

template_id*string

Template ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

color?|

Defaultnull

default_value?|||

Defaultnull

description?|

Defaultnull

image_name?|

Defaultnull

max_value?|

Formatdouble

Defaultnull

metadata?|

Defaultnull

min_value?|

Formatdouble

Defaultnull

name?|

Defaultnull

suggested_values?array<string>|

Defaultnull

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/narrative/universes/string/attribute-templates/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "attribute_type": "number",  "color": "string",  "created_at": "2019-08-24T14:15:22Z",  "default_value": null,  "description": "string",  "image_name": "string",  "max_value": 0,  "metadata": {    "property1": null,    "property2": null  },  "min_value": 0,  "name": "string",  "publish_state": "draft",  "suggested_values": [    "string"  ],  "template_id": "string",  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

DELETE/api/v1/narrative/universes/{universe_id}/attribute-templates/{template_id}

Delete_attribute_template

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

template_id*string

Template ID

Response Body

curl -X DELETE "https://example.com/api/v1/narrative/universes/string/attribute-templates/string"

Empty

GET/api/v1/narrative/universes/{universe_id}/events

Unified event listing endpoint. Supports all filtering options.

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Query Parameters

actor_id?string

Filter by actor ID

event_key?string

Filter by event key

story_id?string

Filter by story ID

session_id?string

Filter by session ID

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Items per page

Formatint64

Range0 <= value

sort_by?string

Sort field (e.g. "created_at", "event_key")

sort_order?string

Sort direction

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/narrative/universes/string/events"

{  "items": [    {      "actor_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "event_id": "string",      "event_key": "string",      "metadata": {        "property1": null,        "property2": null      },      "session_id": "string",      "story_id": "string",      "universe_id": "string",      "value_json": null    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

POST/api/v1/narrative/universes/{universe_id}/events/aggregate

Aggregate_events

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

event_key*string

session_id?string|null

story_id?string|null

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/narrative/universes/string/events/aggregate" \  -H "Content-Type: application/json" \  -d '{    "event_key": "string"  }'

{  "event_key": "string",  "total_count": 0}

POST/api/v1/narrative/universes/{universe_id}/events/batch

Upsert many events under a universe in one request

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A batch of events to upsert under one universe (high-volume event ingestion). Each is upserted independently and fail-fast; the server enforces a cap.

events*array<>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/narrative/universes/string/events/batch" \  -H "Content-Type: application/json" \  -d '{    "events": [      {        "actor_id": "string",        "event": {},        "event_key": "string"      }    ]  }'

{  "count": 0,  "results": [    {      "actor_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "event_id": "string",      "event_key": "string",      "metadata": {        "property1": null,        "property2": null      },      "session_id": "string",      "story_id": "string",      "universe_id": "string",      "value_json": null    }  ]}

GET/api/v1/narrative/universes/{universe_id}/sessions

List_sessions

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Query Parameters

player_id?string

story_id?string

active_only?boolean

q?string

Full-text search query

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Items per page

Formatint64

Range0 <= value

sort_by?string

Sort field (e.g. "created_at", "name")

sort_order?string

Sort direction

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/narrative/universes/string/sessions"

{  "items": [    {      "actor_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "event_id": "string",      "event_key": "string",      "metadata": {        "property1": null,        "property2": null      },      "session_id": "string",      "story_id": "string",      "universe_id": "string",      "value_json": null    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

POST/api/v1/narrative/universes/{universe_id}/sessions

Create_session

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

context?

player_id*string

settings?null|

story_id?string|null

ttl_seconds?|

Formatint32

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/narrative/universes/string/sessions" \  -H "Content-Type: application/json" \  -d '{    "player_id": "string"  }'

{  "context": {    "property1": null,    "property2": null  },  "created_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "is_expired": true,  "player_id": "string",  "session_id": "string",  "settings": {    "auto_save": true,    "save_interval_seconds": 0,    "ttl_seconds": 0  },  "story_id": "string",  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

GET/api/v1/narrative/universes/{universe_id}/sessions/{session_id}

Get_session

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

session_id*string

Session ID

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/narrative/universes/string/sessions/string"

{  "context": {    "property1": null,    "property2": null  },  "created_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "is_expired": true,  "player_id": "string",  "session_id": "string",  "settings": {    "auto_save": true,    "save_interval_seconds": 0,    "ttl_seconds": 0  },  "story_id": "string",  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

PATCH/api/v1/narrative/universes/{universe_id}/sessions/{session_id}

Update_session

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

session_id*string

Session ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

context?|

Defaultnull

extend_ttl_seconds?|

Formatint32

Range0 <= value

Defaultnull

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/narrative/universes/string/sessions/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "context": {    "property1": null,    "property2": null  },  "created_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "is_expired": true,  "player_id": "string",  "session_id": "string",  "settings": {    "auto_save": true,    "save_interval_seconds": 0,    "ttl_seconds": 0  },  "story_id": "string",  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

DELETE/api/v1/narrative/universes/{universe_id}/sessions/{session_id}

End_session

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

session_id*string

Session ID

Response Body

curl -X DELETE "https://example.com/api/v1/narrative/universes/string/sessions/string"

Empty

GET/api/v1/narrative/universes/{universe_id}/stories

List_stories

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Query Parameters

story_type?string

tags?string

Comma-separated tag filter

q?string

Full-text search query

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Items per page

Formatint64

Range0 <= value

sort_by?string

Sort field (e.g. "created_at", "name")

sort_order?string

Sort direction

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/narrative/universes/string/stories"

{  "items": [    {      "actor_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "event_id": "string",      "event_key": "string",      "metadata": {        "property1": null,        "property2": null      },      "session_id": "string",      "story_id": "string",      "universe_id": "string",      "value_json": null    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

POST/api/v1/narrative/universes/{universe_id}/stories

Create_story

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?string|null

graph_data?unknown

Serialized flow editor graph (nodes, edges, scenes)

lore_source?|

For lore stories: the .lore source code (server will compile)

metadata?

name*string

settings?null|

story_type?string

tags?array<string>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/narrative/universes/string/stories" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "graph_data": null,  "lore_compiled": null,  "lore_compiler_version": "string",  "lore_source": "string",  "metadata": {    "property1": null,    "property2": null  },  "name": "string",  "publish_state": "draft",  "settings": {    "actor_import_mode": "copy_on_write",    "allow_sessions": true,    "divergence_point": null,    "max_sessions": 0  },  "stats": null,  "story_id": "string",  "story_type": "string",  "tags": [    "string"  ],  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

GET/api/v1/narrative/universes/{universe_id}/stories/{story_id}

Get_story

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

story_id*string

Story ID

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/narrative/universes/string/stories/string"

{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "graph_data": null,  "lore_compiled": null,  "lore_compiler_version": "string",  "lore_source": "string",  "metadata": {    "property1": null,    "property2": null  },  "name": "string",  "publish_state": "draft",  "settings": {    "actor_import_mode": "copy_on_write",    "allow_sessions": true,    "divergence_point": null,    "max_sessions": 0  },  "stats": null,  "story_id": "string",  "story_type": "string",  "tags": [    "string"  ],  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

PATCH/api/v1/narrative/universes/{universe_id}/stories/{story_id}

Update_story

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

story_id*string

Story ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?|

Defaultnull

graph_data?unknown

Serialized flow editor graph (nodes, edges, scenes)

lore_source?|

For lore stories: updated .lore source code (server will recompile)

Defaultnull

metadata?|

Defaultnull

name?|

Defaultnull

publish_state?|

Defaultnull

settings?|

Defaultnull

story_type?|

Defaultnull

tags?array<string>|

Defaultnull

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/narrative/universes/string/stories/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "graph_data": null,  "lore_compiled": null,  "lore_compiler_version": "string",  "lore_source": "string",  "metadata": {    "property1": null,    "property2": null  },  "name": "string",  "publish_state": "draft",  "settings": {    "actor_import_mode": "copy_on_write",    "allow_sessions": true,    "divergence_point": null,    "max_sessions": 0  },  "stats": null,  "story_id": "string",  "story_type": "string",  "tags": [    "string"  ],  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

DELETE/api/v1/narrative/universes/{universe_id}/stories/{story_id}

Delete_story

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

story_id*string

Story ID

Response Body

curl -X DELETE "https://example.com/api/v1/narrative/universes/string/stories/string"

Empty

GET/api/v1/narrative/universes/{universe_id}/tags

List_tag_definitions

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Query Parameters

q?string

Full-text search query

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Items per page

Formatint64

Range0 <= value

sort_by?string

Sort field (e.g. "created_at", "name")

sort_order?string

Sort direction

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/narrative/universes/string/tags"

{  "items": [    {      "actor_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "event_id": "string",      "event_key": "string",      "metadata": {        "property1": null,        "property2": null      },      "session_id": "string",      "story_id": "string",      "universe_id": "string",      "value_json": null    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

POST/api/v1/narrative/universes/{universe_id}/tags

Create_tag_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

color?string

name*string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/narrative/universes/string/tags" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "color": "string",  "created_at": "2019-08-24T14:15:22Z",  "name": "string",  "tag_id": "string",  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

PATCH/api/v1/narrative/universes/{universe_id}/tags/{tag_id}

Update_tag_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

tag_id*string

Tag ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

color?|

Defaultnull

name?|

Defaultnull

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/narrative/universes/string/tags/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "color": "string",  "created_at": "2019-08-24T14:15:22Z",  "name": "string",  "tag_id": "string",  "universe_id": "string",  "updated_at": "2019-08-24T14:15:22Z"}

DELETE/api/v1/narrative/universes/{universe_id}/tags/{tag_id}

Delete_tag_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

universe_id*string

Universe ID

tag_id*string

Tag ID

Response Body

curl -X DELETE "https://example.com/api/v1/narrative/universes/string/tags/string"

Empty

Narrative

200application/json

503

201application/json

400

503

200application/json

404

503

200application/json

404

503

204

404

503

200application/json

503

201application/json

400

503

200application/json

404

503

200application/json

404

503

204

404

503

200application/json

503

201application/json

400

503

200application/json

503

200application/json

404

503

200application/json

404

503

204

404

503

200application/json

404

503

200application/json

404

503

201application/json

400

409

503

204

404

503

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`