Read an award letter

Break down one to three financial aid award letters: what is grant, what is loan, what is work-study that has to be earned, what the supported net price is, and what renewal conditions are buried in the language. Identifies missing facts and questions for the aid office. With more than one letter it compares them side by side. Read-only.

post/v1/tools/awardlens

Request

  • Base URL: https://api.counselorai.app
  • URL: https://api.counselorai.app/v1/tools/awardlens
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Retry-safe key. Guarantees the call is billed at most once.

X-Max-Creditsinteger

Maximum credits approved for this call. Rejects a larger hold and caps the final charge.

Request body

studentNamestring

The student this is about. Used in the output text.

letter1string required

First award letter, pasted as plain text.

letter2string

Second award letter, to compare against the first.

letter3string

Third award letter.

scorecardDatastring[]

Optional College Scorecard lines to ground the comparison: acceptance rate, graduation rate, average net price. Include the original Letter number and school/campus; unverified caller-supplied context.

Response

Tool output

request_idstring
toolstring

Changes

No recorded changes to this operation across all 1 revision of this API.