La referencia de la API se publica en inglés.

Record a cost event

POST/api/companies/{companyId}/cost-events
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

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.

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.

Cuerpo de la solicitud

application/json · obligatorio

idempotencyKeystring | nullOpcional1–200 characters
agentIdstring (uuid)Obligatorio
issueIdstring (uuid) | nullOpcional
projectIdstring (uuid) | nullOpcional
goalIdstring (uuid) | nullOpcional
heartbeatRunIdstring (uuid) | nullOpcional
billingCodestring | nullOpcional
providerstringObligatorioat least 1 character
billerstringOpcionalat least 1 character
billingTypestringOpcionalone of: "metered_api", "subscription_included", "subscription_overage", "credits", "fixed", "unknown"
costStatusstringOpcionalone of: "reported", "estimated", "unpriced"
modelstringObligatorioat least 1 character
inputTokensintegerOpcional≥ 0≤ 2147483647
cachedInputTokensintegerOpcional≥ 0≤ 2147483647
outputTokensintegerOpcional≥ 0≤ 2147483647
costCentsstring | numberObligatorio
providerRequestIdstring | nullOpcional1–250 characters
pricingProvenanceobject | nullOpcional
pricingProvenance.sourcestringOpcionalone of: "provider_reported", "provider_invoice", "operator", "rate_card", "unknown"
pricingProvenance.versionstringOpcionalat most 100 characters
pricingProvenance.evidencestringOpcionalat most 1000 characters
pricingProvenance.inputCentsPerMillionstring | numberOpcional
pricingProvenance.cachedInputCentsPerMillionstring | numberOpcional
pricingProvenance.outputCentsPerMillionstring | numberOpcional
pricingProvenance.cacheWriteCentsPerMillionstring | numberOpcional
pricingProvenance.serviceTierstringOpcionalat most 50 characters
pricingProvenance.contextTierstringOpcionalone of: "short", "long"
occurredAtstring (date-time)Obligatorio

Respuestas

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

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Costs and budgets