Resume a relationship (welcome-back)

POST

characters

{id}

resume

curl --request POST \
  --url https://api.alakazam.gg/v1/characters/{id}/resume \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "<string>"
}
'

{
  "returning": true,
  "welcome": "<string>",
  "affect": {},
  "messageCount": 123
}

Authorizations

Authorization

string

header

required

The scoped runtime session JWT from POST /v1/sessions/token. The embed's browser presents it (Authorization: Bearer, or a token body field) to the runtime exchange routes. Not an API key.

Path Parameters

string<uuid>

required

Body

application/json

token

string

Response

The relationship state + a welcome line.

returning

boolean

welcome

string

affect

object

messageCount

integer

Consolidate the session into memoryFold the session's transcript into the player's stored summary (one server-side LLM call). Call on unmount. No-op for anonymous players or an empty session.

⌘I

Resume a relationship (welcome-back)

curl --request POST \
  --url https://api.alakazam.gg/v1/characters/{id}/resume \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "<string>"
}
'

{
  "returning": true,
  "welcome": "<string>",
  "affect": {},
  "messageCount": 123
}