Call this server's tools from your browser. Nothing to install.
https://goldseam.ksaworks.com/mcp
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
assemble_my_formal_education Read-only
Read a person's transcripts into their evidence package: each file's text and status, its courses and exams as rows, and the items will_my_credits_transfer takes (courses as { unitid or school, code }; exams with a score, in the exam programmes this build holds). Ask the person for each transcript and the school it came from. Several transcripts are read side by side. A school several schools' names fit is answered with the candidates, and nothing is read. Nothing is stored: the answer returns the package for the agent to keep.
1 or more transcripts
The goldribbon_package_v1 object an earlier GoldRibbon answer returned. Keep it for the person and send it back whole; GoldSeam keeps no copy.
Tools (57)
Tool list last changed Oct 23, 2026.
assemble_my_formal_education
Read a person's transcripts into their evidence package: each file's text and status, its courses and exams as rows, and the items will_my_credits_transfer takes (courses as { unitid or school, code }; exams with a score, in the exam programmes this build holds). Ask the person for each transcript and the school it came from. Several transcripts are read side by side. A school several schools' names fit is answered with the candidates, and nothing is read. Nothing is stored: the answer returns the package for the agent to keep.
read-only
Argument
Type
Description
files*
array
1 or more transcripts
package
object
The goldribbon_package_v1 object an earlier GoldRibbon answer returned. Keep it for the person and send it back whole; GoldSeam keeps no copy.
Input schema (JSON)
{
"type": "object",
"required": [
"files"
],
"properties": {
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"slot",
"filename",
"content_base64"
],
"properties": {
"slot": {
"enum": [
"transcript"
],
"type": "string"
},
"school": {
"type": "string",
"description": "The school the transcript came from, a name or initials (e.g. CNM); ask the person"
},
"unitid": {
"type": "string",
"description": "Or the school's IPEDS UNITID, e.g. 187532"
},
"filename": {
"type": "string"
},
"content_base64": {
"type": "string",
"description": "The file's bytes, base64. A call's files total at most about 1.5 MB; send more over several calls with the same package."
}
}
},
"description": "1 or more transcripts"
},
"package": {
"type": "object",
"description": "The goldribbon_package_v1 object an earlier GoldRibbon answer returned. Keep it for the person and send it back whole; GoldSeam keeps no copy."
}
}
}
assemble_my_work_and_credentials
Read a person's resume, LinkedIn export, certificates, military records and apprenticeship records into their evidence package: each file's text and status, and the credential signals the certificate, military and apprenticeship documents carry. Ask the person for each file. This assembles; the Selfie is my_selfie_ksa_view. Nothing is stored: the answer returns the package for the agent to keep.
read-only
Argument
Type
Description
files*
array
1 or more files
package
object
The goldribbon_package_v1 object an earlier GoldRibbon answer returned. Keep it for the person and send it back whole; GoldSeam keeps no copy.
linkedin_url
string
Optional: the person's LinkedIn profile address
Input schema (JSON)
{
"type": "object",
"required": [
"files"
],
"properties": {
"files": {
"type": "array",
"items": {
"type": "object",
"required": [
"slot",
"filename",
"content_base64"
],
"properties": {
"slot": {
"enum": [
"resume",
"linkedin_file",
"certs",
"military",
"apprentice"
],
"type": "string"
},
"filename": {
"type": "string"
},
"content_base64": {
"type": "string",
"description": "The file's bytes, base64. A call's files total at most about 1.5 MB; send more over several calls with the same package."
}
}
},
"description": "1 or more files"
},
"package": {
"type": "object",
"description": "The goldribbon_package_v1 object an earlier GoldRibbon answer returned. Keep it for the person and send it back whole; GoldSeam keeps no copy."
},
"linkedin_url": {
"type": "string",
"description": "Optional: the person's LinkedIn profile address"
}
}
}
assert_my_life_experiences
Record what a person says they have done outside school and work (family, clubs, sports, faith, travel, self-taught projects, challenges) in their evidence package, each placed in a Selfie dimension by the KSA classifier or left unresolved, never defaulted. These are the person's own statements, kept apart from formal education. Nothing is stored: the answer returns the package for the agent to keep.
read-only
Argument
Type
Description
entries*
array
1 to 20 life experiences
package
object
The goldribbon_package_v1 object an earlier GoldRibbon answer returned. Keep it for the person and send it back whole; GoldSeam keeps no copy.
Input schema (JSON)
{
"type": "object",
"required": [
"entries"
],
"properties": {
"entries": {
"type": "array",
"items": {
"type": "object",
"required": [
"category",
"activity"
],
"properties": {
"weight": {
"enum": [
"occasional",
"regular",
"central"
],
"type": "string"
},
"activity": {
"type": "string",
"description": "What the person did, in their words"
},
"category": {
"enum": [
"passions",
"sports",
"clubs",
"faith",
"family",
"selftaught",
"travel",
"challenges",
"other"
],
"type": "string"
},
"difficulty": {
"enum": [
"remember",
"understand",
"apply",
"analyze",
"evaluate",
"create"
],
"type": "string"
},
"elaboration": {
"type": "string"
},
"life_period": {
"enum": [
"childhood",
"adolescence",
"emerging_adult",
"early_adult",
"midlife",
"experienced",
"later_life"
],
"type": "string"
}
}
},
"description": "1 to 20 life experiences"
},
"package": {
"type": "object",
"description": "The goldribbon_package_v1 object an earlier GoldRibbon answer returned. Keep it for the person and send it back whole; GoldSeam keeps no copy."
}
}
}
certifications_for_occupation
What certifications serve this occupation? SOC-keyed lookup (dashed SOC accepted with or without the O*NET .00 suffix).
read-only
Argument
Type
Description
soc*
string
An occupation code (SOC), e.g. 29-1141 for Registered Nurses or 47-2111 for Electricians — don't know it? search by the job name instead
limit
integer
Optional page size (default 20, at most 50)
offset
integer
Optional: the next_offset from a previous answer
Input schema (JSON)
{
"type": "object",
"required": [
"soc"
],
"properties": {
"soc": {
"type": "string",
"examples": [
"29-1141",
"47-2111"
],
"description": "An occupation code (SOC), e.g. 29-1141 for Registered Nurses or 47-2111 for Electricians — don't know it? search by the job name instead"
},
"limit": {
"type": "integer",
"description": "Optional page size (default 20, at most 50)"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
}
}
}
certifications_for_program
Broad academic cross-reference by instructional program (CIP). A deliberately broader, lower-precision question than an occupation lookup — never its peer (contract § 4).
read-only
Argument
Type
Description
cip*
string
A college program code (CIP), e.g. 51.3801 for Registered Nursing or 47.0201 for HVAC technology
limit
integer
Optional page size (default 20, at most 50)
offset
integer
Optional: the next_offset from a previous answer
Input schema (JSON)
{
"type": "object",
"required": [
"cip"
],
"properties": {
"cip": {
"type": "string",
"examples": [
"51.3801",
"47.0201"
],
"description": "A college program code (CIP), e.g. 51.3801 for Registered Nursing or 47.0201 for HVAC technology"
},
"limit": {
"type": "integer",
"description": "Optional page size (default 20, at most 50)"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
}
}
}
checklist_map
How far along am I in a program at a school I am considering? One checklist at any target school, chosen by its name or title (or its checklist_id), line by line against what a person holds. Each held item is compared through comparable_map - every source, published and inferred - and each landing joined to the checklist's lines; a GoldRibbon package, when given, adds the lines its prior learning may meet. Each line is met (a published rule lands a held item on it), reached_by_inference (only an inferred landing reaches it: shown with its path of published links, never counted as met), may_be_met_by_prior_learning, or open, with every way it is reached. Each group gives its lines by state beside the choice rule it prints. Last, what does not count: each held item that reaches no line, with its reason (no rule, below the score, or landing on a course this checklist does not require). A case to show the school, not a verdict; recognition is the school's act. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
held
array
0 to 20 things held, each as comparable_map takes one: a course { unitid, code }, an exam { program, exam, score }, { learning_unit_id } or { certification_ctid }. Compared 5 per call: an answer with more to compare carries `continue.arguments` to send back as they are
carried
object
checklists_requiring_learning_unit
Which checklists require this course? Each requirement item that resolved to it, with its checklist id, award and group heading. Items that did not resolve to a course are never guessed into this list. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
limit
integer
Optional page size (default 20, at most 100)
offset
integer
Optional: the next_offset from a previous answer
learning_unit_id*
string
A learning unit id from learning_units or get_learning_unit
Input schema (JSON)
{
"type": "object",
"required": [
"learning_unit_id"
],
"properties": {
"limit": {
"type": "integer",
"description": "Optional page size (default 20, at most 100)"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
},
"learning_unit_id": {
"type": "string",
"examples": [
"LU_course_225070_ENGL1301_20262027"
],
"description": "A learning unit id from learning_units or get_learning_unit"
}
}
}
comparability_for_courses
Where does a whole list of courses and exams land at ONE receiving school? One item in, one stated answer out, in the order asked: the rules this build holds for each - the school's own catalog, a transfer agreement, and CourseAtlas's rules as ingested, which carry their CourseAtlas ids. CourseAtlas is not read live per item here; a caller that reads it live merges on those shared ids, where the two sources agreeing is corroboration. CourseShelf and CourseAtlas are equal reference sources: neither outranks the other. An item whose school or course is not held says so and the other items still answer. An exam is read by its exam node, whatever its wording; an exam that fits none, or more than one, answers its `candidates` to choose from, never a guess. Comparable, never equivalent. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
items*
array
What was taken: each item a course (its school by unitid or name, with code or title) or an exam (exam_program with exam). At most 60 in one call.
limit
integer
Optional page size per item's rules (default 10, at most 50)
target_unitid
comparability_for_learning_unit
Where does this course land at other schools, and what lands on it (exams included)? The published transfer rules for one course: the rules CourseShelf holds first (a school's own catalog, CourseAtlas), then CourseAtlas's direct rules read live. Each rule names its source authority, source_url and band; comparable, never equivalent. What lands on a course is answered from the held rules only. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
code
string
The course code as printed, e.g. HIST 201
limit
integer
Optional page size per list (default 10, at most 50)
title
string
Or: the course title, matched exactly
offset
integer
Optional: the offset of the next page
school
string
Or: the course's school, by name (with code or title)
comparable_map
What is one thing I hold comparable to at a school I am considering? One learning unit of any kind - a course at the school it was taken at, an exam at a score, a learning unit by id, or a certification - compared with any target school, every source asked in turn and each step said as it ran: CourseShelf's published rules held for the target; CourseShelf's inferred landings, read from stored inferred rows when held, else by walking the published links of every kind (a published rule one way; an exam at a shared score, a common course number, or an agreement's or state's course both ways), crossing kinds, up to `depth` links; CourseAtlas's published equivalencies, live; and CourseAtlas's inferred chain (GetIndirectTargets), live. Each step says found, none, not held, error or skipped, with its time in ms. A published rule decides where the unit lands; an inferred landing names its path of published links and is shown as inferred, never as published, withdrawn where a published rule holds. An exam is read by its exam node and judged at the held score. Recognition is the target school's act. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
item*
object
One learning unit: a course { unitid, code as printed (e.g. BIOL 100) }, an exam { program (e.g. AP), exam (its code or title), score }, { learning_unit_id }, or { certification_ctid }
compare_destinations
Line up 2 to 6 destination occupations side by side from one occupation: the bridge size (credential only, or the program bridges' awards as published), O*NET demand (median wage, outlook, bright outlook) and the evidence classes of the roads. Each cell is copied or counted, never scored.
read-only
Argument
Type
Description
to_socs*
array
2 to 6 destination SOC codes, e.g. from find_transitions
How do these majors differ? Two to five majors at one level, side by side: definition, the schools offering it, the jobs and their outlook from O*NET, and earnings at 1 and 5 years with debt — given as the LOWEST-TO-HIGHEST RANGE across the schools that publish them, with the number of schools stated. A range of school figures, never a median computed from them. A six-digit major's earnings come from its four-digit series and every such figure is labelled series-level. Every column is complete, or it says which figure is not published.
read-only
Argument
Type
Description
level*
string
The credential level to compare at, e.g. certificate
state
string
Optional two-letter state, for the school counts
majors*
array
2 to 5 majors, each a major_minor_id (e.g. CIP:51.3801) or a CIP code
Input schema (JSON)
{
"type": "object",
"required": [
"majors",
"level"
],
"properties": {
"level": {
"type": "string",
"examples": [
"certificate"
],
"description": "The credential level to compare at, e.g. certificate"
},
"state": {
"type": "string",
"description": "Optional two-letter state, for the school counts"
},
"majors": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"CIP:51.3901",
"CIP:51.3902"
]
],
"description": "2 to 5 majors, each a major_minor_id (e.g. CIP:51.3801) or a CIP code"
}
}
}
compare_my_school
Which of these schools is better for me? Two to five schools, one major and a level, side by side: program and award, credits required verbatim, requirements compared line by line, and — when the person offers their courses and exam scores — what each school's own published rules would count them for, with GoldCheck's states and reasons carried through unchanged. Credits left is reduced only by items a school's own rules cover; an unknown item, or an inference, never reduces it. Cost, earnings, debt with its 10-year monthly payment beside it, and payback in months where both inputs are published; where either is missing, payback is not computed and the missing input is named. The comparison never ranks: no score is invented to decide for the person.
read-only
Argument
Type
Description
held
array
Optional: the same shape will_my_credits_transfer takes — an exam { program, exam, score } or a course { unitid or school, code }
level*
string
The credential level
major*
string
The major: a major_minor_id or a CIP code
package
object
Optional: the agent-held GoldRibbon package. GoldSeam stores no copy of it
unitids*
array
2 to 5 schools, by IPEDS UNITID
Input schema (JSON)
compare_program_checklists
Compare what a program takes at several institutions: for each IPEDS UNITID, that institution's published checklist for the program (requirement groups, items, published credit strings — the work effort) beside its published tuition and fee policy (the cost). Schedule is stated not held. Nothing is summed or computed by the service; an institution, checklist, or cost the catalogs do not hold is stated as such. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
detail
string
Optional: full (the default: every requirement group and item) or summary (per checklist its program, award, year, credits and group and item counts, with each school's College Scorecard tuition)
program*
string
Program or award words to match, e.g. nursing or Bachelor of Science in Nursing
unitids*
array
1 to 10 IPEDS UNITIDs, e.g. ["100663", "127060"]; answered 5 institutions per call, up to 3 checklists each
institution_offset
crosswalk_code
What does this code cross to? Auto-detects the family — dotted CIP (52.0201) or dashed SOC (11-1021, O*NET .00 suffix accepted) — and answers the other family's codes and titles from the federal CIP-SOC crosswalk.
read-only
Argument
Type
Description
code*
string
A college program code (CIP, e.g. 51.3801) or an occupation code (SOC, e.g. 29-1141)
limit
integer
Optional page size (default 20, at most 50)
offset
integer
Optional: the next_offset from a previous answer
Input schema (JSON)
{
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"type": "string",
"examples": [
"51.3801",
"29-1141"
],
"description": "A college program code (CIP, e.g. 51.3801) or an occupation code (SOC, e.g. 29-1141)"
},
"limit": {
"type": "integer",
"description": "Optional page size (default 20, at most 50)"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
}
}
}
draft_my_claims
Draft the credit claims a person's evidence supports, from their package (after my_selfie_ksa_view): each claim quotes the document it rests on. They are drafts for the person to keep, affirm or decline (set each claim's confidence to ratified, affirmed or declined in the package); the AI never affirms a claim. Give the school they are thinking of as `school` so its catalog is made ready for suggest_credit_for_my_learning. Nothing is stored: the answer returns the package for the agent to keep.
read-only
Argument
Type
Description
school
string
Optional: the school they are thinking of, a name or IPEDS UNITID; its catalog is made ready for the suggestions
package*
object
The goldribbon_package_v1 object an earlier GoldRibbon answer returned. Keep it for the person and send it back whole; GoldSeam keeps no copy.
language
string
aspiration
string
Optional: what the person is aiming for
Input schema (JSON)
{
"type": "object",
"required": [
"package"
],
"properties": {
"school": {
"type": "string",
"description": "Optional: the school they are thinking of, a name or IPEDS UNITID; its catalog is made ready for the suggestions"
},
"package": {
"type": "object",
"description": "The goldribbon_package_v1 object an earlier GoldRibbon answer returned. Keep it for the person and send it back whole; GoldSeam keeps no copy."
},
"language": {
"enum": [
"en",
"es",
"fr"
],
"type": "string"
},
"aspiration": {
"type": "string",
"description": "Optional: what the person is aiming for"
}
}
}
expand_term
What is this word, upward? Walks the WordNet is-a (hypernym) chain meaning to parent meaning, from the word's KSA-mapped sense toward its broader categories, so every step stays in the sense it started in. Each step carries its definition (gloss) and synonyms.
read-only
Argument
Type
Description
term*
string
A word to see what broader kind of thing it is, e.g. carpentry
Input schema (JSON)
{
"type": "object",
"required": [
"term"
],
"properties": {
"term": {
"type": "string",
"examples": [
"carpentry",
"nursing"
],
"description": "A word to see what broader kind of thing it is, e.g. carpentry"
}
}
}
find_agreements
Which articulation or transfer agreements are held? Optional title words, or an institution's UNITID as a party. Answers none held when the build holds none. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
limit
integer
Optional page size (default 20, at most 100)
query
string
Optional agreement title words
offset
integer
Optional: the next_offset from a previous answer
unitid
string
Optional: an institution party's IPEDS UNITID
Input schema (JSON)
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Optional page size (default 20, at most 100)"
},
"query": {
"type": "string",
"description": "Optional agreement title words"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
},
"unitid": {
"type": "string",
"description": "Optional: an institution party's IPEDS UNITID"
}
}
}
find_catalogs
Which published catalog editions are held for this institution? Each catalog's edition year, format and source. Answers none held when the build holds none. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
limit
integer
Optional page size (default 20, at most 100)
offset
integer
Optional: the next_offset from a previous answer
unitid*
string
The institution's IPEDS UNITID, e.g. 225070
Input schema (JSON)
{
"type": "object",
"required": [
"unitid"
],
"properties": {
"limit": {
"type": "integer",
"description": "Optional page size (default 20, at most 100)"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
},
"unitid": {
"type": "string",
"description": "The institution's IPEDS UNITID, e.g. 225070"
}
}
}
find_checklists
Which checklists — the generic itinerary of requirements for an award — does this institution publish? Optional award words or a program id narrow them; pass one to get_checklist. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
limit
integer
Optional page size (default 20, at most 100)
query
string
Optional award words, e.g. welding
offset
integer
Optional: the next_offset from a previous answer
unitid*
string
The institution's IPEDS UNITID
program_id
string
Optional: one program's id
Input schema (JSON)
{
"type": "object",
"required": [
"unitid"
],
"properties": {
"limit": {
"type": "integer",
"description": "Optional page size (default 20, at most 100)"
},
"query": {
"type": "string",
"description": "Optional award words, e.g. welding"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
},
"unitid": {
"type": "string",
"examples": [
"225070"
],
"description": "The institution's IPEDS UNITID"
},
"program_id": {
"type": "string",
"description": "Optional: one program's id"
}
}
}
find_comparability
Which comparability bundles (published transfer rules) are held? Optional receiving institution UNITID, agreement id, a learning unit that appears as a source or substitute, bundle type, exam programme, or exam code. Answers none held when the build holds none. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
limit
integer
Optional page size (default 20, at most 100)
offset
integer
Optional: the next_offset from a previous answer
unitid
string
Optional: the receiving institution's IPEDS UNITID
exam_code
string
Optional: the exam code, case and spacing aside, e.g. AP 0300
bundle_type
string
Optional: the bundle type, case aside, e.g. ExamScore or CourseTransfer
agreement_id
find_institution
Which institution is this? A name fragment or an IPEDS UNITID answers with the institution's identity, sector, identifiers with their sources, and how many programs, checklists, and learning units its published catalog holds here. A state lists that state's institutions by name; with no name and no state, the answer is the states that hold institutions, each with its count. A web address answers the institution that publishes it, so a school named by its own site is identified without an IPEDS number in hand. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
city
string
Optional city, one of a state answer's cities, e.g. Denison
limit
integer
Optional page size (default 20, at most 100)
query
string
Name fragment or IPEDS UNITID, e.g. Denver or 127060
state
string
Optional two-letter state, e.g. TX: that state's institutions, those with a catalog held first; the answer lists the state's cities
find_my_best_pathway
What's my best way there? For a goal — a major or a job — and what the person brings (courses, exams, their Competency Selfie, work and life experience), the paths to it, each saying WHY it ranks where it does and naming the figures that moved it. The steps appear only where an agreement or pathway document states them, never assembled from award levels alone. Every item the person brought is marked counted, not counted or needs review and appears in the answer: nothing is dropped silently. A path missing an input is ranked with that gap named rather than penalised invisibly.
read-only
Argument
Type
Description
goal*
string
A major (a major_minor_id or CIP) or a job (a SOC code)
held
array
Optional: courses and exams, the shape will_my_credits_transfer takes
level*
string
The level the person wants
limit
integer
Optional page size (default 10, at most 25)
state
string
Optional two-letter state: where they are
package
object
Optional: the agent-held GoldRibbon package, read by suggest_credit_for_my_learning. GoldSeam stores no copy
Input schema (JSON)
find_my_major
What should I study? For a person's own words — an interest, a subject or a job — or a job code (SOC), the majors that answer. Each major carries its plain definition (NCES verbatim), the award levels it is conferred at (IPEDS AWLEVEL, each completers flag in its own field and never summed), how many schools offer it nationally, the jobs it leads to through the federal CIP-SOC crosswalk, and its related majors — same series, same family, or sharing a named occupation. Words resolve through the KSA Dictionary, never by spelling match; words that match nothing are told so with the closest words the Dictionary holds. The count for a person's own state is stated not held: the per-school IPEDS rows are not in this publish.
read-only
Argument
Type
Description
soc
string
Or a job code (SOC), e.g. 29-1141 for Registered Nurses; every major the federal crosswalk ties to it answers
level
string
Optional award level to narrow to, e.g. certificate, associate or bachelor's
limit
integer
Optional page size (default 10, at most 25)
state
string
Optional two-letter state, for the school counts
words
string
The person's own words: an interest, a subject, or a job, e.g. I like fixing things
offset
integer
Optional: the offset of the next page
find_my_school
Where can I study this? A match-up, not a dump: for a major and a level, the schools that award it, ranked by how many of the person's own criteria each one meets, with met, not met and not testable kept as three different results — a school that does not publish a fact is not testable on it, never failed. Each criterion names the source that decided it, each school carries its own program, award, credits required, cost, earnings, debt and whether it can be done online, and a filter only ever excludes on a fact we hold. The answer states its ranking rule and never recommends a school. TODAY the candidate set is the schools CourseShelf has captured a program for, not yet every school IPEDS lists, and every answer opens by saying so.
read-only
Argument
Type
Description
city
string
Optional city
near
string
Optional: a place and a distance, e.g. Casper WY within 50 miles
award
string
Optional award title or credential class
level*
string
The credential level, e.g. certificate, associate or bachelor's
limit
integer
Optional page size (default 10, at most 25)
major*
string
The major: a major_minor_id (e.g. CIP:51.3801) or a CIP code
find_pathways
Which pathways are held? Optional title words, an agreement id, or a checklist id. Answers none held when the build holds none. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
limit
integer
Optional page size (default 20, at most 100)
query
string
Optional pathway title words
offset
integer
Optional: the next_offset from a previous answer
agreement_id
string
Optional: the agreement a pathway rests on
checklist_id
string
Optional: the checklist a pathway follows
Input schema (JSON)
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Optional page size (default 20, at most 100)"
},
"query": {
"type": "string",
"description": "Optional pathway title words"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
},
"agreement_id": {
"type": "string",
"description": "Optional: the agreement a pathway rests on"
},
"checklist_id": {
"type": "string",
"description": "Optional: the checklist a pathway follows"
}
}
}
find_policies
Which academic policies does this institution publish (transfer credit, prior learning, tuition and fees …)? Optional words narrow them. Answers none held when the build holds none. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
limit
integer
Optional page size (default 20, at most 100)
query
string
Optional policy words, e.g. transfer
offset
integer
Optional: the next_offset from a previous answer
unitid*
string
The institution's IPEDS UNITID, e.g. 225070
Input schema (JSON)
{
"type": "object",
"required": [
"unitid"
],
"properties": {
"limit": {
"type": "integer",
"description": "Optional page size (default 20, at most 100)"
},
"query": {
"type": "string",
"description": "Optional policy words, e.g. transfer"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
},
"unitid": {
"type": "string",
"description": "The institution's IPEDS UNITID, e.g. 225070"
}
}
}
find_programs
Which programs match these words, across institutions? Program or award words (optionally one institution's UNITID) answer with each program's award, CIP, published credit figure verbatim, edition, source page and institution. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
city
string
Optional city: programs at that city's institutions
limit
integer
Optional page size (default 20, at most 100)
query*
string
Program or award words, e.g. welding or nursing
state
string
Optional two-letter state: programs at that state's institutions
offset
integer
Optional: the next_offset from a previous answer
unitid
string
find_transfer_frameworks
Which statewide or compact transfer frameworks are held? Optional name or jurisdiction words. Answers none held when the build holds none. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
limit
integer
Optional page size (default 20, at most 100)
query
string
Optional framework name or jurisdiction words
offset
integer
Optional: the next_offset from a previous answer
Input schema (JSON)
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Optional page size (default 20, at most 100)"
},
"query": {
"type": "string",
"description": "Optional framework name or jurisdiction words"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
}
}
}
find_transitions
Where can this occupation lead? For a SOC code: destination occupations, each with its typed roads (published by O*NET or by a credential serving both; mapped through the CIP-SOC crosswalk), each road with its source, basis and its class's karat; the bridges (credentials with their exam, education and experience conditions, and programs with checklists nearest the state given); and demand as O*NET publishes it. Roads only, no person data.
read-only
Argument
Type
Description
from
string
Or the job in everyday words, e.g. welder; several matching occupations answer candidates to pick from
class
string
Optional: only destinations with a road of this class (published, mapped)
limit
integer
Optional page size (default 10, at most 25)
state
string
Optional two-letter state for the program bridges
offset
integer
Optional: the next_offset from a previous answer
prefer
string
Optional preference such as less physical; answered not held when O*NET work context is not held
from_soc
string
The occupation's SOC code, e.g. 51-4121 (an O*NET .00 code is accepted)
get_agreement
One agreement: its row, its parties (organizations resolved), and the pathways, comparability bundles and checklists that cite it. Signatories name people and are not served. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
One catalog edition: its row, the institutions that use it (and whom it is shared from), and how many programs it holds. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
catalog_id*
string
A catalog id from find_catalogs
Input schema (JSON)
{
"type": "object",
"required": [
"catalog_id"
],
"properties": {
"catalog_id": {
"type": "string",
"description": "A catalog id from find_catalogs"
}
}
}
get_certification
Everything held about one certification: issuer and issuer domain, occupations served, exam and renewal requirements, education-or-experience routes, Credential Engine registry identity where held, and the basis and source URL for the claim.
read-only
Argument
Type
Description
id*
string
A certification id, copied from a search result's id field
Input schema (JSON)
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"examples": [
"LU_CERT_ONET_13108200_8F3480AC7A"
],
"description": "A certification id, copied from a search result's id field"
}
}
}
get_checklist
What does this award require? One checklist: its requirement groups (every header and full item count), each group's items with published credit strings, alternatives, and — where an item resolved to a course — that course's own code, title, and published credits, attributed to the course. Items come in pages across the groups; the answer states items_total and next_item_offset. Every row names the captured page it came from. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
item_limit
integer
Optional items per page (default 60, at most 150)
item_offset
integer
Optional: the next_item_offset from a previous answer
checklist_id*
string
A checklist id from programs_for_institution or compare_program_checklists
Input schema (JSON)
{
"type": "object",
"required": [
"checklist_id"
],
"properties": {
"item_limit": {
"type": "integer",
"description": "Optional items per page (default 60, at most 150)"
},
"item_offset": {
"type": "integer",
"description": "Optional: the next_item_offset from a previous answer"
},
"checklist_id": {
"type": "string",
"examples": [
"CK_225070_05e6e123"
],
"description": "A checklist id from programs_for_institution or compare_program_checklists"
}
}
}
get_comparability
One comparability bundle: its row (credits awarded published beside any parse), the receiving institution, and its source and substitute courses, each resolved or stated unresolved. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
comparability_id*
string
A comparability id from find_comparability
Input schema (JSON)
{
"type": "object",
"required": [
"comparability_id"
],
"properties": {
"comparability_id": {
"type": "string",
"description": "A comparability id from find_comparability"
}
}
}
get_courseshelf_performance
How did calls to the CourseShelf box perform? From the box's call log: each call that reached the box, newest first, with its time (at), tool, outcome (answered; stopped by a budget; busy, queue full or wait expired; invalid_params; error; not_pinned), ms from the slot being taken to the answer, the build that answered, and the stated cause where there is one; per tool, the count of each outcome; and the log files read. Also returns effective INI settings and the pinned database's page size, page count and free-list pages. Request storage_details for the largest table/index objects from SQLite dbstat, within the query budget. These are storage measures, not compaction-savings estimates or RAM measurements. Arguments are logged for the catalog services only. An empty log window is said so.
read-only
Argument
Type
Description
to
string
Optional ISO time the window ends (default now)
from
string
Optional ISO time the window starts (default 24 hours before 'to')
tool
string
Optional: only the calls of this tool
limit
integer
Optional call page size (default 200); also limits storage objects to at most the default page size. The answer-size budget may trim either list further and says so
min_ms
integer
Optional: only the calls that took at least this many ms
outcome
string
get_courseshelf_summary
What does CourseShelf hold? From the records published with the build, read as published and never computed: per catalog area, how many institutions have loaded content and how many records were loaded; every table's row count; organizations by sector; the census of the whole index with its verdicts; and per-state counts and per-school verdicts where the build publishes them. Anything not published for this build is said so. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
No arguments.
Input schema (JSON)
{
"type": "object",
"properties": {}
}
get_dictionary_summary
What does the KSA Dictionary hold? The words and meanings it places, the governed terms, the O*NET content-model elements, the link words and the CIP-SOC crosswalk, each with its own version and build date where the layer publishes one, and an honest not held where it does not. Read as published at boot, never computed at request time, and never a word lookup: for one word use resolve_term. The words it holds are those it places; it is not all of WordNet, and the answer says so.
read-only
No arguments.
Input schema (JSON)
{
"type": "object",
"properties": {}
}
get_institution
Everything held about one institution: its identity row, identifiers, addresses, websites, accreditations, relationships, identity history, published costs and calendar dates, each table under its own name, with counts of its programs, courses, checklists, catalogs, policies and agreements and the service that lists each. Contacts name people and are not served. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
unitid
string
Or its IPEDS UNITID instead, e.g. 225070
organization_id
string
The institution's organization id from find_institution, e.g. ORG_225070
Input schema (JSON)
{
"type": "object",
"anyOf": [
{
"required": [
"organization_id"
]
},
{
"required": [
"unitid"
]
}
],
"properties": {
"unitid": {
"type": "string",
"description": "Or its IPEDS UNITID instead, e.g. 225070"
},
"organization_id": {
"type": "string",
"examples": [
"ORG_225070"
],
"description": "The institution's organization id from find_institution, e.g. ORG_225070"
}
}
}
get_learning_unit
One course whole: its row, prerequisites and corequisites, aliases, terms offered, articulation statements and comparable members — each linked course resolved or stated unresolved, never guessed — plus the transfer frameworks it maps to. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
learning_unit_id*
string
A learning unit id from learning_units or get_checklist
Input schema (JSON)
{
"type": "object",
"required": [
"learning_unit_id"
],
"properties": {
"learning_unit_id": {
"type": "string",
"examples": [
"LU_course_225070_ENGL1301_20262027"
],
"description": "A learning unit id from learning_units or get_checklist"
}
}
}
get_pathway
One pathway: its row and the checklist and agreement it links. Contacts name people and are not served. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
pathway_id*
string
A pathway id from find_pathways
Input schema (JSON)
{
"type": "object",
"required": [
"pathway_id"
],
"properties": {
"pathway_id": {
"type": "string",
"description": "A pathway id from find_pathways"
}
}
}
get_persona_transcript
One example persona's transcript, parsed now by assemble_my_formal_education: `held` (the course list will_my_credits_transfer, checklist_map and comparable_map take, unchanged), `courses` (each course as read: school and IPEDS UNITID where it resolved, code, title, credits, grade and term; exams with their scores) and `package` (for suggest_credit_for_my_learning). Official and unofficial read the same transcript, labelled: official stands in for a transcript vendor request, unofficial for importing unofficial coursework. `vendor_delay_ms`, official only, waits that long first to show an official request may not come back at once; the wait counts against the call's time. The answer says plainly it is an example persona transcript, and carries its steps: the persona file, any vendor wait, and the parse, each with its outcome, count, elapsed ms and files.
read-only
Argument
Type
Description
persona_id*
string
A persona_id from list_persona_transcripts
transcript_type
string
Which transcript to read; unofficial when omitted
vendor_delay_ms
integer
Official only: milliseconds to wait first, imitating a slow transcript vendor
One published academic policy: its section, verbatim text, page, edition and source. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
policy_id*
string
A policy id from find_policies
Input schema (JSON)
{
"type": "object",
"required": [
"policy_id"
],
"properties": {
"policy_id": {
"type": "string",
"description": "A policy id from find_policies"
}
}
}
get_program
One program whole: its row, identifiers, offerings (campus resolved), its institution, and the checklists that lead to its award — pass one to get_checklist. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
program_id*
string
A program id from programs_for_institution or find_programs
Input schema (JSON)
{
"type": "object",
"required": [
"program_id"
],
"properties": {
"program_id": {
"type": "string",
"examples": [
"PG_225070_8c96bb26"
],
"description": "A program id from programs_for_institution or find_programs"
}
}
}
get_transfer_framework
One transfer framework: its row, authority, codes with their meanings, and the courses mapped to it (resolved). Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
framework_id*
string
A framework id from find_transfer_frameworks
Input schema (JSON)
{
"type": "object",
"required": [
"framework_id"
],
"properties": {
"framework_id": {
"type": "string",
"description": "A framework id from find_transfer_frameworks"
}
}
}
learning_units
What courses does this institution publish? Filter by subject abbreviation, course code (spaces and case ignored), or title words; each course carries its published credit string verbatim (ranges stay ranges), edition, and the captured page. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
code
string
Optional course code, e.g. BIO 201
limit
integer
Optional page size (default 50, at most 100)
query
string
Optional title words
offset
integer
Optional: the next_offset from a previous answer
unitid*
string
The institution's IPEDS UNITID
subject
string
Optional subject abbreviation, e.g. BIO
list_issuers
The issuing organizations, optionally filtered by a name query.
read-only
Argument
Type
Description
limit
integer
Optional page size (default 20, at most 50)
query
string
Optional: part of an organization's name
offset
integer
Optional: the next_offset from a previous answer
Input schema (JSON)
{
"type": "object",
"required": [],
"properties": {
"limit": {
"type": "integer",
"description": "Optional page size (default 20, at most 50)"
},
"query": {
"type": "string",
"examples": [
"IBM",
"nursing"
],
"description": "Optional: part of an organization's name"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
}
}
}
list_persona_transcripts
The example personas whose transcripts can be used in a demonstration: each persona_id, display name and description, the schools its transcript comes from, and the transcript types it offers (official, unofficial). These are example persona transcripts of made-up people, not real students. Every answer carries its steps: the source files read, the outcome, count and elapsed ms.
read-only
No arguments.
Input schema (JSON)
{
"type": "object",
"properties": {}
}
my_selfie_ksa_view
The person's Selfie from their evidence package: the seven dimensions (skills, knowledge, abilities and more) as the evidence shows them, each item citing the file, the occupation O*NET describes, or the life experience it came from, plus what could not be placed. It mirrors, for the person to confirm, refine or reject; it is never a grade or a credit decision. The person's placements and dismissals in the package's selfie.learner_decisions are honored. Nothing is stored: the answer returns the package with the Selfie for the agent to keep.
read-only
Argument
Type
Description
package*
object
The goldribbon_package_v1 object an earlier GoldRibbon answer returned. Keep it for the person and send it back whole; GoldSeam keeps no copy.
language
string
aspiration
string
Optional: what the person is aiming for
Input schema (JSON)
{
"type": "object",
"required": [
"package"
],
"properties": {
"package": {
"type": "object",
"description": "The goldribbon_package_v1 object an earlier GoldRibbon answer returned. Keep it for the person and send it back whole; GoldSeam keeps no copy."
},
"language": {
"enum": [
"en",
"es",
"fr"
],
"type": "string"
},
"aspiration": {
"type": "string",
"description": "Optional: what the person is aiming for"
}
}
}
occupations_for_certification
What occupations does this certification serve?
read-only
Argument
Type
Description
id*
string
A certification id, copied from a search result's id field
limit
integer
Optional page size (default 20, at most 50)
offset
integer
Optional: the next_offset from a previous answer
Input schema (JSON)
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"examples": [
"LU_CERT_ONET_13108200_8F3480AC7A"
],
"description": "A certification id, copied from a search result's id field"
},
"limit": {
"type": "integer",
"description": "Optional page size (default 20, at most 50)"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
}
}
}
programs_for_institution
What programs does this institution publish? Award, credential class, CIP, the published credit figure verbatim, catalog edition, the captured page each came from, and the checklist ids to pass to get_checklist. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
limit
integer
Optional page size (default 100, at most 200)
query
string
Optional program or award words to filter by
offset
integer
Optional: the next_offset from a previous answer
unitid*
string
The institution's IPEDS UNITID
Input schema (JSON)
{
"type": "object",
"required": [
"unitid"
],
"properties": {
"limit": {
"type": "integer",
"description": "Optional page size (default 100, at most 200)"
},
"query": {
"type": "string",
"description": "Optional program or award words to filter by"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
},
"unitid": {
"type": "string",
"examples": [
"225070"
],
"description": "The institution's IPEDS UNITID"
}
}
}
related_certifications
What else serves the same occupation? Traverses on SOC only — a certification sharing solely an instructional program (CIP) is not related (contract § 4).
read-only
Argument
Type
Description
id*
string
A certification id to find others like it, copied from a search result's id field
limit
integer
Optional page size (default 20, at most 50)
offset
integer
Optional: the next_offset from a previous answer
Input schema (JSON)
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"examples": [
"LU_CERT_ONET_29114100_50CD2891D4"
],
"description": "A certification id to find others like it, copied from a search result's id field"
},
"limit": {
"type": "integer",
"description": "Optional page size (default 20, at most 50)"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
}
}
}
resolve_term
Where does a word place in the KSA model? The KSA Dictionary is the shared vocabulary that defines the terms a learner uses to assert what they know, do, and are — and the terms a learning offering uses to express what it comprises — so both sides resolve to the same identifiers, never spelling matches. Answers from three linked layers (governed lexicon, O*NET content model, WordNet-derived index), each placement attributed to its layer with provenance; the WordNet placement carries the word's definition (gloss) and synonyms.
read-only
Argument
Type
Description
term*
string
A word for something a person knows or can do, e.g. carpentry or mathematics
Input schema (JSON)
{
"type": "object",
"required": [
"term"
],
"properties": {
"term": {
"type": "string",
"examples": [
"carpentry",
"mathematics",
"welding"
],
"description": "A word for something a person knows or can do, e.g. carpentry or mathematics"
}
}
}
search_certifications
Which certification is this prose name? Start here for any plain question — a trade, field, job, skill, or company in everyday words. Returns candidates with ids, issuers, and source basis — candidates rather than a single guess when the name is ambiguous; the ids feed the other certification tools.
read-only
Argument
Type
Description
limit
integer
Optional page size (default 20, at most 50)
query*
string
What you are looking for, in everyday words — a trade, field, job, or company
issuer
string
Optional: only certifications from this organization
offset
integer
Optional: the next_offset from a previous answer
Input schema (JSON)
{
"type": "object",
"required": [
"query"
],
"properties": {
"limit": {
"type": "integer",
"description": "Optional page size (default 20, at most 50)"
},
"query": {
"type": "string",
"examples": [
"nursing",
"HVAC",
"welding",
"IBM",
"project management"
],
"description": "What you are looking for, in everyday words — a trade, field, job, or company"
},
"issuer": {
"type": "string",
"description": "Optional: only certifications from this organization"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
}
}
}
search_programs_and_learning_units
Which programs or courses match, and where? Words, a subject (CIP family, or unknown), a course subject prefix, a credential class, an award as published, and a school's state, city, type or UNITID answer with product cards (name, award, length and college when held, school and city, subject, checklist size, and what the program leads to through the CIP-SOC crosswalk) and the counts to refine by. Courses across every school need words of 3 or more characters; words held by very many courses need a state, city or school. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
cip
any
Optional: programs with this six-digit CIP code (e.g. 48.0508), a comma-separated list, or an array of codes
city
string
Optional city, one of a state answer's cities
code
string
Optional, courses only: a course code as printed, e.g. ZOO 2015; lists that code at every school, or within the state, city or school given
type
string
suggest_credit_for_my_learning
Where is a person in the program they are aiming for, and what may their learning meet? Name the program with `checklist_id` (find it with find_programs at that school) and the answer is that program's checklist line by line: the lines their claims may meet, each with the claim, how well it is corroborated and every link cited; the lines a transfer answer in their package already covers; and the lines still needed. Learning no line matches stands as block credit. Without a program, no course is suggested and the claims stand as block credit. Each suggestion is a case to put to the school's prior learning review, never a promise: say may, never will. Nothing is stored: the answer returns the package with the suggestions for the agent to keep.
read-only
Argument
Type
Description
package*
object
The goldribbon_package_v1 object an earlier GoldRibbon answer returned. Keep it for the person and send it back whole; GoldSeam keeps no copy.
language
string
aspiration
string
Optional: what the person is aiming for
checklist_id
string
The program the person is aiming for, from find_programs or find_checklists at that school. Its lines are the only courses considered; without it no course is suggested.
target_unitid*
string
The school's IPEDS UNITID, e.g. 240620
will_my_credits_transfer
Will my prior credits apply as credit at my target school? For each thing a person holds (an exam and its score, in any exam programme this build holds, or a course taken at a school) the target school's own published transfer rules (CourseAtlas) and CollegeBoard's reported AP policy, in three states: covered (a rule carries it to a course at the target), missing (the target's own rule needs a higher score), unknown (no rule held; never a guess). Each covered item names the course it lands as, every rule with its minimum score and dates, how many rules agree, and the target's programs whose checklists require that course. An exam is identified by its exam node (its programme and code), whatever its wording: a matched exam names its `exam_node`, and an exam that fits none, or more than one, comes back unknown with `candidates` to choose from, never a guess. A case to argue, not a verdict; recognition is the school's act. Each row names its current FORM's wording source: source_url, capture_file, catalog_year and source_catalog_name are that one source's, never the record's whole span. A row whose record holds more than one form or more than one source also carries version_count, source_count, first_edition_seen and last_edition_seen, and one sentence saying so in words; a record with one form and one source carries none of them and reads exactly as it always has. The forms themselves, each with its own content and its own sources, come from the one-record get, never from a list. A record last seen in an older edition says so, because the Union keeps a record no current catalog prints.
read-only
Argument
Type
Description
held*
array
1 to 20 things held: an exam { program: any exam programme this build holds (e.g. AP, CLEP, IB), exam: its code (e.g. AP 3700) or title (e.g. United States History), score }, or a course { unitid or school, code as printed (e.g. HIS 110) }
checklist_id
string
Set by `continue.arguments`: the map's progress so far, sent back unchanged
package
object
Optional: the person's GoldRibbon package; its prior learning is read on the first call for the lines it may meet
checklist
string
The checklist's name or title at the target (its award title), e.g. Nursing BSN; several fitting are listed, never guessed
held_offset
integer
Set by `continue.arguments`: the held item to start this call's 5 from
checklist_id
string
Or the checklist's id, from find_checklists
target_unitid*
string
The school whose checklist is mapped, by IPEDS UNITID, e.g. 240727
Input schema (JSON)
{
"type": "object",
"required": [
"target_unitid"
],
"properties": {
"held": {
"type": "array",
"items": {
"type": "object"
},
"description": "0 to 20 things held, each as comparable_map takes one: a course { unitid, code }, an exam { program, exam, score }, { learning_unit_id } or { certification_ctid }. Compared 5 per call: an answer with more to compare carries `continue.arguments` to send back as they are"
},
"carried": {
"type": "object",
"description": "Set by `continue.arguments`: the map's progress so far, sent back unchanged"
},
"package": {
"type": "object",
"description": "Optional: the person's GoldRibbon package; its prior learning is read on the first call for the lines it may meet"
},
"checklist": {
"type": "string",
"description": "The checklist's name or title at the target (its award title), e.g. Nursing BSN; several fitting are listed, never guessed"
},
"held_offset": {
"type": "integer",
"description": "Set by `continue.arguments`: the held item to start this call's 5 from"
},
"checklist_id": {
"type": "string",
"examples": [
"CK_225070_05e6e123"
],
"description": "Or the checklist's id, from find_checklists"
},
"target_unitid": {
"type": "string",
"examples": [
"240727"
],
"description": "The school whose checklist is mapped, by IPEDS UNITID, e.g. 240727"
}
}
}
*
string
The receiving school, by IPEDS UNITID
Input schema (JSON)
{
"type": "object",
"required": [
"target_unitid",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The course code as printed, e.g. HIST 201"
},
"exam": {
"type": "string",
"examples": [
"AP Psychology"
],
"description": "For an exam: the exam as printed, by title or code"
},
"title": {
"type": "string",
"description": "Or: the course title, matched exactly"
},
"school": {
"type": "string",
"description": "Or: the course's school, by name"
},
"unitid": {
"type": "string",
"description": "The course's school, by IPEDS UNITID"
},
"item_id": {
"type": "string",
"description": "Optional: the caller's own id for this item, echoed back; the position is used when absent"
},
"exam_program": {
"type": "string",
"examples": [
"AP"
],
"description": "For an exam: its program, e.g. AP"
}
}
},
"description": "What was taken: each item a course (its school by unitid or name, with code or title) or an exam (exam_program with exam). At most 60 in one call."
},
"limit": {
"type": "integer",
"description": "Optional page size per item's rules (default 10, at most 50)"
},
"target_unitid": {
"type": "string",
"examples": [
"151263"
],
"description": "The receiving school, by IPEDS UNITID"
}
}
}
unitid
string
Or: the course's school, by IPEDS UNITID (with code or title)
direction
string
lands_as: where it lands; lands_on: what lands on it; both (default)
target_unitid
string
Optional: narrow where it lands to one receiving school (IPEDS UNITID)
learning_unit_id
string
The course, by its learning unit id
Input schema (JSON)
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The course code as printed, e.g. HIST 201"
},
"limit": {
"type": "integer",
"description": "Optional page size per list (default 10, at most 50)"
},
"title": {
"type": "string",
"description": "Or: the course title, matched exactly"
},
"offset": {
"type": "integer",
"description": "Optional: the offset of the next page"
},
"school": {
"type": "string",
"description": "Or: the course's school, by name (with code or title)"
},
"unitid": {
"type": "string",
"description": "Or: the course's school, by IPEDS UNITID (with code or title)"
},
"direction": {
"enum": [
"lands_as",
"lands_on",
"both"
],
"type": "string",
"description": "lands_as: where it lands; lands_on: what lands on it; both (default)"
},
"target_unitid": {
"type": "string",
"description": "Optional: narrow where it lands to one receiving school (IPEDS UNITID)"
},
"learning_unit_id": {
"type": "string",
"description": "The course, by its learning unit id"
}
}
}
depth
integer
Optional: the most published links an inferred path may take, 1 to 3 (default 2)
target_unitid*
string
The school to compare with, any school, by IPEDS UNITID, e.g. 240727
courseatlas_depth
integer
Optional: CourseAtlas's chain depth, 1 to 3 (default 2, the transfer map's own)
Input schema (JSON)
{
"type": "object",
"required": [
"target_unitid",
"item"
],
"properties": {
"item": {
"type": "object",
"examples": [
{
"exam": "Biology",
"score": "4",
"program": "AP"
},
{
"code": "BIOL 100",
"unitid": "216038"
}
],
"description": "One learning unit: a course { unitid, code as printed (e.g. BIOL 100) }, an exam { program (e.g. AP), exam (its code or title), score }, { learning_unit_id }, or { certification_ctid }"
},
"depth": {
"type": "integer",
"description": "Optional: the most published links an inferred path may take, 1 to 3 (default 2)"
},
"target_unitid": {
"type": "string",
"examples": [
"240727"
],
"description": "The school to compare with, any school, by IPEDS UNITID, e.g. 240727"
},
"courseatlas_depth": {
"type": "integer",
"description": "Optional: CourseAtlas's chain depth, 1 to 3 (default 2, the transfer map's own)"
}
}
}
{
"type": "object",
"required": [
"unitids",
"major",
"level"
],
"properties": {
"held": {
"type": "array",
"items": {
"type": "object"
},
"description": "Optional: the same shape will_my_credits_transfer takes — an exam { program, exam, score } or a course { unitid or school, code }"
},
"level": {
"type": "string",
"description": "The credential level"
},
"major": {
"type": "string",
"description": "The major: a major_minor_id or a CIP code"
},
"package": {
"type": "object",
"description": "Optional: the agent-held GoldRibbon package. GoldSeam stores no copy of it"
},
"unitids": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"240505",
"240628"
]
],
"description": "2 to 5 schools, by IPEDS UNITID"
}
}
}
integer
Optional: the next_institution_offset from a previous answer, for the next 5 institutions
Input schema (JSON)
{
"type": "object",
"required": [
"unitids",
"program"
],
"properties": {
"detail": {
"type": "string",
"examples": [
"summary"
],
"description": "Optional: full (the default: every requirement group and item) or summary (per checklist its program, award, year, credits and group and item counts, with each school's College Scorecard tuition)"
},
"program": {
"type": "string",
"examples": [
"Welding"
],
"description": "Program or award words to match, e.g. nursing or Bachelor of Science in Nursing"
},
"unitids": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"225070"
]
],
"description": "1 to 10 IPEDS UNITIDs, e.g. [\"100663\", \"127060\"]; answered 5 institutions per call, up to 3 checklists each"
},
"institution_offset": {
"type": "integer",
"description": "Optional: the next_institution_offset from a previous answer, for the next 5 institutions"
}
}
}
string
Optional: the agreement that states it
exam_program
string
Optional: the exam programme, case aside, e.g. AP
learning_unit_id
string
Optional: a course named in it
Input schema (JSON)
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Optional page size (default 20, at most 100)"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
},
"unitid": {
"type": "string",
"description": "Optional: the receiving institution's IPEDS UNITID"
},
"exam_code": {
"type": "string",
"description": "Optional: the exam code, case and spacing aside, e.g. AP 0300"
},
"bundle_type": {
"type": "string",
"description": "Optional: the bundle type, case aside, e.g. ExamScore or CourseTransfer"
},
"agreement_id": {
"type": "string",
"description": "Optional: the agreement that states it"
},
"exam_program": {
"type": "string",
"description": "Optional: the exam programme, case aside, e.g. AP"
},
"learning_unit_id": {
"type": "string",
"description": "Optional: a course named in it"
}
}
}
domain
string
Optional: the institution's own web address, matched against the addresses it publishes, e.g. uindy.edu
offset
integer
Optional: the next_offset from a previous answer
Input schema (JSON)
{
"type": "object",
"properties": {
"city": {
"type": "string",
"examples": [
"Denison"
],
"description": "Optional city, one of a state answer's cities, e.g. Denison"
},
"limit": {
"type": "integer",
"description": "Optional page size (default 20, at most 100)"
},
"query": {
"type": "string",
"examples": [
"Grayson",
"225070"
],
"description": "Name fragment or IPEDS UNITID, e.g. Denver or 127060"
},
"state": {
"type": "string",
"examples": [
"TX"
],
"description": "Optional two-letter state, e.g. TX: that state's institutions, those with a catalog held first; the answer lists the state's cities"
},
"domain": {
"type": "string",
"examples": [
"uindy.edu"
],
"description": "Optional: the institution's own web address, matched against the addresses it publishes, e.g. uindy.edu"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
}
}
}
{
"type": "object",
"required": [
"goal",
"level"
],
"properties": {
"goal": {
"type": "string",
"examples": [
"29-1141"
],
"description": "A major (a major_minor_id or CIP) or a job (a SOC code)"
},
"held": {
"type": "array",
"items": {
"type": "object"
},
"description": "Optional: courses and exams, the shape will_my_credits_transfer takes"
},
"level": {
"type": "string",
"description": "The level the person wants"
},
"limit": {
"type": "integer",
"description": "Optional page size (default 10, at most 25)"
},
"state": {
"type": "string",
"description": "Optional two-letter state: where they are"
},
"package": {
"type": "object",
"description": "Optional: the agent-held GoldRibbon package, read by suggest_credit_for_my_learning. GoldSeam stores no copy"
}
}
}
Input schema (JSON)
{
"type": "object",
"anyOf": [
{
"required": [
"words"
]
},
{
"required": [
"soc"
]
}
],
"properties": {
"soc": {
"type": "string",
"examples": [
"29-1141"
],
"description": "Or a job code (SOC), e.g. 29-1141 for Registered Nurses; every major the federal crosswalk ties to it answers"
},
"level": {
"type": "string",
"description": "Optional award level to narrow to, e.g. certificate, associate or bachelor's"
},
"limit": {
"type": "integer",
"description": "Optional page size (default 10, at most 25)"
},
"state": {
"type": "string",
"description": "Optional two-letter state, for the school counts"
},
"words": {
"type": "string",
"examples": [
"carpentry"
],
"description": "The person's own words: an interest, a subject, or a job, e.g. I like fixing things"
},
"offset": {
"type": "integer",
"description": "Optional: the offset of the next page"
}
}
}
state
string
Optional two-letter state. With no state, city or place the answer is national and says so
offset
integer
Optional: the offset of the next page
sector
string
Optional school type as IPEDS labels it, e.g. public 2-year
cost_max
number
Optional: the most the person will pay. A school that publishes no cost is not removed by it — it is ranked below and marked not testable on cost
delivery
string
Optional: in person, hybrid or online
also_offers
array
Optional other subjects or majors the school should also offer
with_checklist
boolean
Optional: only schools whose requirements CourseShelf holds
exclude_untestable
boolean
Optional strict exclusion, off by default: remove schools that do not publish one of the criteria. The answer then says how many were removed and by which criterion
Input schema (JSON)
{
"type": "object",
"required": [
"major",
"level"
],
"properties": {
"city": {
"type": "string",
"description": "Optional city"
},
"near": {
"type": "string",
"description": "Optional: a place and a distance, e.g. Casper WY within 50 miles"
},
"award": {
"type": "string",
"description": "Optional award title or credential class"
},
"level": {
"type": "string",
"examples": [
"associate"
],
"description": "The credential level, e.g. certificate, associate or bachelor's"
},
"limit": {
"type": "integer",
"description": "Optional page size (default 10, at most 25)"
},
"major": {
"type": "string",
"examples": [
"CIP:51.3801"
],
"description": "The major: a major_minor_id (e.g. CIP:51.3801) or a CIP code"
},
"state": {
"type": "string",
"description": "Optional two-letter state. With no state, city or place the answer is national and says so"
},
"offset": {
"type": "integer",
"description": "Optional: the offset of the next page"
},
"sector": {
"type": "string",
"description": "Optional school type as IPEDS labels it, e.g. public 2-year"
},
"cost_max": {
"type": "number",
"description": "Optional: the most the person will pay. A school that publishes no cost is not removed by it — it is ranked below and marked not testable on cost"
},
"delivery": {
"type": "string",
"description": "Optional: in person, hybrid or online"
},
"also_offers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional other subjects or majors the school should also offer"
},
"with_checklist": {
"type": "boolean",
"description": "Optional: only schools whose requirements CourseShelf holds"
},
"exclude_untestable": {
"type": "boolean",
"description": "Optional strict exclusion, off by default: remove schools that do not publish one of the criteria. The answer then says how many were removed and by which criterion"
}
}
}
Optional: one institution's IPEDS UNITID
Input schema (JSON)
{
"type": "object",
"required": [
"query"
],
"properties": {
"city": {
"type": "string",
"description": "Optional city: programs at that city's institutions"
},
"limit": {
"type": "integer",
"description": "Optional page size (default 20, at most 100)"
},
"query": {
"type": "string",
"examples": [
"Welding"
],
"description": "Program or award words, e.g. welding or nursing"
},
"state": {
"type": "string",
"description": "Optional two-letter state: programs at that state's institutions"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
},
"unitid": {
"type": "string",
"description": "Optional: one institution's IPEDS UNITID"
}
}
}
Input schema (JSON)
{
"type": "object",
"anyOf": [
{
"required": [
"from_soc"
]
},
{
"required": [
"from"
]
}
],
"properties": {
"from": {
"type": "string",
"description": "Or the job in everyday words, e.g. welder; several matching occupations answer candidates to pick from"
},
"class": {
"type": "string",
"description": "Optional: only destinations with a road of this class (published, mapped)"
},
"limit": {
"type": "integer",
"description": "Optional page size (default 10, at most 25)"
},
"state": {
"type": "string",
"description": "Optional two-letter state for the program bridges"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
},
"prefer": {
"type": "string",
"description": "Optional preference such as less physical; answered not held when O*NET work context is not held"
},
"from_soc": {
"type": "string",
"examples": [
"51-4121"
],
"description": "The occupation's SOC code, e.g. 51-4121 (an O*NET .00 code is accepted)"
}
}
}
Optional: only the calls with this outcome
storage_details
boolean
Optional, default false: read the largest table/index objects from SQLite dbstat, showing allocated, payload and unused-within-pages bytes. This can scan the artifact; it runs only on request under the existing query budget. An unavailable breakdown is stated, never reported as zero.
Input schema (JSON)
{
"type": "object",
"properties": {
"to": {
"type": "string",
"description": "Optional ISO time the window ends (default now)"
},
"from": {
"type": "string",
"examples": [
"2026-10-21T00:00:00Z"
],
"description": "Optional ISO time the window starts (default 24 hours before 'to')"
},
"tool": {
"type": "string",
"examples": [
"search_programs_and_learning_units"
],
"description": "Optional: only the calls of this tool"
},
"limit": {
"type": "integer",
"description": "Optional call page size (default 200); also limits storage objects to at most the default page size. The answer-size budget may trim either list further and says so"
},
"min_ms": {
"type": "integer",
"description": "Optional: only the calls that took at least this many ms"
},
"outcome": {
"enum": [
"answered",
"stopped",
"busy",
"invalid_params",
"error",
"not_pinned"
],
"type": "string",
"description": "Optional: only the calls with this outcome"
},
"storage_details": {
"type": "boolean",
"description": "Optional, default false: read the largest table/index objects from SQLite dbstat, showing allocated, payload and unused-within-pages bytes. This can scan the artifact; it runs only on request under the existing query budget. An unavailable breakdown is stated, never reported as zero."
}
}
}
unit_type
string
Optional learning-unit type, one of the answer's unit_types, e.g. course
Input schema (JSON)
{
"type": "object",
"required": [
"unitid"
],
"properties": {
"code": {
"type": "string",
"description": "Optional course code, e.g. BIO 201"
},
"limit": {
"type": "integer",
"description": "Optional page size (default 50, at most 100)"
},
"query": {
"type": "string",
"description": "Optional title words"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
},
"unitid": {
"type": "string",
"examples": [
"225070"
],
"description": "The institution's IPEDS UNITID"
},
"subject": {
"type": "string",
"examples": [
"RNSG"
],
"description": "Optional subject abbreviation, e.g. BIO"
},
"unit_type": {
"type": "string",
"description": "Optional learning-unit type, one of the answer's unit_types, e.g. course"
}
}
}
program (the default) or learning_unit
award
string
Optional award exactly as published, one of the answer's awards
limit
integer
Optional page size (default 10, at most 50)
place
string
Optional: a place the question names, read as a state (name or code), a city, or a school, e.g. Wyoming or Casper
query
string
Words: a program's name or award, or a course's title
state
string
Optional two-letter state
offset
integer
Optional: the next_offset from a previous answer
sector
string
Optional school type as IPEDS labels it, e.g. public 2-year
unitid
string
Optional: one school's IPEDS UNITID
subject
string
Optional CIP family (two digits, e.g. 51) or unknown
credential
string
Optional, programs only: a credential class, one of the answer's credential values (e.g. ceterms:AssociateDegree), or none
subject_code
string
Optional: a course subject prefix, e.g. NURS, one of the answer's subject codes. A course's own prefix as printed, or a prefix a program's checklist requires
Input schema (JSON)
{
"type": "object",
"properties": {
"cip": {
"description": "Optional: programs with this six-digit CIP code (e.g. 48.0508), a comma-separated list, or an array of codes"
},
"city": {
"type": "string",
"description": "Optional city, one of a state answer's cities"
},
"code": {
"type": "string",
"description": "Optional, courses only: a course code as printed, e.g. ZOO 2015; lists that code at every school, or within the state, city or school given"
},
"type": {
"type": "string",
"examples": [
"program"
],
"description": "program (the default) or learning_unit"
},
"award": {
"type": "string",
"examples": [
"Certificate"
],
"description": "Optional award exactly as published, one of the answer's awards"
},
"limit": {
"type": "integer",
"description": "Optional page size (default 10, at most 50)"
},
"place": {
"type": "string",
"description": "Optional: a place the question names, read as a state (name or code), a city, or a school, e.g. Wyoming or Casper"
},
"query": {
"type": "string",
"examples": [
"nursing"
],
"description": "Words: a program's name or award, or a course's title"
},
"state": {
"type": "string",
"examples": [
"TX"
],
"description": "Optional two-letter state"
},
"offset": {
"type": "integer",
"description": "Optional: the next_offset from a previous answer"
},
"sector": {
"type": "string",
"description": "Optional school type as IPEDS labels it, e.g. public 2-year"
},
"unitid": {
"type": "string",
"description": "Optional: one school's IPEDS UNITID"
},
"subject": {
"type": "string",
"description": "Optional CIP family (two digits, e.g. 51) or unknown"
},
"credential": {
"type": "string",
"description": "Optional, programs only: a credential class, one of the answer's credential values (e.g. ceterms:AssociateDegree), or none"
},
"subject_code": {
"type": "string",
"description": "Optional: a course subject prefix, e.g. NURS, one of the answer's subject codes. A course's own prefix as printed, or a prefix a program's checklist requires"
}
}
}
Input schema (JSON)
{
"type": "object",
"required": [
"package",
"target_unitid"
],
"properties": {
"package": {
"type": "object",
"description": "The goldribbon_package_v1 object an earlier GoldRibbon answer returned. Keep it for the person and send it back whole; GoldSeam keeps no copy."
},
"language": {
"enum": [
"en",
"es",
"fr"
],
"type": "string"
},
"aspiration": {
"type": "string",
"description": "Optional: what the person is aiming for"
},
"checklist_id": {
"type": "string",
"examples": [
"CK_225070_05e6e123"
],
"description": "The program the person is aiming for, from find_programs or find_checklists at that school. Its lines are the only courses considered; without it no course is suggested."
},
"target_unitid": {
"type": "string",
"examples": [
"240620"
],
"description": "The school's IPEDS UNITID, e.g. 240620"
}
}
}
Optional: the target program's checklist id; the answer then names the lines each covered item addresses
target_unitid*
string
The target school's IPEDS UNITID, e.g. 216038
Input schema (JSON)
{
"type": "object",
"required": [
"held",
"target_unitid"
],
"properties": {
"held": {
"type": "array",
"items": {
"type": "object"
},
"examples": [
[
{
"exam": "United States History",
"score": 3,
"program": "AP"
}
]
],
"description": "1 to 20 things held: an exam { program: any exam programme this build holds (e.g. AP, CLEP, IB), exam: its code (e.g. AP 3700) or title (e.g. United States History), score }, or a course { unitid or school, code as printed (e.g. HIS 110) }"
},
"checklist_id": {
"type": "string",
"description": "Optional: the target program's checklist id; the answer then names the lines each covered item addresses"
},
"target_unitid": {
"type": "string",
"examples": [
"216038"
],
"description": "The target school's IPEDS UNITID, e.g. 216038"
}
}
}