6 image models · capabilities and pricing in one placeSee pricing →

OGA DEVELOPER CENTER

API v1 · Last verified 2026-08-15

List usage

List task usage and settlement records for the current API key.

GET/api/v1/account/usage
Browse common endpoints

Overview

Filter by model, operation, route row, and status. Public fields use channel_row_id; do not depend on an internal parent-channel identifier.

Authentication: Bearer API key

Request

Query parameters

NameTypeDescription
pageintegerPage number, starting at 1.
page_sizeintegerItems per page, 1–100; default 20.
model_idstringModel ID.
operationgeneration | edit | variationImage operation.
channel_row_idstringPublished route-row ID.
statusstringUsage record status.

Response

JSON endpoints use the standard response envelope. HTTP status represents the request outcome; business errors are not disguised as HTTP 200.

HTTPMeaning
200Request succeeded
400Invalid business parameter or filter
401Missing or invalid API key
403API key disabled or access forbidden
422Request-structure validation failed
500Internal service error

Complete success example (optional fields vary by state)

{
  "code": 0,
  "message": "success",
  "data": {
    "summary": {
      "currency": "USD",
      "request_count": 0,
      "success_count": 0,
      "failure_count": 0,
      "completed_image_count": 0,
      "reserved_micro": 0,
      "reserved_usd": "0.000000",
      "charged_micro": 0,
      "charged_usd": "0.000000",
      "refunded_micro": 0,
      "refunded_usd": "0.000000",
      "released_micro": 0,
      "released_usd": "0.000000",
      "net_consumed_micro": 0,
      "net_consumed_usd": "0.000000"
    },
    "items": [],
    "total": 0,
    "page": 1,
    "page_size": 20
  },
  "request_id": "8f25b42f-2ed1-4ad7-99de-61d7f779bc7b",
  "timestamp": "2026-08-10T00:00:00Z"
}

Important boundaries

  • This endpoint is scoped to the current API key, not the account-wide console session view.

Open the machine-readable OpenAPI

Code & API explorer

GET · /api/v1/account/usage

curl -X GET "$OGA_BASE_URL/api/v1/account/usage?page=1&page_size=20" \
  -H "Authorization: Bearer <YOUR_OGA_API_KEY>" \
  -H "X-Request-Id: <UUID_V4>" \
  -H "Accept-Language: en-US"