Using the OpenAI API Usage CLI¶
The OpenAI API Usage CLI tool provides functionalities for monitoring your OpenAI API usage, breaking it down by model, date, and cost.
Monitoring API Usage¶
View Usage Options¶
$ instructor usage --help
Usage: instructor usage [OPTIONS] COMMAND [ARGS]...
Check OpenAI API usage data
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ --help Show this message and exit. โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโ Commands โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ list Displays OpenAI API usage data for the past N days. โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
List Usage for Specific Number of Days¶
To display API usage for the past 3 days, use the following command:
This will output a table similar to:
Usage Summary by Date, Snapshot, and Cost
โโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโณโโโโโโโโโโโโโโโโโ
โ Date โ Snapshot ID โ Total Requests โ Total Cost ($) โ
โกโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฉ
โ 2023-09-04 โ gpt-4-0613 โ 44 โ 0.68 โ
โ 2023-09-04 โ gpt-3.5-turbo-16k-0613 โ 195 โ 0.84 โ
โ 2023-09-04 โ text-embedding-ada-002-v2 โ 276 โ 0.00 โ
โ 2023-09-04 โ gpt-4-32k-0613 โ 328 โ 49.45 โ
โโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโ
List Usage for Today¶
To display the API usage for today, simply run:
Contributions¶
We aim to provide a light wrapper around the API rather than offering a complete CLI. Contributions are welcome! Please feel free to make an issue at jxnl/instructor/issues or submit a pull request.