List Promises

GET

/api/creative/plot/promises

• DivinityEngine - Local development
• DivinityEngine - Localhost alternative

List promises, optionally filtered.

Parameters

Query Parameters

status

Any of:

string

string

null

null

promise_type

Any of:

string

string

null

null

promise_level

Any of:

string

string

null

null

plotline_id

Any of:

string

string

null

null

Responses

200

Successful Response

PromiseListResponse

Promise list response.

object

status

required

Status

Operation status

string

data

required

PromiseListData

List payload

object

promises

required

Promises

Promises

Array<object>

PlotPromise

A narrative promise to the reader (Sanderson’s framework).

object

id

required

Id

Promise UUID

string

projectId

required

Projectid

Owning project

string

title

required

Title

Promise title

string

description

Description

What is being promised

string

""

promiseType

Promisetype

Promise classification

string

default: plot

Allowed values: tone genre plot character

promiseLevel

Promiselevel

Scope level

string

default: story

Allowed values: story act scene

status

Status

Fulfillment status

string

default: made

Allowed values: made in_progress fulfilled broken

madeAtNodeId

Any of:

string

string

null

null

fulfilledAtNodeId

Any of:

string

string

null

null

plotlineId

Any of:

string

string

null

null

notes

Notes

Author notes

string

""

madeAtNodeTitle

Madeatnodetitle

Made node title (denormalized)

string

""

fulfilledAtNodeTitle

Fulfilledatnodetitle

Fulfilled node title (denormalized)

string

""

plotlineTitle

Plotlinetitle

Plotline title (denormalized)

string

""

createdAt

required

Createdat

Created timestamp (ms)

integer

modifiedAt

required

Modifiedat

Modified timestamp (ms)

integer

total

required

Total

Total count

integer

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object