Account Management
Retrieve account details, team members, API keys, and usage stats (spend, performance, errors) for your organization with the account management API.
Introduction
The accountManagement task reads your organization's account data over the API: the team and their roles, your API keys, the current balance, and usage statistics. Reach for it whenever a script needs account state that would otherwise mean opening the web console, like billing automation or a usage alert.
Everything runs through the operation parameter: it selects the dataset and shapes both the request and the response. Each operation is documented in its own section below.
| Operation | Returns |
|---|---|
getDetails | Organization info, team, API keys, and rolling usage totals. |
getUsageActivity | Requests and spend over a date range, broken down by day, model, and/or API key. |
getUsagePerformance | Per-model inference-time percentiles over a date range. |
getUsageErrors | Client (4xx) and server (5xx) error counts over a date range. |
The three usage operations share the same request parameters (a date window plus optional filters) and the same usage response envelope, differing only in the metrics each row reports.
getDetails
Everything about the account in one call, with no date range or filters. The response carries the organization identity, the current balance, the full team roster with roles, and every API key with its lifetime request count.
The usage object here holds rolling totals rather than a time breakdown: credits and requests for today, last7Days, last30Days, and lifetime total. Use getDetails for a point-in-time picture of the account, and the operations below when you need consumption sliced across a date range.
Request
import { createClient } from '@runware/sdk'
const client = await createClient({ apiKey: process.env.RUNWARE_API_KEY })
await client.connect()
const result = await client.accountManagement({
operation: 'getDetails'
})import asyncio
import os
from runware import Runware
async def main():
async with Runware(api_key=os.environ["RUNWARE_API_KEY"]) as client:
result = await client.account_management({
"operation": "getDetails"
})
asyncio.run(main())curl https://api.runware.ai/v1 \
-H "Authorization: Bearer $RUNWARE_API_KEY" \
-H "Content-Type: application/json" \
-d '[
{
"taskType": "accountManagement",
"taskUUID": "f4dd3dfe-955f-49d5-a785-7e3b633d6e7a",
"operation": "getDetails"
}
]'runware account details{
"taskType": "accountManagement",
"taskUUID": "f4dd3dfe-955f-49d5-a785-7e3b633d6e7a",
"operation": "getDetails"
}taskType
stringrequiredvalue: accountManagementIdentifier for the type of task being performed
taskUUID
stringrequiredUUID v4UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.
operation
stringrequiredvalue: getDetailsThe specific account management operation to perform.
Response
{
"data": [
{
"taskType": "accountManagement",
"taskUUID": "f4dd3dfe-955f-49d5-a785-7e3b633d6e7a",
"operation": "getDetails",
"organizationUUID": "a6379343-9ff2-46a0-996b-e4a7b3057c88",
"organizationName": "Acme Corporation",
"balance": { "amount": 2450.75, "freeBalance": 120.00, "currency": "USD" },
"team": [
{ "name": "John Smith", "email": "john.smith@acme.com", "roles": ["Owner"], "joinedAt": "2024-01-15T10:30:00Z" }
],
"apiKeys": [
{ "name": "Production API Key", "apiKey": "YHluz4gk5KU4ZZWr****************", "enabled": true, "createdAt": "2024-01-20T11:00:00Z", "requests": 15420, "lastUsedAt": "2025-10-12T08:45:30Z" }
],
"usage": {
"today": { "credits": 35.80, "requests": 1850 },
"last7Days": { "credits": 412.25, "requests": 21400 },
"last30Days": { "credits": 1685.90, "requests": 87560 },
"total": { "credits": 48920.50, "requests": 2540318 }
}
}
]
}taskType
stringrequiredvalue: accountManagementIdentifier for the type of task this response belongs to.
taskUUID
stringrequiredUUID v4UUID v4 identifier echoed from the original request, used to match async responses to their tasks.
operation
stringrequiredvalue: getDetailsThe account management operation that produced this response.
organizationName
stringThe name of the organization.
organizationUUID
stringUUID v4Unique identifier for the organization.
balance
objectCurrent account balance and currency.
Properties3 properties
balance»amountamount
floatrequiredCurrent balance amount.
balance»freeBalancefreeBalance
floatAvailable free credit balance.
balance»currencycurrency
stringrequiredCurrency code.
team
array of objectsList of team members.
Properties4 properties
team»namename
stringrequiredFull name of the team member.
team»emailemail
stringrequiredemailEmail address of the team member.
team»rolesroles
array of stringsrequiredEach team member is assigned a role that determines their level of access within the organization.
Capability Owner Admin Developer API generation and Playground ✓ ✓ ✓ Manage Playground workflows ✓ ✓ ✓ Create and manage API keys ✓ ✓ View API logs and usage analytics ✓ ✓ Manage billing and payment methods ✓ ✓ Invite and remove team members ✓ ✓ Assign Admin and Developer roles ✓ ✓ Assign Owner role ✓ Delete organization ✓
team»joinedAtjoinedAt
stringdate-timeDate and time when the member joined.
apiKeys
array of objectsList of API keys associated with the account.
Properties7 properties
apiKeys»apiKeyapiKey
stringrequiredThe API key string (partially masked).
apiKeys»namename
stringrequiredName or label for the API key.
apiKeys»descriptiondescription
stringDescription of the API key.
apiKeys»enabledenabled
booleanrequiredWhether the API key is active.
apiKeys»createdAtcreatedAt
stringrequireddate-timeDate and time when the key was created.
apiKeys»lastUsedAtlastUsedAt
stringdate-timeDate and time when the key was last used.
apiKeys»requestsrequests
integerTotal number of requests made with this key.
usage
objectAccount usage statistics.
Properties4 properties
usage»todaytoday
objectUsage stats for today.
usage»last7Dayslast7Days
objectUsage stats for the last 7 days.
usage»last30Dayslast30Days
objectUsage stats for the last 30 days.
usage»totaltotal
objectTotal lifetime usage stats.
getUsageActivity
How much the account spent and how many requests it ran, over the window you set with startDate and endDate. This is the call behind a usage dashboard or a monthly billing report.
groupBy controls how the totals are sliced. Ask for date and you get a timeseries of per-day rows. Ask for model or apiKey and the same totals come back split by that dimension, and you can request several at once. Each slice lands under usage as its own breakdown: a data array with one row per bucket (count and spend), plus a meta roll-up that totals the window and projects a 30-day spend.
Request
import { createClient } from '@runware/sdk'
const client = await createClient({ apiKey: process.env.RUNWARE_API_KEY })
await client.connect()
const result = await client.accountManagement({
operation: 'getUsageActivity',
startDate: '2026-07-01',
endDate: '2026-07-06',
groupBy: [
'date',
'model'
],
timezone: 'America/New_York'
})import asyncio
import os
from runware import Runware
async def main():
async with Runware(api_key=os.environ["RUNWARE_API_KEY"]) as client:
result = await client.account_management({
"operation": "getUsageActivity",
"startDate": "2026-07-01",
"endDate": "2026-07-06",
"groupBy": [
"date",
"model"
],
"timezone": "America/New_York"
})
asyncio.run(main())curl https://api.runware.ai/v1 \
-H "Authorization: Bearer $RUNWARE_API_KEY" \
-H "Content-Type: application/json" \
-d '[
{
"taskType": "accountManagement",
"taskUUID": "b7e0a3f2-3c1a-4d9e-8f2b-1a2c3d4e5f60",
"operation": "getUsageActivity",
"startDate": "2026-07-01",
"endDate": "2026-07-06",
"groupBy": [
"date",
"model"
],
"timezone": "America/New_York"
}
]'runware account getUsageActivity{
"taskType": "accountManagement",
"taskUUID": "b7e0a3f2-3c1a-4d9e-8f2b-1a2c3d4e5f60",
"operation": "getUsageActivity",
"startDate": "2026-07-01",
"endDate": "2026-07-06",
"groupBy": [
"date",
"model"
],
"timezone": "America/New_York"
}taskType
stringrequiredvalue: accountManagementIdentifier for the type of task being performed
taskUUID
stringrequiredUUID v4UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.
operation
stringrequiredvalue: getUsageActivityThe specific account management operation to perform.
startDate
stringdateStart of the usage window (inclusive).
endDate
stringdateEnd of the usage window (inclusive). Must be on or after startDate, and the span must not exceed 30 days.
models
array of stringsmax items: 100Restrict usage to these model AIRs. Defaults to all models.
apiKeys
array of stringsmax items: 100Restrict usage to these API key UUIDs. Defaults to all keys.
groupBy
array of stringsdefault: date,modelBreakdowns to return.
timezone
stringdefault: UTCIANA timezone name used for day-bucketing.
Response
{
"data": [
{
"taskType": "accountManagement",
"taskUUID": "b7e0a3f2-3c1a-4d9e-8f2b-1a2c3d4e5f60",
"operation": "getUsageActivity",
"startDate": "2026-07-01",
"endDate": "2026-07-06",
"usage": {
"timeseries": {
"data": [{ "date": "2026-07-01", "count": 340, "spend": 120.05154 }],
"meta": { "totalRequests": 1197, "totalResults": 1197, "totalSpend": 493.7819, "avgDailySpend": 87.37, "projectedSpend": 2708.55 }
},
"model": {
"data": [{ "date": "2026-07-01", "model": "google:gemini@omni-flash", "modelName": "Gemini Omni Flash", "count": 207, "spend": 101.457393 }],
"meta": { "totalRequests": 1197, "totalResults": 1197, "totalSpend": 493.7819, "avgDailySpend": 87.37, "projectedSpend": 2708.55 }
}
}
}
]
}taskType
stringrequiredvalue: accountManagementIdentifier for the type of task this response belongs to.
taskUUID
stringrequiredUUID v4UUID v4 identifier echoed from the original request, used to match async responses to their tasks.
operation
stringrequiredvalue: getUsageActivityThe account management operation that produced this response.
startDate
stringdateStart of the returned window (inclusive).
endDate
stringdateEnd of the returned window (inclusive).
usage
objectAccount usage statistics.
Properties7 properties
usage»todaytoday
objectUsage stats for today.
usage»last7Dayslast7Days
objectUsage stats for the last 7 days.
usage»last30Dayslast30Days
objectUsage stats for the last 30 days.
usage»totaltotal
objectTotal lifetime usage stats.
usage»timeseriestimeseries
objectPer-day breakdown (from groupBy date).
Properties2 properties
usage»timeseries»datadata
array of objectsrequiredRows for this breakdown.
Properties6 properties
usage»timeseries»data»datedate
stringdateDay bucket.
usage»timeseries»data»modelmodel
stringModel AIR.
usage»timeseries»data»modelNamemodelName
stringHuman-friendly model name. Falls back to the AIR when none exists.
usage»timeseries»data»apiKeyapiKey
stringAPI key UUID.
usage»timeseries»data»countcount
integerNumber of requests in this bucket.
usage»timeseries»data»spendspend
floatAmount spent in this bucket.
usage»timeseries»metameta
objectrequiredRoll-up totals for a breakdown. Which fields are present depends on the operation.
Properties5 properties
usage»timeseries»meta»totalRequeststotalRequests
integerTotal requests across the window.
usage»timeseries»meta»totalResultstotalResults
integerTotal results produced across the window.
usage»timeseries»meta»totalSpendtotalSpend
floatTotal spend across the window.
usage»timeseries»meta»avgDailySpendavgDailySpend
floatAverage spend per day. An estimate that drifts between calls.
usage»timeseries»meta»projectedSpendprojectedSpend
floatProjected 30-day spend extrapolated from the window. An estimate that drifts between calls.
usage»modelmodel
objectPer-model breakdown (from groupBy model).
Properties2 properties
usage»model»datadata
array of objectsrequiredRows for this breakdown.
Properties6 properties
usage»model»data»datedate
stringdateDay bucket.
usage»model»data»modelmodel
stringModel AIR.
usage»model»data»modelNamemodelName
stringHuman-friendly model name. Falls back to the AIR when none exists.
usage»model»data»apiKeyapiKey
stringAPI key UUID.
usage»model»data»countcount
integerNumber of requests in this bucket.
usage»model»data»spendspend
floatAmount spent in this bucket.
usage»model»metameta
objectrequiredRoll-up totals for a breakdown. Which fields are present depends on the operation.
Properties5 properties
usage»model»meta»totalRequeststotalRequests
integerTotal requests across the window.
usage»model»meta»totalResultstotalResults
integerTotal results produced across the window.
usage»model»meta»totalSpendtotalSpend
floatTotal spend across the window.
usage»model»meta»avgDailySpendavgDailySpend
floatAverage spend per day. An estimate that drifts between calls.
usage»model»meta»projectedSpendprojectedSpend
floatProjected 30-day spend extrapolated from the window. An estimate that drifts between calls.
usage»apiKeyapiKey
objectPer-key breakdown (from groupBy apiKey).
Properties2 properties
usage»apiKey»datadata
array of objectsrequiredRows for this breakdown.
Properties6 properties
usage»apiKey»data»datedate
stringdateDay bucket.
usage»apiKey»data»modelmodel
stringModel AIR.
usage»apiKey»data»modelNamemodelName
stringHuman-friendly model name. Falls back to the AIR when none exists.
usage»apiKey»data»apiKeyapiKey
stringAPI key UUID.
usage»apiKey»data»countcount
integerNumber of requests in this bucket.
usage»apiKey»data»spendspend
floatAmount spent in this bucket.
usage»apiKey»metameta
objectrequiredRoll-up totals for a breakdown. Which fields are present depends on the operation.
Properties5 properties
usage»apiKey»meta»totalRequeststotalRequests
integerTotal requests across the window.
usage»apiKey»meta»totalResultstotalResults
integerTotal results produced across the window.
usage»apiKey»meta»totalSpendtotalSpend
floatTotal spend across the window.
usage»apiKey»meta»avgDailySpendavgDailySpend
floatAverage spend per day. An estimate that drifts between calls.
usage»apiKey»meta»projectedSpendprojectedSpend
floatProjected 30-day spend extrapolated from the window. An estimate that drifts between calls.
getUsagePerformance
How fast the account's models run. For a date window, each model row reports the average, p90, and p99 inference time in seconds, so you can track tail latency per model.
Percentiles are only meaningful within a single model, so the data lives in the model breakdown and the timeseries breakdown comes back empty.
Request
import { createClient } from '@runware/sdk'
const client = await createClient({ apiKey: process.env.RUNWARE_API_KEY })
await client.connect()
const result = await client.accountManagement({
operation: 'getUsagePerformance',
startDate: '2026-07-01',
endDate: '2026-07-06',
groupBy: [
'date',
'model'
]
})import asyncio
import os
from runware import Runware
async def main():
async with Runware(api_key=os.environ["RUNWARE_API_KEY"]) as client:
result = await client.account_management({
"operation": "getUsagePerformance",
"startDate": "2026-07-01",
"endDate": "2026-07-06",
"groupBy": [
"date",
"model"
]
})
asyncio.run(main())curl https://api.runware.ai/v1 \
-H "Authorization: Bearer $RUNWARE_API_KEY" \
-H "Content-Type: application/json" \
-d '[
{
"taskType": "accountManagement",
"taskUUID": "ed936635-488f-48c2-8c4d-dbf117c8a7b1",
"operation": "getUsagePerformance",
"startDate": "2026-07-01",
"endDate": "2026-07-06",
"groupBy": [
"date",
"model"
]
}
]'runware account getUsagePerformance{
"taskType": "accountManagement",
"taskUUID": "ed936635-488f-48c2-8c4d-dbf117c8a7b1",
"operation": "getUsagePerformance",
"startDate": "2026-07-01",
"endDate": "2026-07-06",
"groupBy": [
"date",
"model"
]
}taskType
stringrequiredvalue: accountManagementIdentifier for the type of task being performed
taskUUID
stringrequiredUUID v4UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.
operation
stringrequiredvalue: getUsagePerformanceThe specific account management operation to perform.
startDate
stringdateStart of the usage window (inclusive).
endDate
stringdateEnd of the usage window (inclusive). Must be on or after startDate, and the span must not exceed 30 days.
models
array of stringsmax items: 100Restrict usage to these model AIRs. Defaults to all models.
apiKeys
array of stringsmax items: 100Restrict usage to these API key UUIDs. Defaults to all keys.
groupBy
array of stringsdefault: date,modelBreakdowns to return.
timezone
stringdefault: UTCIANA timezone name used for day-bucketing.
Response
{
"data": [
{
"taskType": "accountManagement",
"taskUUID": "ed936635-488f-48c2-8c4d-dbf117c8a7b1",
"operation": "getUsagePerformance",
"startDate": "2026-07-01",
"endDate": "2026-07-06",
"usage": {
"model": {
"data": [{ "date": "2026-07-03", "model": "bytedance:video-upscaler@standard", "modelName": "Bytedance Video Upscaler", "avgInferenceTime": 134.8486, "p90InferenceTime": 226.245, "p99InferenceTime": 291.6665 }],
"meta": { "totalRequests": 164, "totalResults": 164, "totalSpend": 1.6226, "avgDailySpend": 0.2704, "projectedSpend": 8.38, "avgInferenceTime": 134.8486, "p50InferenceTime": 144.49, "p90InferenceTime": 226.245, "p99InferenceTime": 291.6665 }
}
}
}
]
}taskType
stringrequiredvalue: accountManagementIdentifier for the type of task this response belongs to.
taskUUID
stringrequiredUUID v4UUID v4 identifier echoed from the original request, used to match async responses to their tasks.
operation
stringrequiredvalue: getUsagePerformanceThe account management operation that produced this response.
startDate
stringdateStart of the returned window (inclusive).
endDate
stringdateEnd of the returned window (inclusive).
usage
objectAccount usage statistics.
Properties7 properties
usage»todaytoday
objectUsage stats for today.
usage»last7Dayslast7Days
objectUsage stats for the last 7 days.
usage»last30Dayslast30Days
objectUsage stats for the last 30 days.
usage»totaltotal
objectTotal lifetime usage stats.
usage»timeseriestimeseries
objectPer-day breakdown (from groupBy date).
Properties2 properties
usage»timeseries»datadata
array of objectsrequiredRows for this breakdown.
Properties7 properties
usage»timeseries»data»datedate
stringdateDay bucket.
usage»timeseries»data»modelmodel
stringModel AIR.
usage»timeseries»data»modelNamemodelName
stringHuman-friendly model name. Falls back to the AIR when none exists.
usage»timeseries»data»apiKeyapiKey
stringAPI key UUID.
usage»timeseries»data»avgInferenceTimeavgInferenceTime
float | nullAverage inference time in seconds, or null when there were no inferences.
usage»timeseries»data»p90InferenceTimep90InferenceTime
float | null90th-percentile inference time in seconds, or null when there were no inferences.
usage»timeseries»data»p99InferenceTimep99InferenceTime
float | null99th-percentile inference time in seconds, or null when there were no inferences.
usage»timeseries»metameta
objectrequiredRoll-up totals for a breakdown. Which fields are present depends on the operation.
Properties9 properties
usage»timeseries»meta»totalRequeststotalRequests
integerTotal requests across the window.
usage»timeseries»meta»totalResultstotalResults
integerTotal results produced across the window.
usage»timeseries»meta»totalSpendtotalSpend
floatTotal spend across the window.
usage»timeseries»meta»avgDailySpendavgDailySpend
floatAverage spend per day. An estimate that drifts between calls.
usage»timeseries»meta»projectedSpendprojectedSpend
floatProjected 30-day spend extrapolated from the window. An estimate that drifts between calls.
usage»timeseries»meta»avgInferenceTimeavgInferenceTime
floatAverage inference time in seconds.
usage»timeseries»meta»p50InferenceTimep50InferenceTime
floatMedian inference time in seconds.
usage»timeseries»meta»p90InferenceTimep90InferenceTime
float90th-percentile inference time in seconds.
usage»timeseries»meta»p99InferenceTimep99InferenceTime
float99th-percentile inference time in seconds.
usage»modelmodel
objectPer-model breakdown (from groupBy model).
Properties2 properties
usage»model»datadata
array of objectsrequiredRows for this breakdown.
Properties7 properties
usage»model»data»datedate
stringdateDay bucket.
usage»model»data»modelmodel
stringModel AIR.
usage»model»data»modelNamemodelName
stringHuman-friendly model name. Falls back to the AIR when none exists.
usage»model»data»apiKeyapiKey
stringAPI key UUID.
usage»model»data»avgInferenceTimeavgInferenceTime
float | nullAverage inference time in seconds, or null when there were no inferences.
usage»model»data»p90InferenceTimep90InferenceTime
float | null90th-percentile inference time in seconds, or null when there were no inferences.
usage»model»data»p99InferenceTimep99InferenceTime
float | null99th-percentile inference time in seconds, or null when there were no inferences.
usage»model»metameta
objectrequiredRoll-up totals for a breakdown. Which fields are present depends on the operation.
Properties9 properties
usage»model»meta»totalRequeststotalRequests
integerTotal requests across the window.
usage»model»meta»totalResultstotalResults
integerTotal results produced across the window.
usage»model»meta»totalSpendtotalSpend
floatTotal spend across the window.
usage»model»meta»avgDailySpendavgDailySpend
floatAverage spend per day. An estimate that drifts between calls.
usage»model»meta»projectedSpendprojectedSpend
floatProjected 30-day spend extrapolated from the window. An estimate that drifts between calls.
usage»model»meta»avgInferenceTimeavgInferenceTime
floatAverage inference time in seconds.
usage»model»meta»p50InferenceTimep50InferenceTime
floatMedian inference time in seconds.
usage»model»meta»p90InferenceTimep90InferenceTime
float90th-percentile inference time in seconds.
usage»model»meta»p99InferenceTimep99InferenceTime
float99th-percentile inference time in seconds.
usage»apiKeyapiKey
objectPer-key breakdown (from groupBy apiKey).
Properties2 properties
usage»apiKey»datadata
array of objectsrequiredRows for this breakdown.
Properties7 properties
usage»apiKey»data»datedate
stringdateDay bucket.
usage»apiKey»data»modelmodel
stringModel AIR.
usage»apiKey»data»modelNamemodelName
stringHuman-friendly model name. Falls back to the AIR when none exists.
usage»apiKey»data»apiKeyapiKey
stringAPI key UUID.
usage»apiKey»data»avgInferenceTimeavgInferenceTime
float | nullAverage inference time in seconds, or null when there were no inferences.
usage»apiKey»data»p90InferenceTimep90InferenceTime
float | null90th-percentile inference time in seconds, or null when there were no inferences.
usage»apiKey»data»p99InferenceTimep99InferenceTime
float | null99th-percentile inference time in seconds, or null when there were no inferences.
usage»apiKey»metameta
objectrequiredRoll-up totals for a breakdown. Which fields are present depends on the operation.
Properties9 properties
usage»apiKey»meta»totalRequeststotalRequests
integerTotal requests across the window.
usage»apiKey»meta»totalResultstotalResults
integerTotal results produced across the window.
usage»apiKey»meta»totalSpendtotalSpend
floatTotal spend across the window.
usage»apiKey»meta»avgDailySpendavgDailySpend
floatAverage spend per day. An estimate that drifts between calls.
usage»apiKey»meta»projectedSpendprojectedSpend
floatProjected 30-day spend extrapolated from the window. An estimate that drifts between calls.
usage»apiKey»meta»avgInferenceTimeavgInferenceTime
floatAverage inference time in seconds.
usage»apiKey»meta»p50InferenceTimep50InferenceTime
floatMedian inference time in seconds.
usage»apiKey»meta»p90InferenceTimep90InferenceTime
float90th-percentile inference time in seconds.
usage»apiKey»meta»p99InferenceTimep99InferenceTime
float99th-percentile inference time in seconds.
getUsageErrors
Reliability, sliced the same way getUsageActivity slices spend. Each row splits failures into client errors (4xx) and server errors (5xx), and the meta roll-up carries the window's totalErrors and an errorRate as a percentage.
Group by model or apiKey to see which one is failing.
Request
import { createClient } from '@runware/sdk'
const client = await createClient({ apiKey: process.env.RUNWARE_API_KEY })
await client.connect()
const result = await client.accountManagement({
operation: 'getUsageErrors',
startDate: '2026-07-01',
endDate: '2026-07-06',
groupBy: [
'date',
'model'
]
})import asyncio
import os
from runware import Runware
async def main():
async with Runware(api_key=os.environ["RUNWARE_API_KEY"]) as client:
result = await client.account_management({
"operation": "getUsageErrors",
"startDate": "2026-07-01",
"endDate": "2026-07-06",
"groupBy": [
"date",
"model"
]
})
asyncio.run(main())curl https://api.runware.ai/v1 \
-H "Authorization: Bearer $RUNWARE_API_KEY" \
-H "Content-Type: application/json" \
-d '[
{
"taskType": "accountManagement",
"taskUUID": "cb460b4c-0d63-4fe2-9694-2115b2ce2161",
"operation": "getUsageErrors",
"startDate": "2026-07-01",
"endDate": "2026-07-06",
"groupBy": [
"date",
"model"
]
}
]'runware account getUsageErrors{
"taskType": "accountManagement",
"taskUUID": "cb460b4c-0d63-4fe2-9694-2115b2ce2161",
"operation": "getUsageErrors",
"startDate": "2026-07-01",
"endDate": "2026-07-06",
"groupBy": [
"date",
"model"
]
}taskType
stringrequiredvalue: accountManagementIdentifier for the type of task being performed
taskUUID
stringrequiredUUID v4UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.
operation
stringrequiredvalue: getUsageErrorsThe specific account management operation to perform.
startDate
stringdateStart of the usage window (inclusive).
endDate
stringdateEnd of the usage window (inclusive). Must be on or after startDate, and the span must not exceed 30 days.
models
array of stringsmax items: 100Restrict usage to these model AIRs. Defaults to all models.
apiKeys
array of stringsmax items: 100Restrict usage to these API key UUIDs. Defaults to all keys.
groupBy
array of stringsdefault: date,modelBreakdowns to return.
timezone
stringdefault: UTCIANA timezone name used for day-bucketing.
Response
{
"data": [
{
"taskType": "accountManagement",
"taskUUID": "cb460b4c-0d63-4fe2-9694-2115b2ce2161",
"operation": "getUsageErrors",
"startDate": "2026-07-01",
"endDate": "2026-07-06",
"usage": {
"timeseries": {
"data": [{ "date": "2026-07-03", "clientErrors": 126, "serverErrors": 0 }],
"meta": { "totalErrors": 128, "errorRate": 78.05 }
},
"model": {
"data": [{ "date": "2026-07-03", "model": "bytedance:video-upscaler@standard", "modelName": "Bytedance Video Upscaler", "clientErrors": 126, "serverErrors": 0 }],
"meta": { "totalErrors": 128, "errorRate": 78.05 }
}
}
}
]
}taskType
stringrequiredvalue: accountManagementIdentifier for the type of task this response belongs to.
taskUUID
stringrequiredUUID v4UUID v4 identifier echoed from the original request, used to match async responses to their tasks.
operation
stringrequiredvalue: getUsageErrorsThe account management operation that produced this response.
startDate
stringdateStart of the returned window (inclusive).
endDate
stringdateEnd of the returned window (inclusive).
usage
objectAccount usage statistics.
Properties7 properties
usage»todaytoday
objectUsage stats for today.
usage»last7Dayslast7Days
objectUsage stats for the last 7 days.
usage»last30Dayslast30Days
objectUsage stats for the last 30 days.
usage»totaltotal
objectTotal lifetime usage stats.
usage»timeseriestimeseries
objectPer-day breakdown (from groupBy date).
Properties2 properties
usage»timeseries»datadata
array of objectsrequiredRows for this breakdown.
Properties6 properties
usage»timeseries»data»datedate
stringdateDay bucket.
usage»timeseries»data»modelmodel
stringModel AIR.
usage»timeseries»data»modelNamemodelName
stringHuman-friendly model name. Falls back to the AIR when none exists.
usage»timeseries»data»apiKeyapiKey
stringAPI key UUID.
usage»timeseries»data»clientErrorsclientErrors
integerNumber of 4xx (client) errors in this bucket.
usage»timeseries»data»serverErrorsserverErrors
integerNumber of 5xx (server) errors in this bucket.
usage»timeseries»metameta
objectrequiredRoll-up totals for a breakdown. Which fields are present depends on the operation.
Properties2 properties
usage»timeseries»meta»totalErrorstotalErrors
integerTotal errors across the window.
usage»timeseries»meta»errorRateerrorRate
floatError rate across the window, as a percentage.
usage»modelmodel
objectPer-model breakdown (from groupBy model).
Properties2 properties
usage»model»datadata
array of objectsrequiredRows for this breakdown.
Properties6 properties
usage»model»data»datedate
stringdateDay bucket.
usage»model»data»modelmodel
stringModel AIR.
usage»model»data»modelNamemodelName
stringHuman-friendly model name. Falls back to the AIR when none exists.
usage»model»data»apiKeyapiKey
stringAPI key UUID.
usage»model»data»clientErrorsclientErrors
integerNumber of 4xx (client) errors in this bucket.
usage»model»data»serverErrorsserverErrors
integerNumber of 5xx (server) errors in this bucket.
usage»model»metameta
objectrequiredRoll-up totals for a breakdown. Which fields are present depends on the operation.
Properties2 properties
usage»model»meta»totalErrorstotalErrors
integerTotal errors across the window.
usage»model»meta»errorRateerrorRate
floatError rate across the window, as a percentage.
usage»apiKeyapiKey
objectPer-key breakdown (from groupBy apiKey).
Properties2 properties
usage»apiKey»datadata
array of objectsrequiredRows for this breakdown.
Properties6 properties
usage»apiKey»data»datedate
stringdateDay bucket.
usage»apiKey»data»modelmodel
stringModel AIR.
usage»apiKey»data»modelNamemodelName
stringHuman-friendly model name. Falls back to the AIR when none exists.
usage»apiKey»data»apiKeyapiKey
stringAPI key UUID.
usage»apiKey»data»clientErrorsclientErrors
integerNumber of 4xx (client) errors in this bucket.
usage»apiKey»data»serverErrorsserverErrors
integerNumber of 5xx (server) errors in this bucket.
usage»apiKey»metameta
objectrequiredRoll-up totals for a breakdown. Which fields are present depends on the operation.
Properties2 properties
usage»apiKey»meta»totalErrorstotalErrors
integerTotal errors across the window.
usage»apiKey»meta»errorRateerrorRate
floatError rate across the window, as a percentage.