Skip to main content
POST
/
emotional-state
Store emotional state
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": {}
}
'
{
  "resource_id": "<string>",
  "summary": "<string>",
  "extracted_at": "<string>",
  "session_id": "<string>",
  "relationship_id": "<string>",
  "status": "<string>"
}

Authorizations

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.

Response

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