API Doc-CometAPI
HomeDashBoardModel Marketplace
HomeDashBoardModel Marketplace
Discord_Support
  1. GET START
  • GET START
    • Quick Start
    • Important Guidelines
    • Release Notes
  • API Reference
    • Error Codes & Handling
    • Text Models-openai format
      • Chat
      • response
      • gpt-4o-image generates image
      • Images
      • Image Editing (gpt-image-1)
      • Recognizing Images
      • Embeddings
      • Realtime
      • Models
      • Hunyuan3D
    • Anthropic Compatiable
      • Anthropic Claude
    • Image Models
      • Midjourney(images)
        • Quick Tutorial - Complete Process in One Go
        • Task Fetching API
          • List by Condition
          • Fetch Single Task (most recommended)
        • Imagine
        • Submit Video
        • Submit Editor
        • Action (UPSCALE; VARIATION; REROLL; ZOOM, etc.)
        • Blend (image -> image)
        • Describe (image -> text)
        • Modal (Area Redesign & Zoom)
      • Flux(images)
        • Generate image (replicate format)
        • Create Task - General
        • flux fine-tune images(Temporarily unavailable)
        • flux generate image(Temporarily unavailable)
        • flux query
      • Replicate(image)
        • Create Task - General
        • Create Task -flux-kontext-pro、max
        • Create Task -flux-1.1-pro
        • Create Task -flux-1.1-pro-ultra
        • replicate query
      • Recraft(images)
        • Appendix
        • Recraft Generate Image
        • Recraft Vectorize Image
        • Recraft Remove Background
        • Recraft Clarity Upscale
        • Recraft Create style
        • Recraft Generative Upscale
      • Ideogram(images)(Temporarily removed)
        • Official documentation (updated in real time)
        • Generate 3.0 (text to image)
        • Remix 3.0 (hybrid image)
        • Reframe 3.0(Reconstruction)
        • Replace Background 3.0(Background replacement)
        • Edit 3.0(Editing images)
        • ideogram Text Raw Image
        • ideogram Hybrid image
        • ideogram enlargement HD
        • ideogram describes the image
        • ideogram Edit image((legacy))
    • Music Models
      • Suno
        • Setting suno Version
        • Suno API Scenario Application Guide
        • Generate lyrics
        • Generate music clip
        • Upload clip
        • Submit concatenation
        • Full Track Audio Separation
        • Single Track Audio Separation
        • Create New Persona
        • Single task query
        • Generate mp4 mv video
        • Timing: lyrics, audio timeline
        • Get wav format file
        • Batch query tasks
      • Udio(Temporarily unavailable)
        • Generate music
        • Task query
    • Video Models
      • veo3
        • veo3-chat format
        • Submit video generation task
        • Query video generation status
      • runway(video)
        • official format
          • runway images raw video
          • Generate a video from a video
          • Generate an image from text
          • Upscale a video
          • Control a character
          • runway to get task details
        • Reverse Format
          • generate(text)
          • generate(Reference images)
          • Video to Video Style Redraw
          • Act-one Expression Migration
          • feed-get task
      • kling (video)
        • callback_url
        • testing
          • Multimodal Video Editing (In Testing)
            • Initialize Video for Editing
            • Add Video Selection
            • Delete Video Selection
            • Clear Video Selection
            • Preview Selected Video Area
            • Create Task
        • Expanded
        • Generating images
        • Text Generation Video
        • Image Generation Video
        • Multi-Image To Video
        • Multi-Image to Image
        • Video Extension
        • virtual try-on
        • lip sync
        • effects
        • Video to audio
        • Text to audio
        • Individual queries
      • MiniMax Conch(video)
        • MiniMax Conch Official Documentation
        • MiniMax Conch Generation
        • MiniMax Conch Query
        • MiniMax Conch Download
      • luma (video)
        • Official api interface format
          • luma generate
          • luma search
      • bytedance
        • bytedance-video
        • bytedance-video get
        • bytedance-image-generation
        • bytedance-Image Editing
      • PIKA(video)
        • pika feed
        • PIKA Reference Video Generation
        • PIKA Reference Image Generation
        • PIKA reference text generation
      • sora(temporarily dismantle)
        • Reverse Format
          • Create Video
          • Query Video Task
          • Create Video
    • Audio Models
      • Create speech
      • Create transcription
      • Create translation
  • CODE EXAMPLES
    • Code example
  • Guides & Tutorials
    • Integration Guides
      • cometapi Site API Call Testing
      • OpenManus
      • Chatbox
      • CherryStudio
      • Cursor
      • ChatHub
      • COZE
      • FastGPT
      • cline
      • dify
      • gptme
      • Immersive Translation
      • Lobe-Chat
      • Zotero
      • LangChain
      • AnythingLLM
      • Eudic Translation
      • OpenAI Translator
      • ChatAll Translation
      • Pot Translation
      • GPT Academic Optimization (gpt_academic)
      • NEXT CHAT (ChatGPT Next Web)
      • Obsidian's Text Generator Plugin
      • Open WebUI
      • avante.nvim
      • librechat
      • Lazy Customer Service
      • utools-ChatGPT Friend
      • IntelliJ Translation Plugin
      • n8n
    • Best Practices
      • Claude Code Installation and Usage Guide
      • Gemini CLI Installation and Usage Guide
      • CometAPI Account Balance Query API Usage Instructions
      • Retry Logic Documentation for CometAPI and OpenAI Official API
      • Midjourney Best Practices
      • Runway Best Practices
  • Pricing & Billing
    • About Pricing
  • Support
    • Help Center
    • Confusion about use
    • Common Misconceptions
    • Terms of service
    • Privacy policy
    • Interface Stability
  • Schemas
    • Schemas
      • Sample Schemas
        • Pet
        • Category
        • Tag
      • VideoGenerationRequest
      • TextGenerateRequest
      • ImageGenerateRequest
      • VideoGenerateRequest
      • BaseResponse
      • TextToImageRequest
      • Two-person interactive effect
      • VideoGenerationResponse
      • GenerateResponse
      • EditImageRequest
      • Single image effect
      • ErrorResponse
      • BlendImagesRequest
      • UpscaleRequest
      • DescribeImageRequest
      • ImageGenerationResponse
      • ImageDescriptionResponse
      • ErrorResponse
    • chat-output
    • chat-input
  1. GET START

Important Guidelines

cometapi Getting Started Guide#

How to claim the $0.1 USD credit?#

No special operation required. After registering and logging in, you can see the $0.1 USD credit in your Wallet page.

How to top up? Can I top up without USD?#

1.
After logging in, enter the amount you wish to add on the Wallet page, minimum $1 USD.
2.
Use stripe to complete the payment.

Which large language model APIs are available?#

All supported models and their prices can be viewed on the pricing documentation. All models displayed on the page can be accessed through cometapi.

How to get OpenAI Key, Claude Key, Gemini Key?#

1.
Key refers to token.
2.
After registering and logging into cometapi, go to the "Tokens" menu on the left, and click "Add Token".
3.
Enter a custom token name to generate your Key.
This Key can be used for GPT series models, Claude series models, and Gemini series models.

How to switch between models?#

Change the "model" parameter in your code to switch models.
Note that you need to enter the complete model name. For specific usage methods, refer to the API documentation.


Is billing per usage or monthly?#

1.
Pay-as-you-go: Consistent with official pricing, calculated based on Token consumption. You pay only for what you use.
No monthly subscription required, balance never expires, and unused portions are refundable.
2.
Special model billing: Models like MidJourney, Suno, Luma (image, music, video models) are billed per usage.

Why are there 3 Base URLs? Which one should I use?#

Different development environments or software handle Base URLs differently.
Try these 3 addresses:
https://api.cometapi.com/v1/
https://api.cometapi.com/v1/chat/completions/
https://api.cometapi.com/
If you encounter a 404 error, please check if your Base URL setting is correct.

Does cometapi support Claude 3.7 Sonnet?#

Yes! cometapi supports the full range of Claude models, including:
Sonnet
Haiku
Opus series

Which URL should I use for Anthropic Claude? What is the Base URL?#

The Base URL is the same for all models:
Including OpenAI, Claude series, Google Gemini, and other models.

How to check how many Tokens were consumed in a call?#

1.
Go to the "Logs" page.
2.
Click on a single log entry to expand detailed call information and view the calculation formula and Token consumption:
Prompt: Understood as the user input.
Completion: Understood as the AI's response.

What do "prompt" and "completion" refer to?#

Prompt: Refers to the content input by the user.
Completion: Refers to the content output by the AI.

What happens if my balance becomes negative?#

When your balance is very low, if the cost of your last call exceeds your remaining balance, your balance will show as negative.
Please top up promptly to continue using the service.
Previous
Quick Start
Next
Release Notes
Built with