Student profile summary

Turn raw counselor notes into a structured student profile. Run this first when working one student across several tools: it is cheap, and its output is good input for the relationship, traits and story fields on rec, or keyDetails on appeal.

post/v1/tools/profile

Request

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

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

Tool output

request_idstring
toolstring

Changes

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