Skip to main content
POST
Create observations

Authorizations

Authorization
string
header
required

Project API key prefixed with ApiKey, e.g. Authorization: ApiKey c8.xxx. Alternatively use header X-Api-Key: c8.xxx.

Path Parameters

project_id
string<uuid>
required

Project UUID

Body

application/json
user_id
string
required

Your identifier for the end user

Maximum string length: 512
interaction_id
string
required

Your identifier for the conversation thread

Maximum string length: 512
user_sentiment
enum<string>
required

Sentiment label applied to all items. See Sentiment docs.

Available options:
very negative,
negative,
neutral,
positive,
very positive
observations
object[]
required

One or more observations (max 50 per request). Do not nest user_id, interaction_id, user_sentiment, or observed_at inside items.

Required array length: 1 - 50 elements
observed_at
string<date-time>

Optional timestamp applied to all items. Defaults to server time if omitted.

Response

Observations created

results
object[]
required