API Doc-CometAPI
English
  • English
  • Русский
HomeDashBoardModel Marketplace
HomeDashBoardModel Marketplace
Discord_Support
English
  • English
  • Русский
  1. 🏄🏼‍♀️ Best Practices
  • 🚀 Overview
    • Quick Start
    • Important Guidelines
    • Release Notes
    • Models
  • 💬 Text Models-OpenAI Format
    • Anthropic Compatiable
      • Anthropic Claude
    • gpt-4o-image generates image
    • Image Editing (gpt-image-1)
    • response
    • Chat
    • Recognizing Images
    • Embeddings
    • Realtime
    • Images
    • Hunyuan3D
  • 🖼️ 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)
  • 🖼️ Image Models
    • Gemini
      • Guide to calling gemini-2.5-flash-image (Nano Banana)
      • Gemini generates image
      • Gemini text dialog
    • Replicate(image)
      • Create Task - General
      • replicate query
      • Create Task -flux-kontext-pro、max
      • Create Task -flux-1.1-pro
      • Create Task -flux-1.1-pro-ultra
    • seededit/seedream
      • bytedance-image-generation(seedream)
      • bytedance-Image Editing (seededit)
    • Flux(images)
      • flux generate image(Temporarily unavailable)
      • flux fine-tune images(Temporarily unavailable)
      • flux query
      • Generate image (replicate format)
      • Create Task - General
    • Recraft(Temporarily removed)
      • Appendix
      • Recraft Vectorize Image
      • Recraft Generate Image
      • Recraft Remove Background
      • Recraft Create style
      • Recraft Generative Upscale
      • Recraft Clarity Upscale
    • Ideogram(Temporarily removed)
      • Official documentation (updated in real time)
      • ideogram Text Raw Image
      • Generate 3.0 (text to image)
      • ideogram Edit image((legacy))
      • Remix 3.0 (hybrid image)
      • ideogram Hybrid image
      • Reframe 3.0(Reconstruction)
      • ideogram enlargement HD
      • Replace Background 3.0(Background replacement)
      • ideogram describes the image
      • Edit 3.0(Editing images)
  • 🎵 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
      • Get midi
      • Batch query tasks
    • Udio(Temporarily unavailable)
      • Generate music
      • Task query
  • 📺 Video Models
    • veo3
      • veo3-chat format
      • Submit video generation task
      • Query video generation status
    • sora-2
      • official
        • Create video
        • Remix video
        • Retrieve video
        • Delete video
        • Retrieve video content
      • sora-2 generate video by chat
    • 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
  • 🔊 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. 🏄🏼‍♀️ Best Practices

Runway Best Practices

1. Handling Retry Logic#

Whether a task is successfully submitted can be determined by checking if the returned code is 200. If successful, msg will display success information.
If there are errors, msg will show the specific error reason.

2. Task Callbacks#

The most stable way to handle task callbacks is through a Webhook callback URL. When the video generation status changes (progress update/failure/success), the generation result will be sent to this Webhook URL via POST.
Pass your own webhook in the callback_url parameter when submitting a task request.
Your webhook will receive a POST request like this:
{
  "task_id": "d51c94db-f7fa-4ad3-a083-b8918686c478",
  "status": "3",
  "prompt": "a cat",
  "prompt_en": "a little kitten.",
  "video_url": "https://runwaycdn.cometapi.com/attachments/video/runway/20241011/8af2304880d6b32bfff5f0ea33007566.mp4",
  "poster": "https://runwaycdn.cometapi.com/attachments/video/runway/20241011/6771c68bf540b62a96e7c4a5b2b375a7.png",
  "last_frame": "https://runwaycdn.cometapi.com/attachments/video/runway/20241011/8af7cc2b46fc7ad5d1e0efedd0bd0893.png",
  "msg": null,
  "point": "320",
  "refund": "0",
  "create_time": "1728622596",
  "update_time": "1728622955"
}
Modified at 2025-05-16 07:32:36
Previous
Retry Logic Documentation for CometAPI and OpenAI Official API
Next
CometAPI Account Balance Query API Usage Instructions
Built with