Skip to content

docs: update README examples #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
apcha-oai merged 2 commits into from
May 7, 2026
+16 −3
Merged

docs: update README examples #10

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e43c6a
docs: update README examples
apcha-oai May 7, 2026
d4ff51e
wording tweaks
apcha-oai May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,25 @@ The CLI follows a resource-based command structure:
openai [resource] <command> [flags...]
```

Standard API endpoints require an [API key](https://platform.openai.com/settings/organization/api-keys):

```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
```

Admin endpoints require an [admin API key](https://platform.openai.com/settings/organization/admin-keys):

```sh
export OPENAI_ADMIN_KEY="sk-admin-..."

openai admin:organization:usage completions \
--start-time 1735689600 \
--end-time 1735776000 \
--bucket-width 1d
```

For details about specific commands, use the `--help` flag.
Expand Down
Loading