Skip to main content
POST
Analyze Notes
This endpoint consumes AI credits. Each analysis costs 2 credits regardless of note count. If the workspace balance is insufficient, the API returns 402 insufficient_credits.

Request

Headers

string
Optional UUID. Deduplicates retries within 24 hours.

Body Parameters

string
UUID of a contact whose notes should be analyzed. Provide either contact_id or deal_id.
string
UUID of a deal whose notes should be analyzed.
string
Optional focus area: summary, risks, opportunities, sentiment, timeline, or all. Defaults to all.
integer
default:"50"
Maximum number of notes to include (most recent first). Maximum 200.

Response

object
Responses include X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID.

Example Response

Errors