Skip to main content
POST
Preview a candidate note before saving it

Authorizations

Authorization
string
header
required

Telnyx API key

Path Parameters

namespace
string
required

The namespace. default exists for every organization.

profile_id
string
required

The profile: your identifier for the user, caller or agent this memory is about.

Body

application/json

A candidate note to preview against one profile. The field is optional; omitting it, or sending null/empty/whitespace, previews the neutral default.

instructions
string | null

The candidate note to try. null, empty, or whitespace-only previews the neutral default -- the summary a profile returns to when instructions are cleared. Capped at 2000 characters, the same cap PATCH /settings applies on save; a longer note is refused with 422 before anything is generated.

Maximum string length: 2000

Response

The summary this profile would carry under the candidate note. data.text is null when nothing was generated -- the same signal GET /summary uses for a profile with no card yet.

data
PreviewedSummary · object
required