#1159·gpt-pilot

[Enhancement]: Add CometAPI usage docs

Author: tensornullCreated Sep 15, 2025Updated Sep 15, 2025
Labelsenhancement

Version

VisualStudio Code extension

Suggestion

Version

  • VisualStudio Code extension

Suggestion Please add documentation for using CometAPI (an OpenAI-compatible provider) with GPT Pilot. The goal is to improve provider redundancy and cost flexibility for users who want alternatives while keeping the same UX.

Proposed docs outline

  1. Overview: What is CometAPI and why it matters (OpenAI-compatible, portability)
  2. Prerequisites: Obtain API key and model info
  3. Configuration
    • Where to set base URL and API key in GPT Pilot (env/settings)
    • Example configuration snippet (point OpenAI client base URL to CometAPI)
  4. Usage
    • Selecting models (note: filter to chat-capable models)
    • Streaming vs non-streaming (if applicable)
  5. Troubleshooting
    • Common errors (auth, model not found, rate limits)
    • How to verify connectivity (curl model list)

Additional context

Implementation Offer

  • We’re happy to draft the doc page and submit a PR, including config examples and a short screencast. We can also provide a temporary test API key to validate the guide.