Quote a Scholarship research links 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/scholarship/quote

Request

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

Request body

studentNamestring

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

gradestring

Grade level or transfer status.

gpastring
majorstring

Intended field. Departmental awards are usually the least contested.

statestring

State of residence. State and regional awards have far smaller applicant pools than national ones.

backgroundsstring[]

Eligibility categories that unlock specific award pools.

activitiesstring

Extracurriculars and leadership.

notesstring

Anything else that should shape the output.

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.