Skip to main content
GET
Get AI Credits Usage

Overview

Retrieve a per-transaction ledger of AI credit activity on your subscription. Each entry represents a single event that affected your AI credit balance, such as credits consumed by an AI avatar generation or credits added by purchasing an add-on. By default, this endpoint returns transactions for the current month. You can query a specific month using the optional query parameters described below. Transactions are returned in descending order by date (newest first). Use this endpoint to power a credit usage dashboard, generate billing reports, or audit consumption against expected workloads.
You need a valid API key to use this endpoint. Get your API key from the API Access page in your Pictory dashboard.
Usage history is available for the last 12 months only. Older transactions are not retained.

API Endpoint


Request Parameters

Headers

Authorization
string
required
API key for authentication (starts with pictai_)

Query Parameters

year
integer
The year to query (for example, 2026). When omitted, the current year is used.Note: year cannot be passed without month. Year-only queries are not supported.
month
integer
The month to query, between 1 and 12. When omitted, the current month is used.When month is provided without year, the current year is assumed.

Query Behavior


Response

Returns an array of transaction objects. Each transaction describes a single AI credit event with its direction (credit or debit), amount, and source.
transactions
array of objects
required
Array of transaction objects, ordered by transaction date in descending order (newest first). The response body is the array itself.

Response Examples


Code Examples

Replace YOUR_API_KEY with your actual API key that starts with pictai_