Skip to main content
GET
Credit usage ledger (API key)

Authorizations

x-api-key
string
header
required

Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:

Query Parameters

projectId
string

Project filter (user: own projects only; admin: any project)

page
number
default:1

Page number

Required range: x >= 1
Example:

1

limit
number
default:20

Items per page

Required range: 1 <= x <= 100
Example:

20

from
string

Start date (ISO 8601)

Example:

"2026-08-01T00:00:00.000Z"

to
string

End date (ISO 8601)

Example:

"2026-09-01T00:00:00.000Z"

workflowId
string<uuid>

Filter by workflow (agent) ID

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

executionId
string<uuid>

Filter by workflow execution log ID

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

eUID
string<uuid>

External user id

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

threadId
string

LangGraph thread id (via execution logs)

Example:

"b737d8af-a9e0-4251-9714-3fdc1126e5fb"

type
enum<string>

Usage type (ai_model, tool, sandbox, …)

Available options:
ai_model,
tool,
sandbox,
browser,
workflow,
media,
connected_account
Example:

"tool"

Response

200 - application/json

Credit usage retrieved successfully

success
boolean
required

Success status

Example:

true

message
string
required

Success message

Example:

"Operation completed successfully"

data
object
required
Example: