Workspace usage summary

GET

/api/workspaces/{workspaceId}/usage/summary

curl --request GET \
  --url http://localhost:8080/api/workspaces/example/usage/summary \
  --cookie auth_session=<auth_session>

• Configured API base URL

Total tokens and cost for the workspace, optionally date-filtered.

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Query Parameters

from

string

to

string

Responses

200

Aggregate usage totals.

Media typeapplication/json

object

totalInputTokens

required

number

totalOutputTokens

required

number

totalCacheReadTokens

required

number

totalCacheWriteTokens

required

number

totalReasoningTokens

required

number

totalTokens

required

number

totalCostUsd

required

number

invocationCount

required

number

Example ^generated

{
  "totalInputTokens": 1,
  "totalOutputTokens": 1,
  "totalCacheReadTokens": 1,
  "totalCacheWriteTokens": 1,
  "totalReasoningTokens": 1,
  "totalTokens": 1,
  "totalCostUsd": 1,
  "invocationCount": 1
}

400

Invalid request

Media typeapplication/json

object

success

boolean

error

required

string

Example

{
  "error": "Human-readable error message"
}

401

Authentication required

Media typeapplication/json

object

success

boolean

error

required

string

Example

{
  "error": "Human-readable error message"
}

403

Forbidden

Media typeapplication/json

object

success

boolean

error

required

string

Example

{
  "error": "Human-readable error message"
}

404

Not found

Media typeapplication/json

object

success

boolean

error

required

string

Example

{
  "error": "Human-readable error message"
}

409

Conflict

Media typeapplication/json

object

success

boolean

error

required

string

Example

{
  "error": "Human-readable error message"
}

500

Internal server error

Media typeapplication/json

object

success

boolean

error

required

string

Example

{
  "error": "Human-readable error message"
}