v1

latestOpenAPI 3.0.3MIT2026-08-04143307364.8 KB
Workspaces

Get usage by workspace

Return monthly credits consumption of a workspace. Deprecated: use GET /v3/usage?organization={id}&workspace={id} instead. The new endpoint returns a unified daily series and supports the same workspace scoping along with organization- and document-type-level reporting.

get/v3/workspaces/{identifier}/usage

Path parameters

identifierstring required

Uniquely identify a workspace.

Example:mEFayXdO

Workspace's identifier

Query parameters

startstring
Example:2023-07

Start date of the period to retrieve. Format: YYYY-MM

endstring
Example:2023-10

End date of the period to retrieve. Format: YYYY-MM

Response

Monthly credits consumption of a workspace.

monthstring required

Month of the usage

countinteger required

Usage count

Example response

[
  {
    "month": "2023-07",
    "count": 100
  }
]