Aid estimate explainer

Explain what a family is likely to see across a list of schools and why, in plain language. An explanation for a counselor to walk a family through, never an official determination, and the output says so.

post/v1/tools/aid

Request

  • Base URL: https://api.counselorai.app
  • URL: https://api.counselorai.app/v1/tools/aid
  • 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.

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

Tool output

request_idstring
toolstring

Changes

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