API Doc-CometAPI
HomeDashBoardModel Marketplace
HomeDashBoardModel Marketplace
Discord_Support
  1. 💬 Text Models-OpenAI Format
  • 🚀 Get Start
    • Quick Start
    • Important Guidelines
    • Release Notes
  • 💬 Text Models-OpenAI Format
    • Anthropic Compatiable
      • Anthropic Claude
    • Chat
      POST
    • response
      POST
    • gpt-4o-image generates image
      POST
    • Images
      POST
    • Image Editing (gpt-image-1)
      POST
    • Recognizing Images
      POST
    • Embeddings
      POST
    • Realtime
      POST
    • Models
      GET
    • Hunyuan3D
      POST
  • 🖼️ Midjourney(images)
    • Quick Tutorial - Complete Process in One Go
    • Task Fetching API
      • List by Condition
      • Fetch Single Task (most recommended)
    • Imagine
      POST
    • Submit Video
      POST
    • Submit Editor
      POST
    • Action (UPSCALE; VARIATION; REROLL; ZOOM, etc.)
      POST
    • Blend (image -> image)
      POST
    • Describe (image -> text)
      POST
    • Modal (Area Redesign & Zoom)
      POST
  • 🖼️ Image Models
    • Flux(images)
      • Generate image (replicate format)
      • Create Task - General
      • flux fine-tune images(Temporarily unavailable)
      • flux generate image(Temporarily unavailable)
      • flux query
    • seededit/seedream
      • bytedance-image-generation(seedream)
      • bytedance-Image Editing (seededit)
    • 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(Temporarily removed)
      • Appendix
      • Recraft Generate Image
      • Recraft Vectorize Image
      • Recraft Remove Background
      • Recraft Clarity Upscale
      • Recraft Create style
      • Recraft Generative Upscale
    • Ideogram(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))
    • Gemini
      • Guide to calling gemini-2.5-flash-image
      • Gemini generates image
      • Gemini text dialog
  • 🎵 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
      • Multimodal Video Editing
        • Initialize Video for Editing
        • Add Video Selection
        • Delete Video Selection
        • Clear Video Selection
        • Preview Selected Video Area
        • Create Task
      • Generating images
      • Expanded
      • 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
    • bytedance
      • bytedance-video
      • bytedance-video get
    • MiniMax Conch(video)
      • MiniMax Conch Official Documentation
      • MiniMax Conch Generation
      • MiniMax Conch Query
      • MiniMax Conch Download
    • luma (video)(temporarily dismantle)
      • Official api interface format
        • luma generate
        • luma search
    • PIKA(temporarily dismantle)
      • 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
  • ⚠️ Errors
    • Error Codes & Handling
  • 📝 Code Examples
    • Text-to-Image Generation
    • Image-to-Image Generationèurl uploadé
    • Regular Post Text Conversation
    • OpenAI Official Library Usage Example
    • Streamed Output
    • Json Fixed Format Output Code Display
    • Embedding code example
    • o1-preview Model Code Example
    • LangChain Usage Example (Successful Test Date: 2024-11-25)
    • Openai dall-e-3 & flux series drawing model
    • gpt, claude, gemini multimodal network image parsing example
    • Multimodal PDF File Parsing Examples for GPT, Claude, and Gemini
    • Code example
  • 🧩 Integration Guides
    • continue
    • Chatbox
    • CherryStudio
    • COMET API API Call Testing
    • Lobe-Chat
    • Cursor
    • LangChain
    • AnythingLLM
    • gptme
    • Immersive Translation
    • Cline
    • Eudic Translation
    • ChatHub
    • OpenAI Translator
    • ChatAll Translation
    • Pot Translation
    • Zotero
    • NEXT CHAT (ChatGPT Next Web)
    • Obsidian's Text Generator Plugin
    • librechat
    • Lazy Customer Service
    • utools-ChatGPT Friend
    • avante.nvim
    • Open WebUI
    • GPT Academic Optimization (gpt_academic)
    • OpenManus
    • IntelliJ Translation Plugin
    • n8n
    • FastGPT
    • COZE
    • zapier
    • LiteLLM
    • MAKE
    • n8n Local Deployment
    • buildship
    • sillytavern
    • LlamaIndex
    • activepieces
    • FlowiseAI
    • Dify
  • 🏄🏼‍♀️ Best Practices
    • Midjourney Best Practices
    • Retry Logic Documentation for CometAPI and OpenAI Official API
    • Runway Best Practices
    • CometAPI Account Balance Query API Usage Instructions
    • Claude Code Installation and Usage Guide
    • Gemini CLI Installation and Usage Guide
    • Codex Usage Guide
  • 💳 Pricing & Billing
    • About Pricing
  • 🤝🏼 Support
    • Help Center
    • Interface Stability
    • Privacy policy
    • Terms of service
    • Common Misconceptions
    • Confusion about use
  1. 💬 Text Models-OpenAI Format

Image Editing (gpt-image-1)

POST
https://api.cometapi.com/v1/images/edits
Maintainer:Not configured
official docs:

Image Editing Request Parameters#

ParameterTypeRequiredDescription
imagefile or file array✅The image(s) to edit. Must be a supported image file or array.
• gpt-image-1: PNG, WEBP, or JPG, each <25MB.
• dall-e-3: 1 square PNG <4MB.
promptstring✅A text description of the desired image(s).
• Max length: 1000 chars for dall-e-3, 32000 chars for gpt-image-1.
maskfileOptional PNG mask image. Transparent areas (alpha = 0) indicate regions to edit.
Must match size of image and be <4MB.
Applies to first image.
modelstringModel to use: "dall-e-3" or "gpt-image-1".
ninteger or nullNumber of images to generate.
Must be between 1 and 10.
Default: 1.
qualitystring or nullFor gpt-image-1 only.
Options: "high", "medium", "low".
Default: "auto".
response_formatstring or nullResponse format.
Options: "url" or "b64_json".
Only dall-e-3 supports "url" (valid for 60 minutes).
sizestring or nullImage size:
• gpt-image-1: "1024x1024", "1536x1024", "1024x1536", "auto" (default)
• dall-e-3: "256x256", "512x512", "1024x1024"

Request

Header Params

Body Params multipart/form-data

Responses

🟢200success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.cometapi.com/v1/images/edits' \
--header 'Authorization: Bearer {{api-key}}' \
--form 'image=@"MQ==/test.png"' \
--form 'prompt="Put on glasses"' \
--form 'model="gpt-image-1"' \
--form 'mask=@""' \
--form 'n=""' \
--form 'quality=""' \
--form 'response_format=""' \
--form 'size=""'
Response Response Example
{
    "created": 1713833628,
    "data": [
        {
            "b64_json": "..."
        }
    ],
    "usage": {
        "total_tokens": 100,
        "input_tokens": 50,
        "output_tokens": 50,
        "input_tokens_details": {
            "text_tokens": 10,
            "image_tokens": 40
        }
    }
}
Previous
Images
Next
Recognizing Images
Built with