BackGet my API keys
Documentation

YOoDY API documentation

Sign in once and five keys are generated automatically for your workspace — one per API. Every call is metered by the AI Digital Twin top model and converted into tonnes saved and circularity points.

Authentication

Send your key as a bearer token. Keys are scoped to one API stream and can be rotated from your workspace at any time; rotation revokes the old value immediately.

curl https://api.yoody.build/v1/elements \
  -H "Authorization: Bearer yoody_ptm_XXXXXXXX-XXXXXXXX-XXXXXXXX-XXXXXXXX"

Base URL: https://api.yoody.build · JSON in, JSON out · rate limited per key.

Periodic Table of Materials API

All 118 elements, element by element: atomic mass, density, embodied carbon, criticality, recyclability index and reuse routing. Auto-generated for every workspace.

  • GET /v1/elements — list all 118 elements with circularity attributes
  • GET /v1/elements/{symbol} — one element, e.g. /v1/elements/Li
  • POST /v1/elements/optimize — substitute an element for a lower-impact equivalent
{ "stream": "periodic_elements", "mode": "point-to-point" }

Food Waste API

Surplus and waste food routed to its highest-value use: redistribution, animal feed, composting or biogas, with tonnes saved and circularity points.

  • POST /v1/food-waste/classify — categorise a surplus batch
  • POST /v1/food-waste/route — best valorisation path and expected recovery
  • GET /v1/food-waste/impact — cumulative tonnes and points for your key
{ "stream": "food_waste", "mode": "point-to-point" }

Critical Minerals API

Lithium, cobalt, copper and rare earth recovery loops with supply-risk weighting.

  • POST /v1/minerals/recover — recovery yield for a given feedstock
  • GET /v1/minerals/risk — supply-risk index per mineral
{ "stream": "critical_minerals", "mode": "point-to-point" }

Circular Plastics API

Polymer identification, depolymerisation feasibility and reuse routing.

  • POST /v1/plastics/identify — polymer family from your sample data
  • POST /v1/plastics/route — mechanical vs chemical recycling decision
{ "stream": "circular_plastics", "mode": "point-to-point" }

Circular Textiles API

Fibre-to-fibre tracing, sorting yield and resale value estimation.

  • POST /v1/textiles/sort — fibre composition and sorting yield
  • POST /v1/textiles/value — resale and recycling value
{ "stream": "circular_textiles", "mode": "point-to-point" }

Response shape

{
  "baseline_mass_t": 128.4,
  "twin_mass_t": 1.6,
  "reduction_factor": 80.2,
  "tonnes_saved": 126.8,
  "circularity_points": 1420,
  "path": ["origin", "transform", "install", "recovery"]
}

Errors return an HTTP status plus { "error": "message" }. 401 means the key is missing, revoked or rotated.

Generate my five keysHow the twin calculates