From 7e43c6ad73326fa697a9d1c092bf5886bb0ee0d4 Mon Sep 17 00:00:00 2001 From: Alex Chang Date: Thu, 7 May 2026 16:55:21 -0400 Subject: [PATCH 1/2] docs: update README examples --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d2dc1b8..d84a056 100644 --- a/README.md +++ b/README.md @@ -54,11 +54,25 @@ openai [resource] [flags...] ```sh export OPENAI_API_KEY="sk-..." -openai chat:completions create \ - --message '{content: Say this is a test, role: user}' \ - --model gpt-4o +openai responses create \ + --input "Say this is a test" \ + --model gpt-5.5 ``` +Organization admin endpoints require an admin API key: + +```sh +export OPENAI_ADMIN_KEY="sk-admin-..." + +openai admin:organization:usage completions \ + --start-time 1735689600 \ + --end-time 1735776000 \ + --bucket-width 1d +``` + +See the [completions usage API reference](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/usage/methods/completions) +for available filters and grouping options. + For details about specific commands, use the `--help` flag. ### Environment variables From d4ff51e4b1b8f4408218877919a28ef1c00481a9 Mon Sep 17 00:00:00 2001 From: Alex Chang Date: Thu, 7 May 2026 17:05:27 -0400 Subject: [PATCH 2/2] wording tweaks --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d84a056..699766a 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,8 @@ The CLI follows a resource-based command structure: openai [resource] [flags...] ``` +Standard API endpoints require an [API key](https://platform.openai.com/settings/organization/api-keys): + ```sh export OPENAI_API_KEY="sk-..." @@ -59,7 +61,7 @@ openai responses create \ --model gpt-5.5 ``` -Organization admin endpoints require an admin API key: +Admin endpoints require an [admin API key](https://platform.openai.com/settings/organization/admin-keys): ```sh export OPENAI_ADMIN_KEY="sk-admin-..." @@ -70,9 +72,6 @@ openai admin:organization:usage completions \ --bucket-width 1d ``` -See the [completions usage API reference](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/usage/methods/completions) -for available filters and grouping options. - For details about specific commands, use the `--help` flag. ### Environment variables