Skip to content

Commit 2ca9d24

Browse files
committed
docs: list the optional modelBreakdowns keys in the JSON guarantees
Programmatic Usage promised that every field is always present, which was already false for missingPricing and storedCost and is now false for cacheCreation1hTokens. Name those keys and the --no-cost exception.
1 parent 7f0a677 commit 2ca9d24

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

‎docs/guide/json-output.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -716,7 +716,7 @@ if (projectData.projects) {
716716

717717
JSON output is designed for programmatic consumption:
718718

719-
- **Consistent structure**: All fields are always present (with 0 or empty values when not applicable)
719+
- **Consistent structure**: Token and cost fields are always present (with 0 or empty values when not applicable), except that `--no-cost` removes cost fields. A few `modelBreakdowns` keys appear only when they apply: [`missingPricing`](#unpriced-models), [`storedCost`](#stored-costs), and [`cacheCreation1hTokens`](#cache-write-ttl-split)
720720
- **Standard types**: Numbers for metrics, strings for identifiers, arrays for lists
721721
- **ISO timestamps**: Standardized date/time formats for reliable parsing
722722
- **Stable schema**: Field names and structures remain consistent across versions

0 commit comments

Comments
 (0)