Emotional State

Store emotional state

Store a conversation transcript as emotional state and trigger indexing.

Mood extraction happens asynchronously, so the returned record may initially contain a placeholder summary and update when processing completes.

post/emotional-state

Request

  • Base URL
    https://api.hyperspell.com
  • URL
    https://api.hyperspell.com/emotional-state
  • Auth
    HTTP bearer

Headers

X-As-Userstring nullable

Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

Request body

conversationstring required

The conversation transcript to extract emotional state from.

session_idstring nullable

Session identifier for the conversation.

relationship_idstring nullable

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

metadataobject nullable

Custom metadata for filtering.

Response

Successful Response

resource_idstring required
summarystring required
extracted_atstring required
session_idstring nullable required
relationship_idstring nullable required
statusstring required
summary_sourcestring

Changes

No operation changes recorded.