Billing

Query grouped usage cost subtotals for an account.

Returns rated dollar subtotals for usage over a time range, grouped by up to two of: HOUR, DAY, MODEL, USER, or API_KEY. Unlike GET /billingUsage (metered quantities) and GET /billing/summary (line items by billing category), this endpoint returns rated costs broken down by caller-supplied dimensions, with pagination and an account-wide subtotal. Requires account administrator access for ACCOUNT scope; SELF scope returns costs for the authenticated principal only.

POST

accounts

{account_id}

usageCosts:query

Query grouped usage cost subtotals for an account.

curl --request POST \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/usageCosts:query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startTime": "2023-11-07T05:31:56Z",
  "endTime": "2023-11-07T05:31:56Z",
  "scope": "SCOPE_UNSPECIFIED",
  "groupBy": [
    "DIMENSION_UNSPECIFIED"
  ],
  "filter": {
    "model": "<string>",
    "user": "<string>",
    "apiKeyId": "<string>",
    "sessionId": "<string>"
  },
  "pageSize": 123,
  "pageToken": "<string>"
}
'

import requests

url = "https://api.fireworks.ai/v1/accounts/{account_id}/usageCosts:query"

payload = {
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "scope": "SCOPE_UNSPECIFIED",
    "groupBy": ["DIMENSION_UNSPECIFIED"],
    "filter": {
        "model": "<string>",
        "user": "<string>",
        "apiKeyId": "<string>",
        "sessionId": "<string>"
    },
    "pageSize": 123,
    "pageToken": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    startTime: '2023-11-07T05:31:56Z',
    endTime: '2023-11-07T05:31:56Z',
    scope: 'SCOPE_UNSPECIFIED',
    groupBy: ['DIMENSION_UNSPECIFIED'],
    filter: {
      model: '<string>',
      user: '<string>',
      apiKeyId: '<string>',
      sessionId: '<string>'
    },
    pageSize: 123,
    pageToken: '<string>'
  })
};

fetch('https://api.fireworks.ai/v1/accounts/{account_id}/usageCosts:query', 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://api.fireworks.ai/v1/accounts/{account_id}/usageCosts:query",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'startTime' => '2023-11-07T05:31:56Z',
    'endTime' => '2023-11-07T05:31:56Z',
    'scope' => 'SCOPE_UNSPECIFIED',
    'groupBy' => [
        'DIMENSION_UNSPECIFIED'
    ],
    'filter' => [
        'model' => '<string>',
        'user' => '<string>',
        'apiKeyId' => '<string>',
        'sessionId' => '<string>'
    ],
    'pageSize' => 123,
    'pageToken' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.fireworks.ai/v1/accounts/{account_id}/usageCosts:query"

	payload := strings.NewReader("{\n  \"startTime\": \"2023-11-07T05:31:56Z\",\n  \"endTime\": \"2023-11-07T05:31:56Z\",\n  \"scope\": \"SCOPE_UNSPECIFIED\",\n  \"groupBy\": [\n    \"DIMENSION_UNSPECIFIED\"\n  ],\n  \"filter\": {\n    \"model\": \"<string>\",\n    \"user\": \"<string>\",\n    \"apiKeyId\": \"<string>\",\n    \"sessionId\": \"<string>\"\n  },\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.fireworks.ai/v1/accounts/{account_id}/usageCosts:query")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"startTime\": \"2023-11-07T05:31:56Z\",\n  \"endTime\": \"2023-11-07T05:31:56Z\",\n  \"scope\": \"SCOPE_UNSPECIFIED\",\n  \"groupBy\": [\n    \"DIMENSION_UNSPECIFIED\"\n  ],\n  \"filter\": {\n    \"model\": \"<string>\",\n    \"user\": \"<string>\",\n    \"apiKeyId\": \"<string>\",\n    \"sessionId\": \"<string>\"\n  },\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fireworks.ai/v1/accounts/{account_id}/usageCosts:query")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"startTime\": \"2023-11-07T05:31:56Z\",\n  \"endTime\": \"2023-11-07T05:31:56Z\",\n  \"scope\": \"SCOPE_UNSPECIFIED\",\n  \"groupBy\": [\n    \"DIMENSION_UNSPECIFIED\"\n  ],\n  \"filter\": {\n    \"model\": \"<string>\",\n    \"user\": \"<string>\",\n    \"apiKeyId\": \"<string>\",\n    \"sessionId\": \"<string>\"\n  },\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\"\n}"

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

{
  "rows": [
    {
      "dimensions": {
        "startTime": "2023-11-07T05:31:56Z",
        "model": "<string>",
        "user": "<string>",
        "apiKeyId": "<string>",
        "unattributedDimensions": [
          "DIMENSION_UNSPECIFIED"
        ],
        "unknownModel": true
      },
      "subtotal": {
        "currencyCode": "<string>",
        "units": "<string>",
        "nanos": 123
      }
    }
  ],
  "nextPageToken": "<string>",
  "subtotal": {
    "currencyCode": "<string>",
    "units": "<string>",
    "nanos": 123
  },
  "evaluationTime": "2023-11-07T05:31:56Z",
  "attributionCompleteness": "ATTRIBUTION_COMPLETENESS_UNSPECIFIED"
}

Authorizations

Authorization

string

header

required

Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>

Path Parameters

account_id

string

required

The Account Id

Body

application/json

Request for grouped usage cost subtotals over a time range.

startTime

string<date-time>

Inclusive lower bound for usage event timestamps.

endTime

string<date-time>

Exclusive upper bound for usage event timestamps.

scope

enum<string>

default:SCOPE_UNSPECIFIED

ACCOUNT requires account administrator access. SELF derives the user ID from the authenticated principal.

Available options:

SCOPE_UNSPECIFIED,

ACCOUNT,

SELF

groupBy

enum<string>[]

Dimensions to group by. At most two dimensions may be combined. HOUR and DAY are mutually exclusive. SESSION is intentionally filter-only to prevent high-cardinality enumeration.

Available options:

DIMENSION_UNSPECIFIED,

HOUR,

MODEL,

USER,

API_KEY,

DAY

filter

object

Optional exact-match filters. All populated fields are ANDed.

Show child attributes

pageSize

integer<int32>

For paginated queries, the maximum number of grouped values to return. A page can contain more rows when each value spans multiple time buckets. Zero uses the server default; values above the maximum are clamped.

pageToken

string

Opaque token from a previous response. Set this to retrieve the next page while keeping all other request fields unchanged.

Maximum string length: 4096

Response

200 - application/json

A successful response.

rows

object[]

Cost rows for the requested dimensions. A successful response contains at most 10,100 rows and is limited to 4 MiB.

Show child attributes

nextPageToken

string

Opaque token for the next page. Empty when no additional page is available.

subtotal

object

Subtotal for the complete query.

Show child attributes

evaluationTime

string<date-time>

read-only

Time when this result was evaluated.

attributionCompleteness

enum<string>

default:ATTRIBUTION_COMPLETENESS_UNSPECIFIED

read-only

Whether the result may omit usage without a user ID. INCOMPLETE means the query filters by user, so historical unattributed usage may be excluded. The amount excluded is unknown.

Available options:

ATTRIBUTION_COMPLETENESS_UNSPECIFIED,

COMPLETE,

INCOMPLETE,

UNKNOWN

⌘I

Query grouped usage cost subtotals for an account.

curl --request POST \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/usageCosts:query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startTime": "2023-11-07T05:31:56Z",
  "endTime": "2023-11-07T05:31:56Z",
  "scope": "SCOPE_UNSPECIFIED",
  "groupBy": [
    "DIMENSION_UNSPECIFIED"
  ],
  "filter": {
    "model": "<string>",
    "user": "<string>",
    "apiKeyId": "<string>",
    "sessionId": "<string>"
  },
  "pageSize": 123,
  "pageToken": "<string>"
}
'

import requests

url = "https://api.fireworks.ai/v1/accounts/{account_id}/usageCosts:query"

payload = {
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "scope": "SCOPE_UNSPECIFIED",
    "groupBy": ["DIMENSION_UNSPECIFIED"],
    "filter": {
        "model": "<string>",
        "user": "<string>",
        "apiKeyId": "<string>",
        "sessionId": "<string>"
    },
    "pageSize": 123,
    "pageToken": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    startTime: '2023-11-07T05:31:56Z',
    endTime: '2023-11-07T05:31:56Z',
    scope: 'SCOPE_UNSPECIFIED',
    groupBy: ['DIMENSION_UNSPECIFIED'],
    filter: {
      model: '<string>',
      user: '<string>',
      apiKeyId: '<string>',
      sessionId: '<string>'
    },
    pageSize: 123,
    pageToken: '<string>'
  })
};

fetch('https://api.fireworks.ai/v1/accounts/{account_id}/usageCosts:query', 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://api.fireworks.ai/v1/accounts/{account_id}/usageCosts:query",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'startTime' => '2023-11-07T05:31:56Z',
    'endTime' => '2023-11-07T05:31:56Z',
    'scope' => 'SCOPE_UNSPECIFIED',
    'groupBy' => [
        'DIMENSION_UNSPECIFIED'
    ],
    'filter' => [
        'model' => '<string>',
        'user' => '<string>',
        'apiKeyId' => '<string>',
        'sessionId' => '<string>'
    ],
    'pageSize' => 123,
    'pageToken' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.fireworks.ai/v1/accounts/{account_id}/usageCosts:query"

	payload := strings.NewReader("{\n  \"startTime\": \"2023-11-07T05:31:56Z\",\n  \"endTime\": \"2023-11-07T05:31:56Z\",\n  \"scope\": \"SCOPE_UNSPECIFIED\",\n  \"groupBy\": [\n    \"DIMENSION_UNSPECIFIED\"\n  ],\n  \"filter\": {\n    \"model\": \"<string>\",\n    \"user\": \"<string>\",\n    \"apiKeyId\": \"<string>\",\n    \"sessionId\": \"<string>\"\n  },\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.fireworks.ai/v1/accounts/{account_id}/usageCosts:query")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"startTime\": \"2023-11-07T05:31:56Z\",\n  \"endTime\": \"2023-11-07T05:31:56Z\",\n  \"scope\": \"SCOPE_UNSPECIFIED\",\n  \"groupBy\": [\n    \"DIMENSION_UNSPECIFIED\"\n  ],\n  \"filter\": {\n    \"model\": \"<string>\",\n    \"user\": \"<string>\",\n    \"apiKeyId\": \"<string>\",\n    \"sessionId\": \"<string>\"\n  },\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fireworks.ai/v1/accounts/{account_id}/usageCosts:query")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"startTime\": \"2023-11-07T05:31:56Z\",\n  \"endTime\": \"2023-11-07T05:31:56Z\",\n  \"scope\": \"SCOPE_UNSPECIFIED\",\n  \"groupBy\": [\n    \"DIMENSION_UNSPECIFIED\"\n  ],\n  \"filter\": {\n    \"model\": \"<string>\",\n    \"user\": \"<string>\",\n    \"apiKeyId\": \"<string>\",\n    \"sessionId\": \"<string>\"\n  },\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\"\n}"

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

{
  "rows": [
    {
      "dimensions": {
        "startTime": "2023-11-07T05:31:56Z",
        "model": "<string>",
        "user": "<string>",
        "apiKeyId": "<string>",
        "unattributedDimensions": [
          "DIMENSION_UNSPECIFIED"
        ],
        "unknownModel": true
      },
      "subtotal": {
        "currencyCode": "<string>",
        "units": "<string>",
        "nanos": 123
      }
    }
  ],
  "nextPageToken": "<string>",
  "subtotal": {
    "currencyCode": "<string>",
    "units": "<string>",
    "nanos": 123
  },
  "evaluationTime": "2023-11-07T05:31:56Z",
  "attributionCompleteness": "ATTRIBUTION_COMPLETENESS_UNSPECIFIED"
}