Fetch Credit Report | Rightbrain Docs | Transform AI Ideas into Production Tasks

Retrieve detailed credit usage statistics for a specific task.

AuthorizationBearer

Bearer token authentication using JWT tokens from Ory Kratos/Hydra

org_idstringRequiredformat: "uuid"

The unique identifier of the organization.

project_idstringRequiredformat: "uuid"

The unique identifier of the project.

task_idstringRequiredformat: "uuid"

The specific Task to reference.

start_datestringOptional

Start date for the report (e.g., ‘2023-06-01’, ‘24 hours ago’, ‘yesterday’).

end_datestringOptional

End date for the report (e.g., ‘2023-06-30’, ‘now’, ‘today’).

show_reporting_groupbooleanOptionalDefaults to false

If true, include reporting group in the report.

Successful Response

task_idstringformat: "uuid"

The unique identifier of the Task.

task_revisionslist of objects

Timing data broken down by task revision, showing performance metrics for each active revision.

total_creditsstringformat: "^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$"

Total credits charged for the Task.

total_task_runsinteger

Total number of task runs for each time interval.

date_rangemap from strings to strings

The time range for the report, with start and end timestamps.

1	import requests
2
3	url = "https://app.rightbrain.ai/api/v1/org/123e4567-e89b-12d3-a456-426614174000/project/123e4567-e89b-12d3-a456-426614174001/task/01909843-3596-da54-4756-28af46917e74/credit_report"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"task_id": "019011e6-e530-3aca-6cf7-2973387c255d",
3	"task_revisions": [
4	{
5	"task_revision_id": "string",
6	"total_credits": "100.00",
7	"total_task_runs": 1,
8	"reporting_group": "batch_processing"
9	}
10	],
11	"total_credits": "100.00",
12	"total_task_runs": 12,
13	"date_range": {}
14	}