API: metering

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

`GET /api/v1/metering/costs/by-article`

Costs By Article

Open as a page →

Per-article cost for a contract: direct spend + amortized collect share.

direct = sum over the article’s own runs (generate/publish, where generated_article_id is set). amortized_collect = the contract’s contract-level cost (its collect runs, where generated_article_id IS NULL) divided by the number of articles in the window — (owner decision: amortize by period, not per collect-run, since collect feeds the reused RAG corpus). imagegen is a deliberately separate ledger and NOT added.

Auth: Authorization: Bearer <token> required

Parameter	In	Required	Type
`salescontracts_id`	query	yes	`integer`
`from`	query	no	`string \| null`
`to`	query	no	`string \| null`

Responses:

Code	Meaning	Body
`200`	Successful Response	`array of ArticleCostRow`
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`

`GET /api/v1/metering/costs/by-contract`

Costs By Contract

Open as a page →

Per-contract cost rollup (sum over each salescontracts_id).

Auth: Authorization: Bearer <token> required

Parameter	In	Required	Type
`ai_company_id`	query	no	`integer \| null`
`from`	query	no	`string \| null`
`to`	query	no	`string \| null`

Responses:

Code	Meaning	Body
`200`	Successful Response	`array of ContractCostRow`
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`

`GET /api/v1/metering/costs/by-pipeline-run`

Costs By Pipeline Run

Open as a page →

Per-run cost rows, newest first.

Auth: Authorization: Bearer <token> required

Parameter	In	Required	Type
`ai_company_id`	query	no	`integer \| null`
`from`	query	no	`string \| null`
`to`	query	no	`string \| null`
`limit`	query	no	`integer`
`offset`	query	no	`integer`

Responses:

Code	Meaning	Body
`200`	Successful Response	`array of RunCostRow`
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`

`GET /api/v1/metering/costs/summary`

Costs Summary

Open as a page →

Cost + tokens + brave aggregated by day / contract / model / provider.

Auth: Authorization: Bearer <token> required

Parameter	In	Required	Type
`group_by`	query	no	`"day" \| "contract" \| "model" \| "provider"`
`ai_company_id`	query	no	`integer \| null`
`from`	query	no	`string \| null`
`to`	query	no	`string \| null`

Responses:

Code	Meaning	Body
`200`	Successful Response	`array of CostSummaryRow`
`401`	Missing or invalid authentication credentials	`ErrorResponse`
`422`	Validation Error	`HTTPValidationError`