docs/api/costs.md at d06c9f1edc1722f6698a1a2ca88942b5cbd66aca

0 Fork 0

mirror of https://github.com/paperclipai/docs.git synced 2026-11-07 06:15:59 -10:00

Files

T

ForgottenandClaude Opus 4.6 d06c9f1edc Port Paperclip docs from monorepo to dedicated docs repo

Replace Mintlify starter template with actual Paperclip documentation
from ~/paperclip/docs. Includes all doc sections: getting started,
guides (board operator + agent developer), deployment, adapters,
API reference, and CLI reference.

Co-Authored-By: Claude Opus 4.6 <[email protected]>

2026-03-03 15:39:02 -06:00

1.3 KiB

Raw Blame History

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).

1.3 KiB Raw Blame History