Skip to contentSkip to navigationSkip to topbar

Retrieve Observation


(information)

Legal information

Conversation Memory, including the APIs, may use artificial intelligence or machine learning technologies and is subject to the terms of the Predictive and Generative AI/ML Features Addendum(link takes you to an external page). For more details on AI usage and data, see the AI Nutrition Facts.

Conversation Memory is not a HIPAA Eligible Service or PCI compliant and should not be enabled in workflows that are subject to HIPAA or PCI.

Conversation Memory is not intended for use with sensitive information about individuals. Twilio does not control what information comes from conversation channels and relies on you to ensure the data in customer profiles aligns with our acceptable use policy. Twilio does have limited guardrails in the form of a prompt exclusion that is designed to provide a minimal screening against inclusion of GDPR special category data(link takes you to an external page). As a reminder our profile technology uses generative artificial intelligence. Because generative artificial intelligence can make mistakes, review all outputs to ensure that the profile is correct.

Conversations products are only available in the new Twilio Console(link takes you to an external page). If your account hasn't been migrated, you'll be redirected to the legacy Console where these products won't appear.

GET/v1/Stores/{storeId}/Profiles/{profileId}/Observations/{observationId}

Base url: https://memory.twilio.com (base url)

Retrieve a specific transient observation by its ID for the given profile.


Request

fetch-profile-observation-request page anchor

Authentication

authentication page anchor
Property nameTypeRequiredPIIDescription
storeIdstring
required
Not PII

A unique Memory Store ID using Twilio Type ID (TTID) format

Example: mem_store_00000000000000000000000000Pattern: ^mem_(store|service)_[0-7][0-9a-z]{25}$

profileIdstring
required

The unique identifier for the profile using Twilio Type ID (TTID) format.

Example: mem_profile_00000000000000000000000000Pattern: ^mem_profile_[0-7][0-9a-z]{25}$

observationIdstring
required

The observation ID.

Example: mem_observation_00000000000000000000000000Pattern: ^mem_observation_[0-7][0-9a-z]{25}$

200400401403404429500503

Observation retrieved successfully.

SchemaExample
Property nameTypeRequiredPIIDescriptionChild properties
contentstring

Optional

The main content of the observation.

Example: Customer expressed satisfaction with recent product update during support call.Min length: 1Max length: 4096

occurredAtstring<date-time>

Optional

The timestamp when the observation originally occurred.

Example: 2025-01-15T10:15:30Z

sourcestring

Optional

The source system that generated this observation. Allows letters, numbers, spaces, and URL-safe symbols. Excludes URL-unsafe characters like quotes, angle brackets, and control characters.

Example: conversational-intelligencePattern: ^[a-zA-Z0-9 _.-]+$Min length: 1Max length: 100

conversationIdsarray[string]

Optional

Array of conversation IDs associated with this observation.

Max items: 10

idstring

Optional

A unique identifier for the observation using Twilio Type ID (TTID) format.

Example: mem_observation_00000000000000000000000000Pattern: ^mem_observation_[0-7][0-9a-z]{25}$

createdAtstring<date-time>

Optional

The timestamp when the observation was created.

Example: 2025-01-15T10:30:45Z

updatedAtstring<date-time>

Optional

The timestamp when the observation was last updated.

Example: 2025-01-15T10:30:45Z
Retrieve ObservationLink to code sample: Retrieve Observation
1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9
10
async function fetchProfileObservation() {
11
const observation = await client.memory.v1
12
.observations(
13
"mem_store_00000000000000000000000000",
14
"mem_profile_00000000000000000000000000",
15
"mem_observation_00000000000000000000000000"
16
)
17
.fetch();
18
19
console.log(observation.content);
20
}
21
22
fetchProfileObservation();

Response

Note about this response
1
{
2
"id": "mem_observation_00000000000000000000000001",
3
"content": "Customer expressed frustration with billing process during call on 2025-01-15. Mentioned difficulty understanding charges.",
4
"source": "customer_service",
5
"occurredAt": "2025-01-15T14:30:00Z",
6
"conversationIds": [
7
"conv_conversation_00000000000000000000000000"
8
],
9
"createdAt": "2025-01-15T10:30:45Z",
10
"updatedAt": "2025-01-15T10:30:45Z"
11
}