Skip to content

docs: Add CometAPI documentation with authentication, usage examples, and error handling #13534

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.

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

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

TensorNull
Copy link
Contributor

Title

Add comprehensive CometAPI provider documentation

Relevant issues

N/A - New provider documentation

Pre-Submission checklist

Please complete all items before asking a LiteLLM maintainer to review your PR

  • I have Added testing in the tests/litellm/ directory, Adding at least 1 test is a hard requirement - see details
  • I have added a screenshot of my new test passing locally
  • My PR passes all unit tests on make test-unit
  • My PR's scope is as isolated as possible, it only solves 1 specific problem

Type

📖 Documentation

Changes

This PR adds comprehensive documentation for the CometAPI provider integration with LiteLLM:

New Documentation Added

  • Complete CometAPI provider documentation (docs/providers/cometapi.md)

Documentation Features

  • Authentication guide: Instructions on obtaining API keys from CometAPI Token Console
  • Basic usage examples: Environment variable and explicit API key methods
  • Streaming support: Both synchronous and asynchronous streaming examples
  • Environment variables table: Clear specification of required variables
  • Error handling: Comprehensive error handling examples with try/catch blocks
  • Official links: Direct links to CometAPI console and model listings

Key Benefits

  • Provides users with clear integration instructions for CometAPI's 500+ AI models
  • Follows LiteLLM documentation standards and formatting
  • Includes both sync/async usage patterns matching real-world scenarios
  • Comprehensive error handling guidance for production use

The documentation follows the established pattern of other provider docs (OCI, OpenRouter) and provides users with everything needed to successfully integrate CometAPI models into their LiteLLM workflows.

Copy link

vercel bot commented Aug 12, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
litellm Ready Ready Preview Comment Aug 18, 2025 1:47am

@TensorNull
Copy link
Contributor Author

Hi, @msabramo @Manouchehri @jugaldb @colesmcintosh @krrishdholakia

The PR related to the cometapi source code has been approved, and this is a PR regarding its documentation.
Please let me know if there’s anything else you’d like me to do,

Best regards.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant