Get workspace usage over time

curl --request GET \
  --url https://cloud.comfy.org/api/billing/usage/timeseries \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://cloud.comfy.org/api/billing/usage/timeseries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud.comfy.org/api/billing/usage/timeseries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud.comfy.org/api/billing/usage/timeseries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://cloud.comfy.org/api/billing/usage/timeseries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "group_by": "model",
  "granularity": "hour",
  "starting_on": "2023-11-07T05:31:56Z",
  "ending_before": "2023-11-07T05:31:56Z",
  "groups": [
    "<string>"
  ],
  "buckets": [
    {
      "period_start": "2023-11-07T05:31:56Z",
      "period_end": "2023-11-07T05:31:56Z",
      "group_key": "google/nano-banana-2",
      "cost_micros": 1250000
    }
  ],
  "breakdown": [
    {
      "group_key": "google/nano-banana-2",
      "cost_micros": 1250000,
      "share": 0.42
    }
  ],
  "summary": {
    "spend_micros": 2975000,
    "balance": {
      "amount_micros": 4250,
      "prepaid_balance_micros": 2250,
      "cloud_credit_balance_micros": 2000,
      "currency": "USD"
    }
  }
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

billing

Get workspace usage over time

Returns billed usage for the workspace the API key belongs to, split into time buckets and grouped by model, endpoint, or product. Use it to reconcile spend, attribute cost across models, or feed an internal cost report.

Units. cost_micros and spend_micros are millionths of a US dollar, so divide by 1,000,000 to get dollars. The fields under summary.balance are the exception: despite their _micros suffix they are cents, so divide those by 100.

Freshness. Figures are drawn from your invoices rather than from live request traffic, so very recent usage may not appear yet. Treat this as a reporting surface, not a real-time meter.

Empty results. A workspace that has not been billed yet returns empty groups, buckets, and breakdown arrays with a 200, not an error.

GET

api

billing

usage

timeseries

Get workspace usage over time

curl --request GET \
  --url https://cloud.comfy.org/api/billing/usage/timeseries \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://cloud.comfy.org/api/billing/usage/timeseries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://cloud.comfy.org/api/billing/usage/timeseries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://cloud.comfy.org/api/billing/usage/timeseries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://cloud.comfy.org/api/billing/usage/timeseries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "group_by": "model",
  "granularity": "hour",
  "starting_on": "2023-11-07T05:31:56Z",
  "ending_before": "2023-11-07T05:31:56Z",
  "groups": [
    "<string>"
  ],
  "buckets": [
    {
      "period_start": "2023-11-07T05:31:56Z",
      "period_end": "2023-11-07T05:31:56Z",
      "group_key": "google/nano-banana-2",
      "cost_micros": 1250000
    }
  ],
  "breakdown": [
    {
      "group_key": "google/nano-banana-2",
      "cost_micros": 1250000,
      "share": 0.42
    }
  ],
  "summary": {
    "spend_micros": 2975000,
    "balance": {
      "amount_micros": 4250,
      "prepaid_balance_micros": 2250,
      "cloud_credit_balance_micros": 2000,
      "currency": "USD"
    }
  }
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

承認

X-API-Key

string

header

必須

API key authentication. Generate an API key from your account settings at https://platform.comfy.org/profile/api-keys. Pass the key in the X-API-Key header.

クエリパラメータ

group_by

enum<string>

デフォルト:model

How to group spend within each time bucket.

利用可能なオプション:

model,

endpoint,

product

granularity

enum<string>

デフォルト:month

Width of each time bucket.

利用可能なオプション:

hour,

day,

month

starting_on

string<date-time>

Start of the range, inclusive (RFC 3339). Overrides months when set.

ending_before

string<date-time>

End of the range, exclusive (RFC 3339). Defaults to the current hour.

months

integer

デフォルト:6

How many months back to report, counted from ending_before. Ignored when starting_on is set.

必須範囲: 1 <= x <= 24

レスポンス

Success - Usage returned

Billed usage for one workspace over a time range.

group_by

enum<string>

必須

How spend was grouped, echoing the request.

利用可能なオプション:

model,

endpoint,

product

granularity

enum<string>

必須

Width of each bucket, echoing the request.

利用可能なオプション:

hour,

day,

month

starting_on

string<date-time>

必須

Start of the reported range, inclusive.

ending_before

string<date-time>

必須

End of the reported range, exclusive.

groups

string[]

必須

Every group key present in the range, ordered by total spend, highest first. Use it to keep series in a stable order across buckets.

buckets

object[]

必須

One entry per group per time bucket, oldest bucket first. A group with no spend in a bucket is omitted rather than reported as zero.

Show child attributes

breakdown

object[]

必須

Total spend per group across the whole range.

Show child attributes

summary

object

必須

Show child attributes

workflow

node

model

job

file

asset

user

system

billing

Get workspace usage over time

承認

クエリパラメータ

レスポンス