Skip to Content
veriom

Assistant usage

GET
/v1/workspaces/{workspace_id}/assistant/usage

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Response Body

Successful Response

application/json
  1. response

Ask usage: questions against the daily limits, processing units against the month's.

The monthly allowance is Veriom-funded processing, so it reads in processing units, never as Veriom's model spend; no question, conversation or run carries a cost or tokens (VER-336). Questions answered on the workspace's own keys use no units.

active_user_runs*Active User Runs
active_workspace_runs*Active Workspace Runs
cached_questions?Cached Questions
Default0
conversations?array<>
daily?array<>
max_output_tokens*Max Output Tokens

The longest answer Ask writes, in tokens.

monthly_limit_units*Monthly Limit Units

The units Ask may use each month.

monthly_units*Monthly Units

Processing units Ask used this month.

period*Period
questions_today_user*Questions Today User
questions_today_workspace*Questions Today Workspace
recent_runs?array<>
remaining_units*Remaining Units
uncached_questions?Uncached Questions
Default0
user_daily_limit*User Daily Limit
workspace_daily_limit*Workspace Daily Limit
Example Request
curl -X GET 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/assistant/usage'
Example Response
{  "active_user_runs": 0,  "active_workspace_runs": 0,  "cached_questions": 0,  "conversations": [    {      "cached_questions": 0,      "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407",      "questions": 0,      "title": "string"    }  ],  "daily": [    {      "cached_questions": 0,      "date": "string",      "questions": 0    }  ],  "max_output_tokens": 0,  "monthly_limit_units": "string",  "monthly_units": "string",  "period": "string",  "questions_today_user": 0,  "questions_today_workspace": 0,  "recent_runs": [    {      "cache_hit": true,      "conversation_id": "cc71b11a-25cd-4c2d-9950-df2cc38e3407",      "created_at": "2019-08-24T14:15:22Z",      "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec"    }  ],  "remaining_units": "string",  "uncached_questions": 0,  "user_daily_limit": 0,  "workspace_daily_limit": 0}