# CommodityAI API Documentation

## Docs

- [Custom Record Management](https://docs.commodityai.io/api/custom-record-management.md): API workflow for reading and managing configurable object records
- [Document Ingestion](https://docs.commodityai.io/api/document-ingestion.md): API workflow for submitting documents and reading extracted source records
- [Authentication](https://docs.commodityai.io/authentication.md): Learn how to authenticate with the CommodityAI API
- [Add Contract Leg](https://docs.commodityai.io/contracts/add-contract-leg.md): Add a tranche or allocatable segment to a contract
- [Create Allocation](https://docs.commodityai.io/contracts/create-allocation.md): Create a purchase-side, sale-side, or purchase-to-sale allocation
- [Create Contract](https://docs.commodityai.io/contracts/create-contract.md): Create a purchase or sale contract
- [Get Allocation](https://docs.commodityai.io/contracts/get-allocation.md): Retrieve an allocation by ID
- [Get Contract](https://docs.commodityai.io/contracts/get-contract.md): Retrieve a contract by ID
- [List Allocations](https://docs.commodityai.io/contracts/list-allocations.md): Retrieve allocations for your company
- [List Contract Legs](https://docs.commodityai.io/contracts/list-contract-legs.md): Retrieve allocatable legs for a contract
- [List Contracts](https://docs.commodityai.io/contracts/list-contracts.md): Retrieve contracts for your company
- [Contracts](https://docs.commodityai.io/contracts/overview.md): Contracts, legs, allocations, product attributes, and quality specifications
- [Pricing Terms](https://docs.commodityai.io/contracts/pricing-terms.md): Formula pricing terms accepted during contract creation
- [Product Attributes & Quality](https://docs.commodityai.io/contracts/product-attributes-and-quality.md): Structured product attributes and contract quality specifications
- [Set Contract Attribute Values](https://docs.commodityai.io/contracts/set-contract-attribute-values.md): Set structured product attribute values for a contract
- [Update Allocation](https://docs.commodityai.io/contracts/update-allocation.md): Update an allocation quantity
- [Update Contract](https://docs.commodityai.io/contracts/update-contract.md): Update contract fields or lifecycle status
- [List Object Definitions](https://docs.commodityai.io/definitions/list-object-definitions.md): Retrieve all custom object definitions for your company
- [List Source Definitions](https://docs.commodityai.io/definitions/list-source-definitions.md): Retrieve all source record definitions for your company
- [Submit Document](https://docs.commodityai.io/documents/submit-document.md): Submit a document for processing through the pipeline
- [Error Handling](https://docs.commodityai.io/errors.md): Understanding and handling API errors
- [Introduction](https://docs.commodityai.io/introduction.md): The CommodityAI operating layer for commodity trading workflows
- [List Issues](https://docs.commodityai.io/issues/list-issues.md): Retrieve business exceptions and data discrepancies across objects
- [Commodity Operating System](https://docs.commodityai.io/overview/commodity-operating-system.md): How CommodityAI models commodity trading operations around standard objects, workflows, and source provenance
- [Platform Overview](https://docs.commodityai.io/overview/platform-overview.md): Understanding CommodityAI as an operating layer for commodity trading workflows
- [Quick Start Guide](https://docs.commodityai.io/overview/quick-start.md): Connect to the CommodityAI API in 3 simple steps
- [Data Policies & Compliance](https://docs.commodityai.io/privacy-security/data-policies.md): CommodityAI data handling, storage, retention, and compliance policies
- [EU Data Residency](https://docs.commodityai.io/privacy-security/eu-data-residency.md): CommodityAI European Union data residency options and data protection practices
- [Rate Limits](https://docs.commodityai.io/rate-limits.md): Understanding API rate limits and how to handle them
- [Create Object Record](https://docs.commodityai.io/records/create-object-record.md): Create a new object record
- [Get Object Record Sources](https://docs.commodityai.io/records/get-object-record-sources.md): Retrieve source documents and files for a custom object record
- [Get Source Record Sources](https://docs.commodityai.io/records/get-source-record-sources.md): Retrieve source documents and files for a source record
- [List Object Records](https://docs.commodityai.io/records/list-custom-object-records.md): Retrieve object records by definition
- [List Source Records](https://docs.commodityai.io/records/list-source-records.md): Retrieve source records by definition
- [Update Object Record](https://docs.commodityai.io/records/update-object-record.md): Update an existing object record
- [Code Sets](https://docs.commodityai.io/reference-data/code-sets.md): Read-only lookup endpoints for common CTRM code sets
- [Market Indexes](https://docs.commodityai.io/reference-data/market-indexes.md): Read-only pricing index lookups used by formula pricing terms
- [Reference Data](https://docs.commodityai.io/reference-data/overview.md): Read-only code sets and lookup data used by CommodityAI APIs
- [Product Reference Data](https://docs.commodityai.io/reference-data/product-reference-data.md): Read-only product, grade, attribute, option, and quality lookups

## OpenAPI Specs

- [openapi](https://docs.commodityai.io/api-reference/openapi.json)