Quote a Student profile summary 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/profile/quote

Request

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

Request body

studentNamestring

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

gradestring
schoolstring
majorstring
academicsstring

Coursework, GPA, testing, academic trajectory.

activitiesstring
strengthsstring

What the counselor has actually observed, not adjectives.

challengesstring

What the student has had to work around.

goalsstring
tagsstring[]

Background categories. Same vocabulary the scholarship tool uses, so a profile feeds straight into it.

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.