Deployments.ai Docs
Command reference

deployments usage

Metered usage

CommandSummary
deployments usage showShow usage aggregates
deployments usage summarySummarize usage per metric and hour or day

deployments usage show

Show usage aggregates.

deployments usage show
  • Calls GET /v1/usage (SDK listUsageRecords).
  • Needs an environment: --env or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
--sincestringStart timestamp
--untilstringEnd timestamp
--metricstringUsage metric

Also accepts the global flags.

deployments usage summary

Summarize usage per metric and hour or day.

deployments usage summary --since <since> --until <until>
FlagTypeRequiredDefaultDescription
--sincestringyesStart timestamp on an interval boundary (UTC)
--untilstringyesEnd timestamp on an interval boundary (UTC), exclusive
--intervalstringBucket width: hour (default) or day
--definitionstringOnly usage of runs that executed this agent definition
--workspace-idstringOnly usage that names this workspace; not combinable with --definition

Also accepts the global flags.

On this page