Skip to main content
POST
AI summary of a note thread

Authorizations

x-arms-api-key
string
header
required
x-arms-assume-user
string
header
required

Headers

Carrier
string
required

Carrier ID the request is scoped to.

Body

application/json
entity_id
string

Entity ID whose note thread to summarize.

entity_type
string

Entity type whose note thread to summarize.

Response

A successful response.

note_count
integer<int32>

Number of notes that were summarized — useful for showing "summary of N notes" alongside the digest.

summary_text
string

One-paragraph plain-text digest covering key themes, latest status, and unresolved concerns. Empty string if the thread had no notes.