API Reference
Log In
API Reference

Meter Tool Event

Submit tool/function call metadata for metering and billing purposes.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Tool event metadata including tool ID, operation, duration, and attribution

The tool event metadata

string | null

Unique identifier for this tool call transaction

string
required
length ≥ 1

Identifier of the tool being called

string | null

The specific operation being performed by the tool

int64

Duration of the tool call in milliseconds

boolean

Whether the tool call was successful

string | null

Error message if the tool call failed

double | null

Cost of the tool call in USD. When provided, this value overrides the tool's configured pricing and is used directly as the charge. When omitted, the charge is computed from the tool's pricing configuration (PlanElement unitAmount or Tier unitAmount).

string
required
length ≥ 1

ISO 8601 timestamp of when the tool call occurred

string | null

Name or identifier of the AI agent making the tool call

string | null

The name of the organization from your system for multi-tenant tracking

string | null

The name of the product or application from your system for attribution

string | null

Subscriber or customer credential for billing attribution

string | null

Workflow identifier for multi-step process tracking

string | null

Trace ID for distributed tracing correlation

usageMetadata
object | null

Additional usage metadata as key-value pairs

Headers
string
length between 1 and 255
^[!-~]+$

Optional Stripe-style retry-safety key. If present, the response (status + body) is cached keyed by (tenant, key). Identical retries replay the cached response; body mismatch returns 409 idempotency_key_mismatch; a concurrent in-flight call returns 409 idempotency_key_in_progress with Retry-After: 1. Must be 1-255 printable ASCII characters; UUID v4 recommended. See https://docs.revenium.io/integrations/idempotency for full behavior.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*