Справочник API публикуется на английском языке.

Record a cost event

POST/api/companies/{companyId}/cost-events
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

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.

Авторизация

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. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.

Тело запроса

application/json · обязательно

idempotencyKeystring | nullНеобязательный1–200 characters
agentIdstring (uuid)Обязательный
issueIdstring (uuid) | nullНеобязательный
projectIdstring (uuid) | nullНеобязательный
goalIdstring (uuid) | nullНеобязательный
heartbeatRunIdstring (uuid) | nullНеобязательный
billingCodestring | nullНеобязательный
providerstringОбязательныйat least 1 character
billerstringНеобязательныйat least 1 character
billingTypestringНеобязательныйone of: "metered_api", "subscription_included", "subscription_overage", "credits", "fixed", "unknown"
costStatusstringНеобязательныйone of: "reported", "estimated", "unpriced"
modelstringОбязательныйat least 1 character
inputTokensintegerНеобязательный≥ 0≤ 2147483647
cachedInputTokensintegerНеобязательный≥ 0≤ 2147483647
outputTokensintegerНеобязательный≥ 0≤ 2147483647
costCentsstring | numberОбязательный
providerRequestIdstring | nullНеобязательный1–250 characters
pricingProvenanceobject | nullНеобязательный
pricingProvenance.sourcestringНеобязательныйone of: "provider_reported", "provider_invoice", "operator", "rate_card", "unknown"
pricingProvenance.versionstringНеобязательныйat most 100 characters
pricingProvenance.evidencestringНеобязательныйat most 1000 characters
pricingProvenance.inputCentsPerMillionstring | numberНеобязательный
pricingProvenance.cachedInputCentsPerMillionstring | numberНеобязательный
pricingProvenance.outputCentsPerMillionstring | numberНеобязательный
pricingProvenance.cacheWriteCentsPerMillionstring | numberНеобязательный
pricingProvenance.serviceTierstringНеобязательныйat most 50 characters
pricingProvenance.contextTierstringНеобязательныйone of: "short", "long"
occurredAtstring (date-time)Обязательный

Ответы

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

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Costs and budgets