> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Report AI agent usage

> Internal service-to-service endpoint (agent-runtime to billing) that meters an AI-agent invocation against the tenant's prepaid wallet. Authenticated with a signed internal token, not a developer API key, so it is not callable with public credentials. Resolves the `X-Tenant-Id` header against the organization record, reserves and deducts balance for the reported usage, and writes a per-debit audit entry.



## OpenAPI

````yaml /openapi.yaml post /api/v1/billing/agent-usage
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/billing/agent-usage:
    post:
      tags:
        - Billing
      summary: Report AI agent usage
      description: >-
        Internal service-to-service endpoint (agent-runtime to billing) that
        meters an AI-agent invocation against the tenant's prepaid wallet.
        Authenticated with a signed internal token, not a developer API key, so
        it is not callable with public credentials. Resolves the `X-Tenant-Id`
        header against the organization record, reserves and deducts balance for
        the reported usage, and writes a per-debit audit entry.
      parameters:
        - in: header
          name: X-Tenant-Id
          required: true
          description: >-
            Tenant id the usage is billed against; validated against the
            organization record.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - agent_id
              properties:
                agent_id:
                  type: string
                  description: Identifier of the AI agent that produced the usage.
                model_id:
                  type: string
                  description: >-
                    Model that served the turn; when omitted a baseline rate is
                    applied.
                prompt_tokens:
                  type: integer
                  minimum: 0
                  description: Input tokens for the turn.
                completion_tokens:
                  type: integer
                  minimum: 0
                  description: Output tokens for the turn.
                cache_read_tokens:
                  type: integer
                  minimum: 0
                cache_creation_tokens:
                  type: integer
                  minimum: 0
                tokens_used:
                  type: integer
                  minimum: 0
                  description: >-
                    Legacy blended token count; used only when the split token
                    fields are absent.
                conversation_id:
                  type: string
                org_id:
                  type: string
                channel:
                  type: string
                request_id:
                  type: string
            example:
              agent_id: agent_01HZY8AGENT
              model_id: claude-sonnet-4.6
              prompt_tokens: 1200
              completion_tokens: 350
              cache_read_tokens: 0
              cache_creation_tokens: 0
              conversation_id: conv_01HZY8CONV
              request_id: req_01HZY8REQ
      responses:
        '200':
          description: Usage recorded and billed against the tenant wallet.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      billed:
                        type: boolean
                        description: True when the wallet was debited for this turn.
                      credits:
                        type: integer
                        description: Amount debited from the wallet for this turn.
                      tokens_used:
                        type: integer
                        description: Total tokens billed (prompt + completion + cache).
                      model_id:
                        type: string
                        description: Effective model id the cost was computed against.
                      fell_back:
                        type: boolean
                        description: >-
                          True when a baseline rate was used because the model
                          was unpriced.
                      estimated_cost_usd:
                        type: number
                        description: Estimated cost of the turn in USD.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
              example:
                data:
                  billed: true
                  credits: 42
                  tokens_used: 1550
                  model_id: claude-sonnet-4.6
                  fell_back: false
                  estimated_cost_usd: 0.0042
                meta:
                  request_id: req_01HZY8EXAMPLE
                  timestamp: '2026-08-02T12:00:00.000Z'
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````