API Doc-CometAPI
HomeDashBoardModel Marketplace
HomeDashBoardModel Marketplace
Discord_Support
  1. Best Practices
  • 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. Best Practices

Retry Logic Documentation for CometAPI and OpenAI Official API

Introduction#

This documentation aims to help you understand how to implement automatic request switching and retry logic when using cometapi and OpenAI official API. Priority is given to initiating requests through cometapi, and when error responses are received, the system automatically switches to OpenAI official API to retry the request.

Retry Logic Overview#

The retry logic is divided into two main steps:
1.
Prioritize cometapi: First attempt to make API requests using cometapi. If the request is successful, return the response result. If the request fails (e.g., encounters an HTTP error), proceed to step two.
2.
Switch to OpenAI Official API: When a cometapi request fails, the program automatically switches to OpenAI official API to make the same request. If the request is successful, return the response result. If the request fails, return an error message to the user.

Implementation Details#

Environment Setup#

Before starting implementation, ensure you have installed the necessary Python libraries. This example uses OpenAI's Python client library, so you need to make sure it's installed:

Implementation Steps#

Here are the specific implementation steps:
1.
Initialize API Clients:
Create a cometapi client instance, set its base_url and api_key.
Create an OpenAI official API client instance, only requiring setting the api_key.
2.
Implement Request Logic:
Attempt to make requests through the cometapi client.
Catch potential API errors (such as 400 or 500 errors). These errors are typically caused by request failures or error codes in responses.
If an error occurs, switch to the OpenAI official API client and make the same request.
For each request method, record and output error information (if any).
3.
Return Response or Error Message:
If any request method succeeds, return the request result message.
If both request methods fail, return a string containing error information.

Example Code#

Below is a Python example code implementing the retry logic:

Notes#

Error Handling: In production environments, extend error logging functionality for better error handling and recording.
Performance Monitoring: Frequent switching to OpenAI official API may indicate issues with cometapi that require further investigation and optimization.
The implementation of this retry logic is designed to improve system robustness and request success rate, ensuring that the system can still provide normal service when specific API nodes experience problems.
Previous
CometAPI Account Balance Query API Usage Instructions
Next
Midjourney Best Practices
Built with