Skip to Content
veriom

Get processing usage

Report a month's processing units: used, in flight, budgeted and left, by kind.

GET
/v1/workspaces/{workspace_id}/processing

Report a month's processing units: used, in flight, budgeted and left, by kind.

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Query Parameters

period?|

The UTC month, YYYY-MM; the current one by default.

Response Body

Successful Response

application/json
  1. response

A period's processing units: what the budget enforces and what the ledger itemizes.

budget_units*|

The period's processing budget; null before the period's quota opens.

by_assessment_type?array<>

Assessment work by assessment type, for audits that recorded one.

by_kind*array<>
catalog_version*Catalog Version
credited_units*Credited Units

Allowances, top-ups and adjustments.

ledger_units*Ledger Units

Settled units itemized by operation.

period*Period

The UTC month, YYYY-MM.

remaining_units*string|null
reserved_units*Reserved Units

Work in flight, held but not yet settled.

unitemized_units*Unitemized Units

Used units with no ledger entry: spend charged before the ledger existed, and single calls still in flight.

used_units*Used Units

Settled work charged to the period's budget.

Example Request
curl -X GET 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/processing'
Example Response
{  "budget_units": "string",  "by_assessment_type": [    {      "assessment_type": "string",      "audits": 0,      "units": "string"    }  ],  "by_kind": [    {      "operation_kind": "string",      "operations": 0,      "units": "string"    }  ],  "catalog_version": "string",  "credited_units": "string",  "ledger_units": "string",  "period": "string",  "remaining_units": "string",  "reserved_units": "string",  "unitemized_units": "string",  "used_units": "string"}