Quote a Read an award letter call (free)

Free pre-flight. Validates the input and returns the exact credit hold a real call would take at this account's price, without billing anything. An invalid input is still a 200: the body carries valid:false and the validation errors.

post/v1/tools/awardlens/quote

Request

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

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

Quote

toolstring
validboolean
estimated_creditsinteger
estimated_usdnumber
max_credits_heldinteger
max_credits_supportedboolean
credit_balanceinteger
sufficientboolean
price_multipliernumber

Changes

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