Quote a Aid estimate explainer 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/aid/quote

Request

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

Request body

studentNamestring

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

incomestring

Household income, as the family stated it.

schoolCountinteger

How many schools are being compared.

schoolSummariesstring

One line per school: name, cost of attendance, anything already known about the offer.

contextstring

Household situation that affects the estimate.

fafsaContextstring

What is already known from the FAFSA, including the SAI if it has come back.

repayContextstring

What the family has said about borrowing and what they can carry.

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.