v3

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-08-014669239.7 KB
Observations

Create Observations

Create one or more transient observations associated with the specified profile. Supports both single observation creation and batch creation of up to 10 observations. Supports request compression for large batch operations and response compression for the response. All observations will be automatically indexed for semantic search capabilities. The content can be up to 4KB in length and should contain relevant information about the profile. The createdAt and updatedAt timestamps will be automatically set to the current time. Each observation will be created with a unique ID in Twilio Type ID (TTID) format.

post/v1/Stores/{storeId}/Profiles/{profileId}/Observations

Headers

Accept-Encodingstring
Example:gzip, deflate, br

Compression algorithms supported by the client (e.g., gzip, deflate, br)

Content-Encoding'gzip' | 'deflate' | 'br' | 'compress'
Example:gzip

Compression algorithm used for the request body (e.g., gzip, deflate, br)

Request body

Example request

{
  "observations": [
    {
      "content": "Customer expressed satisfaction with recent product update during support call.",
      "occurredAt": "2025-01-15T10:15:30Z",
      "source": "conversational-intelligence",
      "conversationIds": [
        "conv_conversation_00000000000000000000000000"
      ]
    }
  ]
}

Response

Observation creation accepted and is being processed.

messagestring required

Confirmation message for the operation.

Example response

{
  "message": "Observations creation accepted"
}