Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.simplismart.ai/llms.txt

Use this file to discover all available pages before exploring further.

Fetch time-series usage and cost data from the command line using simplismart usage.

​
Cost & Usage

​
Usage Stats

Fetches cost and compute usage for a given plan type and time range. 
simplismart usage stats [options]
OptionDescription
--plan-type TYPECompute plan to query (required). See Plan Types
--start-time TIMERange start in ISO 8601 format (required)
--end-time TIMERange end in ISO 8601 format (required)
--window-size SIZEAggregation bucket size (required). Options are: MINUTE, 15MIN, 30MIN, HOUR, 3HOUR, 6HOUR, 12HOUR, DAY, WEEK
--workspace-id UUIDRestrict to a specific workspace UUID (uses org default if omitted)
--deployment-id a,b,...Filter by deployment UUID(s). Only valid for private, byoc
--deployment-slug a,b,...Filter by deployment slug(s). Only valid for private, byoc
--model-name a,b,...Filter by model name(s) (e.g. DeepSeek-R1). Only valid for shared
--training-job-id a,b,...Filter by training job UUID(s). Only valid for training
--training-job-name a,b,...Filter by training job name(s). Only valid for training
--model-repo-id a,b,...Filter by model repo UUID(s). Only valid for compilation
--model-repo-name a,b,...Filter by model repo name(s). Only valid for compilation
--include-all-statusesInclude all deployment statuses (SUCCESS, STOPPED, DELETED, FAILED, etc.). Default: only SUCCESS and STOPPED. Not supported for training and reserved
Each filter flag can be passed only once (use comma-separated values like a,b,c for multiple values). Passing an unsupported filter for the selected plan type returns an error.
  1. You can find workspace-id under Settings > Workspaces. Select your workspace and copy the workspace ID.
  1. Go to Deployments and select a deployment to find the deployment-id and deployment-slug.

​
Plan Types

ValueDescription
sharedShared endpoint usage
privatePrivate dedicated deployment usage
byocBring Your Own Compute deployment usage
reservedReserved capacity usage
trainingTraining and fine-tuning job usage
compilationModel compilation job usage
Examples: Dedicated usage (private): daily cost for the last 7 days 
simplismart usage stats \
  --plan-type private \
  --start-time 2026-04-28T00:00:00+00:00 \
  --end-time 2026-05-05T00:00:00+00:00 \
  --window-size DAY
Shared endpoint usage (shared): hourly cost for the last 24 hours, linked to a given workspace 
simplismart usage stats \
  --plan-type shared \
  --start-time 2026-05-04T00:00:00+00:00 \
  --end-time 2026-05-05T00:00:00+00:00 \
  --window-size HOUR \
  --workspace-id <WORKSPACE_ID>
Dedicated/BYOC usage (private): daily cost scoped to deployments by --deployment-id (comma-separated UUIDs) 
simplismart usage stats \
  --plan-type private \
  --start-time 2026-04-01T00:00:00+00:00 \
  --end-time 2026-05-01T00:00:00+00:00 \
  --window-size DAY \
  --deployment-id <UUID_1>,<UUID_2>
Shared usage (shared): daily cost filtered to inference on specific --model-name values 
simplismart usage stats \
  --plan-type shared \
  --start-time 2026-04-01T00:00:00+00:00 \
  --end-time 2026-05-01T00:00:00+00:00 \
  --window-size DAY \
  --model-name DeepSeek-R1,Llama-3
Training (training): weekly rollup for specific jobs (--training-job-name) 
simplismart usage stats \
  --plan-type training \
  --start-time 2026-04-01T00:00:00+00:00 \
  --end-time 2026-05-01T00:00:00+00:00 \
  --window-size WEEK \
  --training-job-name finetune-llama-v1,finetune-llama-v2
Compilation (compilation): weekly rollup for --model-repo-name: 
simplismart usage stats \
  --plan-type compilation \
  --start-time 2026-04-01T00:00:00+00:00 \
  --end-time 2026-05-01T00:00:00+00:00 \
  --window-size WEEK \
  --model-repo-name my-model-repo
Expected output — a JSON array of time-bucketed cost records printed to stdout: 
[
  {
    "timestamp": "2026-04-28T00:00:00Z",
    "cost": 12.40,
    "currency": "USD"
    items: []
  },
  {
    "timestamp": "2026-04-29T00:00:00Z",
    "cost": 9.80,
    "currency": "USD",
    items: []
  }
]
Post-processing — pipe JSON to jq to sum per-bucket costs: 
simplismart usage stats \
  --plan-type private \
  --start-time 2026-04-01T00:00:00+00:00 \
  --end-time 2026-05-01T00:00:00+00:00 \
  --window-size DAY | jq '[.[].cost] | add'
The --pg-token global flag or the SIMPLISMART_PG_TOKEN environment variable must be set. All times must be in ISO 8601 format and start-time must be before end-time.