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: accountManagement: Identifier for the type of task being performed

taskUUID stringrequiredUUID v4: UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.

operation stringrequiredvalue: getDetails: The 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: accountManagement: Identifier for the type of task this response belongs to.

taskUUID stringrequiredUUID v4: UUID v4 identifier echoed from the original request, used to match async responses to their tasks.

operation stringrequiredvalue: getDetails: The account management operation that produced this response.

organizationName string: The name of the organization.

organizationUUID stringUUID v4: Unique identifier for the organization.

balance object

Current account balance and currency.

Properties3 properties

balance » amount amount floatrequired: Current balance amount.

balance » freeBalance freeBalance float: Available free credit balance.

balance » currency currency stringrequired: Currency code.

team array of objects

List of team members.

Properties4 properties

team » name name stringrequired: Full name of the team member.

team » email email stringrequiredemail: Email address of the team member.

team » roles roles array of stringsrequired

Each 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 » joinedAt joinedAt stringdate-time: Date and time when the member joined.

apiKeys array of objects

List of API keys associated with the account.

Properties7 properties

apiKeys » apiKey apiKey stringrequired: The API key string (partially masked).

apiKeys » name name stringrequired: Name or label for the API key.

apiKeys » description description string: Description of the API key.

apiKeys » enabled enabled booleanrequired: Whether the API key is active.

apiKeys » createdAt createdAt stringrequireddate-time: Date and time when the key was created.

apiKeys » lastUsedAt lastUsedAt stringdate-time: Date and time when the key was last used.

apiKeys » requests requests integer: Total number of requests made with this key.

usage object

Account usage statistics.

Properties4 properties

usage » today today object

Usage stats for today.

Properties2 properties

usage » today » credits credits floatrequired: Total credits consumed.

usage » today » requests requests integerrequired: Total API requests made.

usage » last7Days last7Days object

Usage stats for the last 7 days.

Properties2 properties

usage » last7Days » credits credits floatrequired: Total credits consumed.

usage » last7Days » requests requests integerrequired: Total API requests made.

usage » last30Days last30Days object

Usage stats for the last 30 days.

Properties2 properties

usage » last30Days » credits credits floatrequired: Total credits consumed.

usage » last30Days » requests requests integerrequired: Total API requests made.

usage » total total object

Total lifetime usage stats.

Properties2 properties

usage » total » credits credits floatrequired: Total credits consumed.

usage » total » requests requests integerrequired: Total API requests made.

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: accountManagement: Identifier for the type of task being performed

taskUUID stringrequiredUUID v4: UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.

operation stringrequiredvalue: getUsageActivity: The specific account management operation to perform.

startDate stringdate: Start of the usage window (inclusive).

endDate stringdate: End of the usage window (inclusive). Must be on or after startDate, and the span must not exceed 30 days.

models array of stringsmax items: 100: Restrict usage to these model AIRs. Defaults to all models.

apiKeys array of stringsmax items: 100: Restrict usage to these API key UUIDs. Defaults to all keys.

groupBy array of stringsdefault: date,model: Breakdowns to return.

timezone stringdefault: UTC: IANA 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: accountManagement: Identifier for the type of task this response belongs to.

taskUUID stringrequiredUUID v4: UUID v4 identifier echoed from the original request, used to match async responses to their tasks.

operation stringrequiredvalue: getUsageActivity: The account management operation that produced this response.

startDate stringdate: Start of the returned window (inclusive).

endDate stringdate: End of the returned window (inclusive).

usage object

Account usage statistics.

Properties7 properties

usage » today today object: Usage stats for today.

usage » last7Days last7Days object: Usage stats for the last 7 days.

usage » last30Days last30Days object: Usage stats for the last 30 days.

usage » total total object: Total lifetime usage stats.

usage » timeseries timeseries object

Per-day breakdown (from groupBy date).

Properties2 properties

usage » timeseries » data data array of objectsrequired

Rows for this breakdown.

Properties6 properties

usage » timeseries » data » date date stringdate: Day bucket.

usage » timeseries » data » model model string: Model AIR.

usage » timeseries » data » modelName modelName string: Human-friendly model name. Falls back to the AIR when none exists.

usage » timeseries » data » apiKey apiKey string: API key UUID.

usage » timeseries » data » count count integer: Number of requests in this bucket.

usage » timeseries » data » spend spend float: Amount spent in this bucket.

usage » timeseries » meta meta objectrequired

Roll-up totals for a breakdown. Which fields are present depends on the operation.

Properties5 properties

usage » timeseries » meta » totalRequests totalRequests integer: Total requests across the window.

usage » timeseries » meta » totalResults totalResults integer: Total results produced across the window.

usage » timeseries » meta » totalSpend totalSpend float: Total spend across the window.

usage » timeseries » meta » avgDailySpend avgDailySpend float: Average spend per day. An estimate that drifts between calls.

usage » timeseries » meta » projectedSpend projectedSpend float: Projected 30-day spend extrapolated from the window. An estimate that drifts between calls.

usage » model model object

Per-model breakdown (from groupBy model).

Properties2 properties

usage » model » data data array of objectsrequired

Rows for this breakdown.

Properties6 properties

usage » model » data » date date stringdate: Day bucket.

usage » model » data » model model string: Model AIR.

usage » model » data » modelName modelName string: Human-friendly model name. Falls back to the AIR when none exists.

usage » model » data » apiKey apiKey string: API key UUID.

usage » model » data » count count integer: Number of requests in this bucket.

usage » model » data » spend spend float: Amount spent in this bucket.

usage » model » meta meta objectrequired

Roll-up totals for a breakdown. Which fields are present depends on the operation.

Properties5 properties

usage » model » meta » totalRequests totalRequests integer: Total requests across the window.

usage » model » meta » totalResults totalResults integer: Total results produced across the window.

usage » model » meta » totalSpend totalSpend float: Total spend across the window.

usage » model » meta » avgDailySpend avgDailySpend float: Average spend per day. An estimate that drifts between calls.

usage » model » meta » projectedSpend projectedSpend float: Projected 30-day spend extrapolated from the window. An estimate that drifts between calls.

usage » apiKey apiKey object

Per-key breakdown (from groupBy apiKey).

Properties2 properties

usage » apiKey » data data array of objectsrequired

Rows for this breakdown.

Properties6 properties

usage » apiKey » data » date date stringdate: Day bucket.

usage » apiKey » data » model model string: Model AIR.

usage » apiKey » data » modelName modelName string: Human-friendly model name. Falls back to the AIR when none exists.

usage » apiKey » data » apiKey apiKey string: API key UUID.

usage » apiKey » data » count count integer: Number of requests in this bucket.

usage » apiKey » data » spend spend float: Amount spent in this bucket.

usage » apiKey » meta meta objectrequired

Roll-up totals for a breakdown. Which fields are present depends on the operation.

Properties5 properties

usage » apiKey » meta » totalRequests totalRequests integer: Total requests across the window.

usage » apiKey » meta » totalResults totalResults integer: Total results produced across the window.

usage » apiKey » meta » totalSpend totalSpend float: Total spend across the window.

usage » apiKey » meta » avgDailySpend avgDailySpend float: Average spend per day. An estimate that drifts between calls.

usage » apiKey » meta » projectedSpend projectedSpend float: Projected 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: accountManagement: Identifier for the type of task being performed

taskUUID stringrequiredUUID v4: UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.

operation stringrequiredvalue: getUsagePerformance: The specific account management operation to perform.

startDate stringdate: Start of the usage window (inclusive).

endDate stringdate: End of the usage window (inclusive). Must be on or after startDate, and the span must not exceed 30 days.

models array of stringsmax items: 100: Restrict usage to these model AIRs. Defaults to all models.

apiKeys array of stringsmax items: 100: Restrict usage to these API key UUIDs. Defaults to all keys.

groupBy array of stringsdefault: date,model: Breakdowns to return.

timezone stringdefault: UTC: IANA 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: accountManagement: Identifier for the type of task this response belongs to.

taskUUID stringrequiredUUID v4: UUID v4 identifier echoed from the original request, used to match async responses to their tasks.

operation stringrequiredvalue: getUsagePerformance: The account management operation that produced this response.

startDate stringdate: Start of the returned window (inclusive).

endDate stringdate: End of the returned window (inclusive).

usage object

Account usage statistics.

Properties7 properties

usage » today today object: Usage stats for today.

usage » last7Days last7Days object: Usage stats for the last 7 days.

usage » last30Days last30Days object: Usage stats for the last 30 days.

usage » total total object: Total lifetime usage stats.

usage » timeseries timeseries object

Per-day breakdown (from groupBy date).

Properties2 properties

usage » timeseries » data data array of objectsrequired

Rows for this breakdown.

Properties7 properties

usage » timeseries » data » date date stringdate: Day bucket.

usage » timeseries » data » model model string: Model AIR.

usage » timeseries » data » modelName modelName string: Human-friendly model name. Falls back to the AIR when none exists.

usage » timeseries » data » apiKey apiKey string: API key UUID.

usage » timeseries » data » avgInferenceTime avgInferenceTime float | null: Average inference time in seconds, or null when there were no inferences.

usage » timeseries » data » p90InferenceTime p90InferenceTime float | null: 90th-percentile inference time in seconds, or null when there were no inferences.

usage » timeseries » data » p99InferenceTime p99InferenceTime float | null: 99th-percentile inference time in seconds, or null when there were no inferences.

usage » timeseries » meta meta objectrequired

Roll-up totals for a breakdown. Which fields are present depends on the operation.

Properties9 properties

usage » timeseries » meta » totalRequests totalRequests integer: Total requests across the window.

usage » timeseries » meta » totalResults totalResults integer: Total results produced across the window.

usage » timeseries » meta » totalSpend totalSpend float: Total spend across the window.

usage » timeseries » meta » avgDailySpend avgDailySpend float: Average spend per day. An estimate that drifts between calls.

usage » timeseries » meta » projectedSpend projectedSpend float: Projected 30-day spend extrapolated from the window. An estimate that drifts between calls.

usage » timeseries » meta » avgInferenceTime avgInferenceTime float: Average inference time in seconds.

usage » timeseries » meta » p50InferenceTime p50InferenceTime float: Median inference time in seconds.

usage » timeseries » meta » p90InferenceTime p90InferenceTime float: 90th-percentile inference time in seconds.

usage » timeseries » meta » p99InferenceTime p99InferenceTime float: 99th-percentile inference time in seconds.

usage » model model object

Per-model breakdown (from groupBy model).

Properties2 properties

usage » model » data data array of objectsrequired

Rows for this breakdown.

Properties7 properties

usage » model » data » date date stringdate: Day bucket.

usage » model » data » model model string: Model AIR.

usage » model » data » modelName modelName string: Human-friendly model name. Falls back to the AIR when none exists.

usage » model » data » apiKey apiKey string: API key UUID.

usage » model » data » avgInferenceTime avgInferenceTime float | null: Average inference time in seconds, or null when there were no inferences.

usage » model » data » p90InferenceTime p90InferenceTime float | null: 90th-percentile inference time in seconds, or null when there were no inferences.

usage » model » data » p99InferenceTime p99InferenceTime float | null: 99th-percentile inference time in seconds, or null when there were no inferences.

usage » model » meta meta objectrequired

Roll-up totals for a breakdown. Which fields are present depends on the operation.

Properties9 properties

usage » model » meta » totalRequests totalRequests integer: Total requests across the window.

usage » model » meta » totalResults totalResults integer: Total results produced across the window.

usage » model » meta » totalSpend totalSpend float: Total spend across the window.

usage » model » meta » avgDailySpend avgDailySpend float: Average spend per day. An estimate that drifts between calls.

usage » model » meta » projectedSpend projectedSpend float: Projected 30-day spend extrapolated from the window. An estimate that drifts between calls.

usage » model » meta » avgInferenceTime avgInferenceTime float: Average inference time in seconds.

usage » model » meta » p50InferenceTime p50InferenceTime float: Median inference time in seconds.

usage » model » meta » p90InferenceTime p90InferenceTime float: 90th-percentile inference time in seconds.

usage » model » meta » p99InferenceTime p99InferenceTime float: 99th-percentile inference time in seconds.

usage » apiKey apiKey object

Per-key breakdown (from groupBy apiKey).

Properties2 properties

usage » apiKey » data data array of objectsrequired

Rows for this breakdown.

Properties7 properties

usage » apiKey » data » date date stringdate: Day bucket.

usage » apiKey » data » model model string: Model AIR.

usage » apiKey » data » modelName modelName string: Human-friendly model name. Falls back to the AIR when none exists.

usage » apiKey » data » apiKey apiKey string: API key UUID.

usage » apiKey » data » avgInferenceTime avgInferenceTime float | null: Average inference time in seconds, or null when there were no inferences.

usage » apiKey » data » p90InferenceTime p90InferenceTime float | null: 90th-percentile inference time in seconds, or null when there were no inferences.

usage » apiKey » data » p99InferenceTime p99InferenceTime float | null: 99th-percentile inference time in seconds, or null when there were no inferences.

usage » apiKey » meta meta objectrequired

Roll-up totals for a breakdown. Which fields are present depends on the operation.

Properties9 properties

usage » apiKey » meta » totalRequests totalRequests integer: Total requests across the window.

usage » apiKey » meta » totalResults totalResults integer: Total results produced across the window.

usage » apiKey » meta » totalSpend totalSpend float: Total spend across the window.

usage » apiKey » meta » avgDailySpend avgDailySpend float: Average spend per day. An estimate that drifts between calls.

usage » apiKey » meta » projectedSpend projectedSpend float: Projected 30-day spend extrapolated from the window. An estimate that drifts between calls.

usage » apiKey » meta » avgInferenceTime avgInferenceTime float: Average inference time in seconds.

usage » apiKey » meta » p50InferenceTime p50InferenceTime float: Median inference time in seconds.

usage » apiKey » meta » p90InferenceTime p90InferenceTime float: 90th-percentile inference time in seconds.

usage » apiKey » meta » p99InferenceTime p99InferenceTime float: 99th-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: accountManagement: Identifier for the type of task being performed

taskUUID stringrequiredUUID v4: UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.

operation stringrequiredvalue: getUsageErrors: The specific account management operation to perform.

startDate stringdate: Start of the usage window (inclusive).

endDate stringdate: End of the usage window (inclusive). Must be on or after startDate, and the span must not exceed 30 days.

models array of stringsmax items: 100: Restrict usage to these model AIRs. Defaults to all models.

apiKeys array of stringsmax items: 100: Restrict usage to these API key UUIDs. Defaults to all keys.

groupBy array of stringsdefault: date,model: Breakdowns to return.

timezone stringdefault: UTC: IANA 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: accountManagement: Identifier for the type of task this response belongs to.

taskUUID stringrequiredUUID v4: UUID v4 identifier echoed from the original request, used to match async responses to their tasks.

operation stringrequiredvalue: getUsageErrors: The account management operation that produced this response.

startDate stringdate: Start of the returned window (inclusive).

endDate stringdate: End of the returned window (inclusive).

usage object

Account usage statistics.

Properties7 properties

usage » today today object: Usage stats for today.

usage » last7Days last7Days object: Usage stats for the last 7 days.

usage » last30Days last30Days object: Usage stats for the last 30 days.

usage » total total object: Total lifetime usage stats.

usage » timeseries timeseries object

Per-day breakdown (from groupBy date).

Properties2 properties

usage » timeseries » data data array of objectsrequired

Rows for this breakdown.

Properties6 properties

usage » timeseries » data » date date stringdate: Day bucket.

usage » timeseries » data » model model string: Model AIR.

usage » timeseries » data » modelName modelName string: Human-friendly model name. Falls back to the AIR when none exists.

usage » timeseries » data » apiKey apiKey string: API key UUID.

usage » timeseries » data » clientErrors clientErrors integer: Number of 4xx (client) errors in this bucket.

usage » timeseries » data » serverErrors serverErrors integer: Number of 5xx (server) errors in this bucket.

usage » timeseries » meta meta objectrequired

Roll-up totals for a breakdown. Which fields are present depends on the operation.

Properties2 properties

usage » timeseries » meta » totalErrors totalErrors integer: Total errors across the window.

usage » timeseries » meta » errorRate errorRate float: Error rate across the window, as a percentage.

usage » model model object

Per-model breakdown (from groupBy model).

Properties2 properties

usage » model » data data array of objectsrequired

Rows for this breakdown.

Properties6 properties

usage » model » data » date date stringdate: Day bucket.

usage » model » data » model model string: Model AIR.

usage » model » data » modelName modelName string: Human-friendly model name. Falls back to the AIR when none exists.

usage » model » data » apiKey apiKey string: API key UUID.

usage » model » data » clientErrors clientErrors integer: Number of 4xx (client) errors in this bucket.

usage » model » data » serverErrors serverErrors integer: Number of 5xx (server) errors in this bucket.

usage » model » meta meta objectrequired

Roll-up totals for a breakdown. Which fields are present depends on the operation.

Properties2 properties

usage » model » meta » totalErrors totalErrors integer: Total errors across the window.

usage » model » meta » errorRate errorRate float: Error rate across the window, as a percentage.

usage » apiKey apiKey object

Per-key breakdown (from groupBy apiKey).

Properties2 properties

usage » apiKey » data data array of objectsrequired

Rows for this breakdown.

Properties6 properties

usage » apiKey » data » date date stringdate: Day bucket.

usage » apiKey » data » model model string: Model AIR.

usage » apiKey » data » modelName modelName string: Human-friendly model name. Falls back to the AIR when none exists.

usage » apiKey » data » apiKey apiKey string: API key UUID.

usage » apiKey » data » clientErrors clientErrors integer: Number of 4xx (client) errors in this bucket.

usage » apiKey » data » serverErrors serverErrors integer: Number of 5xx (server) errors in this bucket.

usage » apiKey » meta meta objectrequired

Roll-up totals for a breakdown. Which fields are present depends on the operation.

Properties2 properties

usage » apiKey » meta » totalErrors totalErrors integer: Total errors across the window.

usage » apiKey » meta » errorRate errorRate float: Error rate across the window, as a percentage.