API Doc-CometAPI
HomeDashBoardModel Marketplace
HomeDashBoardModel Marketplace
Discord_Support
  1. Integration Guides
  • 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
        • 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
        • bytedance-image-generation
        • bytedance-Image Editing
      • 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(video)(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
    • Gemini
      • Gemini generates image
  • CODE EXAMPLES
    • Code example
  • Guides & Tutorials
    • Integration Guides
      • COMET API API Call Testing
      • OpenManus
      • Chatbox
      • CherryStudio
      • Cursor
      • COZE
      • Cline
      • ChatHub
      • Dify
      • LiteLLM
      • zapier
      • n8n
      • n8n Local Deployment
      • AnythingLLM
      • MAKE
      • Immersive Translation
      • NEXT CHAT (ChatGPT Next Web)
      • ChatAll Translation
      • FastGPT
      • Lobe-Chat
      • Zotero
      • LangChain
      • Open WebUI
      • OpenAI Translator
      • Pot Translation
      • Obsidian's Text Generator Plugin
      • GPT Academic Optimization (gpt_academic)
      • gptme
      • avante.nvim
      • Eudic Translation
      • librechat
      • utools-ChatGPT Friend
      • IntelliJ Translation Plugin
      • Lazy Customer Service
      • buildship
      • sillytavern
    • 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
      • Guide to calling gemini-2.5-flash-image
  • Pricing & Billing
    • About Pricing
  • Support
    • Help Center
    • Confusion about use
    • Common Misconceptions
    • Terms of service
    • Privacy policy
    • Interface Stability
  1. Integration Guides

buildship

1.Preparation#

• Log in buildship, address: https://app.buildship.com/
• Log in to cometapi. Click "ADD API key" in the API keys to get your token key: sk-xxxxx
image.png
image.png
image.png

2. Create and Configure Workflow in BuildShip#

Once the API key is ready, we can create a workflow in BuildShip to call the CometAPI. We will use the dedicated CometAPI node provided by the BuildShip community, which is simpler than the generic method.

2.1 Add Your API Key in BuildShip#

For security and better management, we will use the integration feature designed for this node to add your CometAPI key. This will be done in steps during the node configuration.

2.2 Create the Workflow and Add a Trigger#

1.
Return to the BuildShip main dashboard, click "Create a new workflow" and select "From Scratch".
2.
On the workflow canvas, click "+ Add Trigger", then select "REST API". This will generate a callable API endpoint for us.

2.3 Add and Configure the CometAPI Node#

1.
Below the REST API trigger, click "+ Add a new step".
2.
In the pop-up node library search box, type cometapi.
3.
From the Community node list, select the CometAPI Text Generator node.
image.png
image.png
After adding the node, the core configuration requires two main parts: first, link the integration type, and then add your key.
Step A: Link the CometAPI Integration
This is a crucial step to ensure the node knows which type of key to use.
1.
Click the CometAPI Text Generator node on the canvas to open the Node Editor on the right.
2.
Switch to the Settings tab.
3.
Find the Key-based Integration section and click the dropdown menu.
4.
Search for or select CometAPI from the list.
5.
Click the blue Save button in the top-right corner of the editor. This step is crucial as it correctly links the node with CometAPI's key management system.
image.png
Step B: Add Your API Key
Now that the node is configured, you can add your personal key.
1.
In the Node Editor, switch back to the Inputs tab (or you can operate directly on the node on the canvas).
2.
Click the key icon 🔑 area in the top-right of the node to open the key management dropdown.
3.
In the menu, select "+ Bring your own Key".
4.
A dialog box designed specifically for the CometAPI integration will pop up.
5.
In the Key ID field, enter an easily recognizable name, for example, cometapi-key-1.
6.
In the Value field, paste the sk-xxxxx key you obtained from CometAPI.
7.
Click Save.
image.pngimage.png
Step C: Configure Input Parameters
1.
Instructions: (Optional) Enter instructions or a role for the AI, for example, You are a productivity assistant.
2.
Prompt: This is the core content of the question for the AI. Click the </> icon on the right side of the input box, then select Trigger -> Body -> prompt.
3.
Advanced Settings:
Click to expand Advanced Settings.
In the Model field, enter the name of the model you want to use, for example, gpt-4o.
image.png

2.4 Add the Output Node#

1.
Below the CometAPI Text Generator node, click "+ Add a new step".
2.
Select the "Return Response" node.
3.
In the Body field, click the </> icon and select the response variable from the CometAPI Text Generator node.

3. Testing#

1.
Click the Test button in the upper right corner of the workflow page to open the test panel on the right.
2.
Ensure the input format is JSON and fill in the input box with test data, for example:
{
  "prompt": "hi"
}
3.
Click the blue Test Flow button.
4.
If the configuration is correct, you will see a successful response from CometAPI in the Result area below.
image.png

4. Conclusion#

Congratulations! You have successfully integrated CometAPI into BuildShip. By using the dedicated CometAPI Text Generator node from the community and leveraging its built-in key integration feature to manage sensitive information, the entire process becomes both direct, efficient, and secure.
Previous
Lazy Customer Service
Next
sillytavern
Built with