API referansı İngilizce yayımlanır.

Record a cost event

POST/api/companies/{companyId}/cost-events
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Record a cost event.

Amounts are USD cents, including fractional cents. Decimal strings preserve exact nanodollar precision. Reuse the idempotency key and original receipt on retries; conflicting reuse returns 409.

Idempotency. Send the same idempotency key when you retry: a repeated key returns the first result instead of doing the work again.

Yetkilendirme

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Anahtarlar nasıl çalışır.

Yol parametreleri

companyIdstringZorunluThe organization's id.

İstek gövdesi

application/json · zorunlu

idempotencyKeystring | nullİsteğe bağlı1–200 characters
agentIdstring (uuid)Zorunlu
issueIdstring (uuid) | nullİsteğe bağlı
projectIdstring (uuid) | nullİsteğe bağlı
goalIdstring (uuid) | nullİsteğe bağlı
heartbeatRunIdstring (uuid) | nullİsteğe bağlı
billingCodestring | nullİsteğe bağlı
providerstringZorunluat least 1 character
billerstringİsteğe bağlıat least 1 character
billingTypestringİsteğe bağlıone of: "metered_api", "subscription_included", "subscription_overage", "credits", "fixed", "unknown"
costStatusstringİsteğe bağlıone of: "reported", "estimated", "unpriced"
modelstringZorunluat least 1 character
inputTokensintegerİsteğe bağlı≥ 0≤ 2147483647
cachedInputTokensintegerİsteğe bağlı≥ 0≤ 2147483647
outputTokensintegerİsteğe bağlı≥ 0≤ 2147483647
costCentsstring | numberZorunlu
providerRequestIdstring | nullİsteğe bağlı1–250 characters
pricingProvenanceobject | nullİsteğe bağlı
pricingProvenance.sourcestringİsteğe bağlıone of: "provider_reported", "provider_invoice", "operator", "rate_card", "unknown"
pricingProvenance.versionstringİsteğe bağlıat most 100 characters
pricingProvenance.evidencestringİsteğe bağlıat most 1000 characters
pricingProvenance.inputCentsPerMillionstring | numberİsteğe bağlı
pricingProvenance.cachedInputCentsPerMillionstring | numberİsteğe bağlı
pricingProvenance.outputCentsPerMillionstring | numberİsteğe bağlı
pricingProvenance.cacheWriteCentsPerMillionstring | numberİsteğe bağlı
pricingProvenance.serviceTierstringİsteğe bağlıat most 50 characters
pricingProvenance.contextTierstringİsteğe bağlıone of: "short", "long"
occurredAtstring (date-time)Zorunlu

Yanıtlar

201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Costs and budgets