Files
paperclip/docs/api/costs.md
Dotta 09d2ef1a37 fix: restore docs deleted in v0.2.3 release, add Paperclip branding
- Restored docs/ directory that was accidentally deleted by `git add -A`
  in the v0.2.3 release script
- Replaced generic "P" favicon with actual paperclip icon using brand
  primary color (#2563EB)
- Added light/dark logo SVGs for Mintlify navbar (paperclip icon + wordmark)
- Updated docs.json with logo configuration for dark/light mode
- Fixed release.sh to stage only release-related files instead of `git add -A`
  to prevent sweeping unrelated changes into release commits

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-03 15:49:43 -06:00

1.3 KiB

title, summary
title summary
Costs Cost events, summaries, and budget management

Track token usage and spending across agents, projects, and the company.

Report Cost Event

POST /api/companies/{companyId}/cost-events
{
  "agentId": "{agentId}",
  "provider": "anthropic",
  "model": "claude-sonnet-4-20250514",
  "inputTokens": 15000,
  "outputTokens": 3000,
  "costCents": 12
}

Typically reported automatically by adapters after each heartbeat.

Company Cost Summary

GET /api/companies/{companyId}/costs/summary

Returns total spend, budget, and utilization for the current month.

Costs by Agent

GET /api/companies/{companyId}/costs/by-agent

Returns per-agent cost breakdown for the current month.

Costs by Project

GET /api/companies/{companyId}/costs/by-project

Returns per-project cost breakdown for the current month.

Budget Management

Set Company Budget

PATCH /api/companies/{companyId}
{ "budgetMonthlyCents": 100000 }

Set Agent Budget

PATCH /api/agents/{agentId}
{ "budgetMonthlyCents": 5000 }

Budget Enforcement

Threshold Effect
80% Soft alert — agent should focus on critical tasks
100% Hard stop — agent is auto-paused

Budget windows reset on the first of each month (UTC).