Skip to main content
POST
/
v1
/
project
/
{project_id}
/
observations
/
Create observations
curl --request POST \
  --url https://api.correl8.ai/v1/project/{project_id}/observations/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "user-42",
  "interaction_id": "conv_9f3a2b1c",
  "user_sentiment": "negative",
  "observations": [
    {
      "title": "Enter key did not submit message",
      "description": "The user pressed Enter in the chat composer expecting the message to send. The message stayed in the input field."
    }
  ]
}
'
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_id": "<string>",
      "interaction_id": "<string>",
      "source": "<string>",
      "title": "<string>",
      "description": "<string>",
      "processing_error": "<string>",
      "processed_at": "2023-11-07T05:31:56Z",
      "observed_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "label": "<string>",
          "config": {}
        }
      ]
    }
  ]
}

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