Skip to main content
Fetch the accumulated profile for a user: the client-defined critical attributes (e.g. intent, budget, preferences) plus a short free-text overview that Synap maintains across the user’s conversations. This is a convenience getter. The same document is returned inline by sdk.fetch(context_mode="conversation-summary", include_profile=True); reach for get_profile when you want the profile on its own: dashboardless debugging, your own tooling, or a quick lookup.
Profiles are on by default. See the User Profile guide for defining your attribute schema (or opting out per instance). For a user whose profile has not been built yet, there is nothing to return and the call raises ContextNotFoundError.

Parameters

str
required
Caller identity (e.g. an E.164 phone number).
str
Required on B2B (strict-isolation) instances so the profile resolves to the right tenant; omit on B2C.

Returns

A UserProfileModel.
Dict[str, ProfileAttributeModel]
Critical attributes keyed by name. Each ProfileAttributeModel carries value, confidence, updated_at, source_conversation_id (and .raw).
Optional[str]
A short free-text summary of the caller.
Dict[str, Any]
Stable facts worth keeping that match no configured attribute.
Dict[str, Any]
Document metadata (_meta): schema, version, updated_at, etc.
.raw exposes the full untyped profile document.

Example

Raises

  • ContextNotFoundError: no profile exists for this user (HTTP 404).
  • AuthenticationError: when the API key is missing or invalid.

See also