Account Management

Retrieve account details, team information, API keys, and usage statistics for your organization using the account management API.

Introduction

The accountManagement task provides programmatic access to your organization's account information, including team members, API keys, balance, and usage statistics. This is useful for building internal dashboards or monitoring tools that integrate with your Runware account.

Currently, only the getDetails operation is available. Additional operations for managing settings, team members, and API keys will be added in future updates.

Request

Our API always accepts an array of objects as input, where each object represents a specific task to be performed. The structure of the object varies depending on the type of the task. For this section, we will focus on the parameters related to the account management task.

The following JSON snippet shows the basic structure of a request object.

[
  {
    "taskType": "accountManagement",
    "taskUUID": "f4dd3dfe-955f-49d5-a785-7e3b633d6e7a",
    "operation": "getDetails"
  }
]

taskType

const:accountManagement required value: accountManagement

The type of task to perform.

taskUUID

string required UUID v4

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

operation

string required

The specific account management operation to perform.

Allowed values 1 value

Response

Results will be delivered in the format below.

{
  "data": [
    {
      "taskType": "accountManagement",
      "taskUUID": "f4dd3dfe-955f-49d5-a785-7e3b633d6e7a",
      "operation": "getDetails",
      "organizationUUID": "a6379343-9ff2-46a0-996b-e4a7b3057c88",
      "organizationName": "Acme Corporation",
      "AIRSource": "acme",
      "balance": 2450.75,
      "team": [
        {
          "name": "John Smith",
          "email": "john.smith@acme.com",
          "roles": [
            "Owner"
          ],
          "joinedAt": "2024-01-15T10:30:00Z"
        },
        {
          "name": "Emily Johnson",
          "email": "emily.johnson@acme.com",
          "roles": [
            "Admin"
          ],
          "joinedAt": "2024-03-22T14:20:00Z"
        },
        {
          "name": "Michael Chen",
          "email": "michael.chen@acme.com",
          "roles": [
            "Developer"
          ],
          "joinedAt": "2024-05-10T09:15:00Z"
        }
      ],
      "apiKeys": [
        {
          "name": "Production API Key",
          "apiKey": "YHluz4gk5KU4ZZWr****************",
          "description": "Main production environment key",
          "createdAt": "2024-01-20T11:00:00Z",
          "enabled": true,
          "requests": 15420,
          "lastUsedAt": "2025-10-12T08:45:30Z"
        },
        {
          "name": "Development API Key",
          "apiKey": "fhVbIFjuDlSwZJgY****************",
          "description": "Testing and development",
          "createdAt": "2024-02-05T16:30:00Z",
          "enabled": true,
          "requests": 3287,
          "lastUsedAt": "2025-10-11T15:22:18Z"
        }
      ],
      "usage": {
        "total": {
          "credits": 48920.50,
          "requests": 2540318
        },
        "today": {
          "credits": 35.80,
          "requests": 1850
        },
        "last7Days": {
          "credits": 412.25,
          "requests": 21400
        },
        "last30Days": {
          "credits": 1685.90,
          "requests": 87560
        }
      }
    }
  ]
}

taskType

string required value: accountManagement

Identifier for the type of task being performed

taskUUID

string required UUID v4

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

organizationName

string required

The name of the organization.

organizationUUID

string required UUID v4

Unique identifier for the organization.

balance

object required

Current account balance and currency.

Properties 3 properties
balance » amount

amount

float required

Current balance amount.

balance » freeBalance

freeBalance

float

Available free credit balance.

balance » currency

currency

string required

Currency code (e.g., USD).

team

array of objects required

List of team members.

Properties 4 properties
team » name

name

string required

Full name of the team member.

team » email

email

string required EMAIL

Email address of the team member.

team » roles

roles

array of strings required

Roles assigned to the team member.

team » joinedAt

joinedAt

string DATE-TIME

Date and time when the member joined.

apiKeys

array of objects required

List of API keys associated with the account.

Properties 7 properties
apiKeys » apiKey

apiKey

string required

The API key string (partially masked).

apiKeys » name

name

string required

Name or label for the API key.

apiKeys » description

description

string

Description of the API key.

apiKeys » enabled

enabled

boolean required

Whether the API key is active.

apiKeys » createdAt

createdAt

string required DATE-TIME

Date and time when the key was created.

apiKeys » lastUsedAt

lastUsedAt

string DATE-TIME

Date and time when the key was last used.

apiKeys » requests

requests

integer

Total number of requests made with this key.

usage

object required

Usage statistics for different time periods.

Properties 4 properties
usage » today

today

object required

Usage stats for today.

Properties 2 properties
usage » today » credits
credits
float required

Total credits consumed.

usage » today » requests
requests
integer required

Total API requests made.

usage » last7Days

last7Days

object required

Usage stats for the last 7 days.

Properties 2 properties
usage » last7Days » credits
credits
float required

Total credits consumed.

usage » last7Days » requests
requests
integer required

Total API requests made.

usage » last30Days

last30Days

object required

Usage stats for the last 30 days.

Properties 2 properties
usage » last30Days » credits
credits
float required

Total credits consumed.

usage » last30Days » requests
requests
integer required

Total API requests made.

usage » total

total

object required

Total lifetime usage stats.

Properties 2 properties
usage » total » credits
credits
float required

Total credits consumed.

usage » total » requests
requests
integer required

Total API requests made.