Skip to content

Cohort definitions for agents ​

List, retrieve, and search twelve versioned MINT cohort definitions.

sh
export MINT_DOCS_BASE="https://docs.mint.us"
curl --fail --show-error "$MINT_DOCS_BASE/cohorts.json"

Returns catalogId, version, scope, and records. Use your running docs address as the base URL. The examples use the published docs address above.

Use a client ​

Download the client for your language. No package installation or model call is needed.

sh
curl --fail --show-error "$MINT_DOCS_BASE/cohorts-client.mjs" -o cohorts-client.mjs
sh
curl --fail --show-error "$MINT_DOCS_BASE/cohorts_client.py" -o cohorts_client.py

Save and run the example beside the downloaded client.

js
import { loadCohorts, listCohorts, getCohort, searchCohorts } from './cohorts-client.mjs';

const registry = await loadCohorts(process.env.MINT_DOCS_BASE);
console.table(listCohorts(registry));
console.log(getCohort(registry, 'volume-rebates'));
console.log(searchCohorts(registry, 'return'));
python
import os
from cohorts_client import load_cohorts, list_cohorts, get_cohort, search_cohorts

registry = load_cohorts(os.environ["MINT_DOCS_BASE"])
print(list_cohorts(registry))
print(get_cohort(registry, "volume-rebates"))
print(search_cohorts(registry, "return"))
sh
node example.mjs
# Or:
python3 example.py

Functions ​

ActionJavaScriptPythonReturns
LoadloadCohorts(baseUrl)load_cohorts(base_url)Registry version 0.1.0
ListlistCohorts(registry)list_cohorts(registry)IDs, names, and asset structures
GetgetCohort(registry, id)get_cohort(registry, id)One complete record by exact ID
SearchsearchCohorts(registry, text)search_cohorts(registry, text)Matching definitions

Search covers names, structures, aliases, descriptions, and evidence fields. A returned record retains its version and source references.

Error codeMeaning
COHORT_NOT_FOUNDThe exact ID is not in the registry.
QUERY_REQUIREDSearch text is empty.
INVALID_URLThe docs base URL is invalid.
FETCH_FAILEDThe registry could not be downloaded or parsed.
INVALID_REGISTRYThe response has an unsupported version or invalid fields.

JavaScript requires Node.js 18+ or a browser with fetch. Python requires 3.8+. TypeScript declarations are available beside the JavaScript module.

Record ​

Selected fields from the actual volume-rebates definition:

json
{
  "id": "volume-rebates",
  "version": "0.1.0",
  "name": "Volume rebates",
  "assetStructure": "Net-of-rebate receivable",
  "entryRule": null,
  "exclusionRule": null,
  "amountRule": null,
  "releaseRule": null
}

The four rule fields are null: definition lookup does not assign assets or establish buyer fit. Reference events are descriptions, not funding decisions. Evidence fields and source hashes remain in the complete record.

Definition index ​

Each cohort page includes its exact-ID lookup in JavaScript and Python, complete definition response, evidence requirements, field reference, and schema.

Stable ID and cohortAsset structure
return-window-survivors
Return-window survivors
Return-resolved receivable
late-delivery-claims
Late-delivery claims
Penalty-bounded receivable
partially-fulfilled-pos
Partially fulfilled purchase orders
Line-item microreceivables
delivered-awaiting-acceptance
Delivered, awaiting acceptance
Event-vested receivable
retail-chargebacks
Retail chargebacks
Clean base and recovery strip
volume-rebates
Volume rebates
Net-of-rebate receivable
promotional-allowances
Promotional allowances
Promotion-normalized claim
predictable-short-pays
Predictable short-pays
Empirically netted receivable
delivered-not-invoiced
Delivered, not yet invoiced
Verified unbilled receivable
milestones-retainage
Milestones and retainage
Progress claim and retainage strip
formula-priced-shipments
Formula-priced shipments
Formula-reset receivable
setoff-netting
Setoff and netting
Obligor-level net-settlement claim

Files ​

For the existing local asset and buyer tools, see Assets and cohorts for agents.

MINT · Product documentation