Store emotional state

Store a conversation transcript as emotional state and trigger indexing.

The conversation text is stored as a Vault resource in the _emotional_state collection and sent for indexing via the standard pipeline. Mood extraction happens asynchronously via the Hyperdoc pipeline (MoodExtractor).

POST /emotional-state

Store emotional state

cURL

curl --request POST \
  --url https://api.hyperspell.com/emotional-state \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversation": "<string>",
  "session_id": "<string>",
  "relationship_id": "<string>",
  "metadata": {}
}
'

200

{
  "resource_id": "<string>",
  "summary": "<string>",
  "extracted_at": "<string>",
  "session_id": "<string>",
  "relationship_id": "<string>",
  "status": "<string>"
}

Authorizations

APIKeyAsUser

Authorization · string · header · required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Body

application/json

Request to store an emotional state extraction.

conversation · string · required

The conversation transcript to extract emotional state from.

session_id · string | null

Session identifier for the conversation.

relationship_id · string | null

Per-relationship scoping key (e.g. 'partner-anna', 'slack:C01234').

metadata · Metadata · object

Custom metadata for filtering.

Show child attributes

Response

200

application/json

Successful Response

Response after storing emotional state.

resource_id · string · required

summary · string · required

extracted_at · string · required

session_id · string | null · required

relationship_id · string | null · required

status · string · required