Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.commodityai.io/llms.txt

Use this file to discover all available pages before exploring further.

Use the custom record APIs when your team has configured business objects that are specific to your company. These records sit alongside CommodityAI standard objects and are useful for workflows that do not need built-in CTRM behavior. Custom objects are schema-driven. Each object definition describes the record structure, primary keys, and display metadata used by the dashboard and API.

​
Flow

  1. Discover configured object definitions.
  2. List records for an object definition.
  3. Create or update records as part of your integration.
  4. Retrieve source material linked to a custom object record.

List Object Definitions

Find configured custom object schemas.

List Object Records

Read records for a custom object definition.

Create Object Record

Create a record for a configured object definition.

Update Object Record

Update an existing custom object record.

Get Object Record Sources

Retrieve documents and files linked to an object record.

​
When to Use This

Use custom records for company-specific concepts such as:
  • Internal approval packets
  • Supplemental compliance trackers
  • Customer-specific reporting objects
  • Operational records that do not map cleanly to a standard commodity object
When the record represents a core commodity workflow, prefer the dedicated API section for that workflow, starting with Contracts.