La référence de l'API est publiée en anglais.

Record a cost event

POST/api/companies/{companyId}/cost-events
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

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.

Autorisation

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. Fonctionnement des clés.

Paramètres de chemin

companyIdstringObligatoireThe organization's id.

Corps de la requête

application/json · obligatoire

idempotencyKeystring | nullFacultatif1–200 characters
agentIdstring (uuid)Obligatoire
issueIdstring (uuid) | nullFacultatif
projectIdstring (uuid) | nullFacultatif
goalIdstring (uuid) | nullFacultatif
heartbeatRunIdstring (uuid) | nullFacultatif
billingCodestring | nullFacultatif
providerstringObligatoireat least 1 character
billerstringFacultatifat least 1 character
billingTypestringFacultatifone of: "metered_api", "subscription_included", "subscription_overage", "credits", "fixed", "unknown"
costStatusstringFacultatifone of: "reported", "estimated", "unpriced"
modelstringObligatoireat least 1 character
inputTokensintegerFacultatif≥ 0≤ 2147483647
cachedInputTokensintegerFacultatif≥ 0≤ 2147483647
outputTokensintegerFacultatif≥ 0≤ 2147483647
costCentsstring | numberObligatoire
providerRequestIdstring | nullFacultatif1–250 characters
pricingProvenanceobject | nullFacultatif
pricingProvenance.sourcestringFacultatifone of: "provider_reported", "provider_invoice", "operator", "rate_card", "unknown"
pricingProvenance.versionstringFacultatifat most 100 characters
pricingProvenance.evidencestringFacultatifat most 1000 characters
pricingProvenance.inputCentsPerMillionstring | numberFacultatif
pricingProvenance.cachedInputCentsPerMillionstring | numberFacultatif
pricingProvenance.outputCentsPerMillionstring | numberFacultatif
pricingProvenance.cacheWriteCentsPerMillionstring | numberFacultatif
pricingProvenance.serviceTierstringFacultatifat most 50 characters
pricingProvenance.contextTierstringFacultatifone of: "short", "long"
occurredAtstring (date-time)Obligatoire

Réponses

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

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Costs and budgets