curl --request GET \
--url https://flowra.dev/api/v1/usage \
--header 'x-api-key: <api-key>'import requests
url = "https://flowra.dev/api/v1/usage"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://flowra.dev/api/v1/usage', 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://flowra.dev/api/v1/usage",
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://flowra.dev/api/v1/usage"
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))
}HttpResponse<String> response = Unirest.get("https://flowra.dev/api/v1/usage")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/usage")
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{
"success": true,
"message": "Operation completed successfully",
"data": {
"items": [
{
"id": "",
"userId": "",
"projectId": "",
"workflowId": "",
"executionId": "",
"eUID": "",
"externalUserName": "",
"type": "ai_model",
"creditAmount": 0,
"delta": 0,
"entryType": "debit",
"usdCost": 0,
"platformCostUsd": 0,
"metadata": {},
"createdAt": ""
}
],
"total": 0,
"summary": {
"byType": {
"ai_model": 0,
"tool": 0,
"sandbox": 0,
"browser": 0,
"workflow": 0,
"media": 0,
"connected_account": 0
},
"total": 0,
"count": 0
}
}
}Credit usage ledger (API key)
Paginated credit usage for the authenticated project. Filter by workflow, execution, thread, or external user.
curl --request GET \
--url https://flowra.dev/api/v1/usage \
--header 'x-api-key: <api-key>'import requests
url = "https://flowra.dev/api/v1/usage"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://flowra.dev/api/v1/usage', 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://flowra.dev/api/v1/usage",
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://flowra.dev/api/v1/usage"
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))
}HttpResponse<String> response = Unirest.get("https://flowra.dev/api/v1/usage")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://flowra.dev/api/v1/usage")
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{
"success": true,
"message": "Operation completed successfully",
"data": {
"items": [
{
"id": "",
"userId": "",
"projectId": "",
"workflowId": "",
"executionId": "",
"eUID": "",
"externalUserName": "",
"type": "ai_model",
"creditAmount": 0,
"delta": 0,
"entryType": "debit",
"usdCost": 0,
"platformCostUsd": 0,
"metadata": {},
"createdAt": ""
}
],
"total": 0,
"summary": {
"byType": {
"ai_model": 0,
"tool": 0,
"sandbox": 0,
"browser": 0,
"workflow": 0,
"media": 0,
"connected_account": 0
},
"total": 0,
"count": 0
}
}
}Authorizations
Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:
Query Parameters
Project filter (user: own projects only; admin: any project)
Page number
x >= 11
Items per page
1 <= x <= 10020
Start date (ISO 8601)
"2026-08-01T00:00:00.000Z"
End date (ISO 8601)
"2026-09-01T00:00:00.000Z"
Filter by workflow (agent) ID
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Filter by workflow execution log ID
"7c9e6679-7425-40de-944b-e07fc1f90ae7"
External user id
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
LangGraph thread id (via execution logs)
"b737d8af-a9e0-4251-9714-3fdc1126e5fb"
Usage type (ai_model, tool, sandbox, …)
ai_model, tool, sandbox, browser, workflow, media, connected_account "tool"
Response
Credit usage retrieved successfully
Success status
true
Success message
"Operation completed successfully"
Show child attributes
Show child attributes
{
"items": [
{
"id": "",
"userId": "",
"projectId": "",
"workflowId": "",
"executionId": "",
"eUID": "",
"externalUserName": "",
"type": "ai_model",
"creditAmount": 0,
"delta": 0,
"entryType": "debit",
"usdCost": 0,
"platformCostUsd": 0,
"metadata": {},
"createdAt": ""
}
],
"total": 0,
"summary": {
"byType": {
"ai_model": 0,
"tool": 0,
"sandbox": 0,
"browser": 0,
"workflow": 0,
"media": 0,
"connected_account": 0
},
"total": 0,
"count": 0
}
}
Was this page helpful?