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.

Product reference data provides read-only IDs used by contract creation, product attributes, quality specifications, and pricing workflows.

​
Endpoints

DataEndpointNotes
ProductsGET /api/v1/productsCompany product catalog.
ProductGET /api/v1/products/{id}Single product by ID.
GradesGET /api/v1/gradesAll grades available to the company.
Product gradesGET /api/v1/products/{id}/gradesGrades for one product.
Product attributesGET /api/v1/products/{id}/attributesAttribute definitions used by quality_attributes.
Attribute optionsGET /api/v1/products/{id}/attributes/{attribute_id}/optionsOption values for select and multi_select attributes.
Quality specificationsGET /api/v1/products/{id}/quality-specificationsProduct-level quality templates and product-scoped specs.
Quality specificationGET /api/v1/products/{id}/quality-specifications/{specification_id}Single quality specification.

​
Attribute Values

Contract creation uses product attribute IDs and option IDs in quality_attributes: 
{
  "quality_attributes": {
    "a23e4567-e89b-12d3-a456-426614174009": "Brazil",
    "b23e4567-e89b-12d3-a456-426614174010": "c23e4567-e89b-12d3-a456-426614174011"
  }
}
Use product attributes and attribute options to resolve those IDs before creating a contract.

​
Request Example

curl -X GET "https://commodityai.app/api/v1/products" \
  -H "Authorization: Bearer cai_live_your_api_key_here"

​
Response Example

[
  {
    "id": "a23e4567-e89b-12d3-a456-426614174009",
    "product_id": "923e4567-e89b-12d3-a456-426614174009",
    "name": "Origin",
    "code": "origin",
    "attribute_type": "text",
    "display_order": 1,
    "is_required": false
  }
]