Skip to main content

Documentation Index

Fetch the complete documentation index at: https://apidoc.cometapi.com/llms.txt

Use this file to discover all available pages before exploring further.

The CometAPI CLI is the official command-line tool for CometAPI. It helps you chat with models, inspect the model catalog, send one-off requests, check balance, and browse account usage from the terminal. Use the PyPI package page as the public homepage for installation and package metadata. This documentation expands on the same commands without requiring access to the private source repository.
The CometAPI CLI is in beta. Command names and options may change while the interface stabilizes.

​
Features

  • Chat with models using streaming output or an interactive REPL
  • Browse model catalog metadata, including provider, modality, endpoint, capability, context, and pricing fields
  • Inspect one model with cometapi model info <id>
  • Send one request through Chat Completions, Responses, Anthropic Messages, or Gemini Generate Content formats with cometapi run
  • Check balance, account profile, usage statistics, API keys, logs, and async task history
  • Output table, JSON, YAML, CSV, or Markdown data
  • Store local configuration in ~/.config/cometapi/config.toml

​
Prerequisites

​
Install the CLI

Install the package from PyPI: 
pip install cometapi-cli
Verify the installed command: 
cometapi --version
cometapi -h

​
Start using the CLI

1

Configure credentials

Run the setup wizard:
cometapi init
You can also configure the API key with an environment variable:
export COMETAPI_KEY="your-api-key"
The optional COMETAPI_ACCESS_TOKEN value is only needed for account, stats, tokens, logs, and tasks commands.
2

Chat with a model

Send one chat message:
cometapi chat "Explain CometAPI in one sentence."
Run cometapi chat without a message to start the chat REPL.
3

Browse models

Search the public model catalog:
cometapi models --search gpt --limit 10
Filter by catalog metadata:
cometapi models --provider openai --type chat --limit 10
cometapi models --feature image --endpoint responses --json
4

Inspect one model

Show detail metadata for one model:
cometapi model info your-model-id
Output the raw detail payload:
cometapi model info your-model-id --json
5

Run a multi-protocol request

Send a one-off request through the default chat endpoint:
cometapi run your-model-id -p "Reply with OK only."
Select another endpoint format when your request body follows a different provider schema:
cometapi run your-model-id --endpoint responses -p "Reply with OK only." --json
cometapi run your-model-id --endpoint anthropic -p "Reply with OK only." -i max_tokens=32
cometapi run your-model-id --endpoint gemini -p "Reply with OK only." -i generationConfig.maxOutputTokens=32

​
Get command help

Use -h on the root command or any subcommand to inspect the options for the installed version: 
cometapi -h
cometapi models -h
cometapi model info -h
cometapi run -h

​
Main commands

CommandDescription
chat [MESSAGE]Send a chat message or start the chat REPL
modelsList and filter model catalog metadata
model info <id>Inspect one model’s public metadata
run [MODEL]Send one request through chat, responses, anthropic, or gemini formats
balanceShow account or API key balance
accountShow account profile
statsShow usage statistics
tokensList and search API keys
logsBrowse usage logs and export CSV
tasksBrowse async task logs
initRun the setup wizard
doctorRun configuration diagnostics
configManage local configuration
replStart an interactive command shell