> ## Documentation Index
> Fetch the complete documentation index at: https://apidoc.cometapi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect BuildShip to CometAPI

> Use this guide to connect BuildShip to CometAPI by setting the base URL, API key, and model or provider options.

BuildShip is a low-code visual backend builder. Use the community **CometAPI Text Generator** node to add AI-powered text generation to any workflow.

## Prerequisites

* A CometAPI account with an active API key — [get yours here](https://www.cometapi.com/console/token)
* A BuildShip account — [sign in here](https://app.buildship.com)

<Steps>
  <Step title="Get your CometAPI API key">
    Log in to the [CometAPI console](https://www.cometapi.com/console/token). Click **Add API Key** and copy your CometAPI API key.

    <Frame>
      <img src="https://mintcdn.com/cometapi/SZhlxZhCnMLn__BW/images/overview/810968_364191.png?fit=max&auto=format&n=SZhlxZhCnMLn__BW&q=85&s=aef81a83f29f8eb16655ed4060425f50" alt="CometAPI dashboard showing the Add API Key button" width="3824" height="1892" data-path="images/overview/810968_364191.png" />
    </Frame>

    <Frame>
      <img src="https://mintcdn.com/cometapi/HhtmQffktazbxUvS/images/overview/810968_364193.png?fit=max&auto=format&n=HhtmQffktazbxUvS&q=85&s=d893f659267150d0faf45f99eb5dffc1" alt="CometAPI API key details with base URL" width="2434" height="1232" data-path="images/overview/810968_364193.png" />
    </Frame>
  </Step>

  <Step title="Create a workflow with a REST API trigger">
    1. In the BuildShip dashboard, click **Create a new workflow → From Scratch**.
    2. On the canvas, click **Add Trigger** and select **REST API**. This generates a callable endpoint for the workflow.
  </Step>

  <Step title="Add the CometAPI Text Generator node">
    1. Below the REST API trigger, click **+ Add a new step**.
    2. In the node library search box, type `cometapi`.
    3. From the **Community** list, select **CometAPI Text Generator**.

    <Frame>
      <img src="https://mintcdn.com/cometapi/SZhlxZhCnMLn__BW/images/integrations/810968_360694.png?fit=max&auto=format&n=SZhlxZhCnMLn__BW&q=85&s=4ac17cb84e36a7f026f618e2b5229bf2" alt="BuildShip node library showing CometAPI Text Generator in search results" width="1915" height="960" data-path="images/integrations/810968_360694.png" />
    </Frame>

    <Frame>
      <img src="https://mintcdn.com/cometapi/SZhlxZhCnMLn__BW/images/integrations/810968_360712.png?fit=max&auto=format&n=SZhlxZhCnMLn__BW&q=85&s=5da7aa2a5bef0d8a9ce45eceace876d1" alt="CometAPI Text Generator node added to the canvas" width="1786" height="930" data-path="images/integrations/810968_360712.png" />
    </Frame>
  </Step>

  <Step title="Link the CometAPI integration">
    This step tells the node which key management system to use.

    1. Click the node to open the **Node Editor** on the right.
    2. Switch to the **Settings** tab.
    3. In **Key-based Integration**, open the dropdown and select **CometAPI**.
    4. Click the blue **Save** button in the top-right corner.

    <Frame>
      <img src="https://mintcdn.com/cometapi/SZhlxZhCnMLn__BW/images/integrations/810968_360713.png?fit=max&auto=format&n=SZhlxZhCnMLn__BW&q=85&s=ceea3b9fec0cf8a1ab81f70547b0a499" alt="Node Editor Settings tab with Key-based Integration set to CometAPI" width="1895" height="923" data-path="images/integrations/810968_360713.png" />
    </Frame>
  </Step>

  <Step title="Add your API key to the node">
    1. In the Node Editor, switch to the **Inputs** tab (or click directly on the node).
    2. Click the 🔑 key icon in the node's top-right corner to open the key dropdown.
    3. Select **+ Bring your own Key**.
    4. Enter a **Key ID** (e.g. `cometapi-key-1`) and paste your CometAPI API key in **Value**.
    5. Click **Save**.

    <Frame>
      <img src="https://mintcdn.com/cometapi/SZhlxZhCnMLn__BW/images/integrations/810968_360715.png?fit=max&auto=format&n=SZhlxZhCnMLn__BW&q=85&s=25c09a874e2a0ceadf2a83e1192323ca" alt="Key management dialog with Key ID and Value fields filled in" width="1710" height="920" data-path="images/integrations/810968_360715.png" />
    </Frame>

    <Frame>
      <img src="https://mintcdn.com/cometapi/SZhlxZhCnMLn__BW/images/integrations/810968_360714.png?fit=max&auto=format&n=SZhlxZhCnMLn__BW&q=85&s=7a946cdb3d110605b3a9f1d7d91e022b" alt="Node showing the key bound successfully" width="611" height="318" data-path="images/integrations/810968_360714.png" />
    </Frame>
  </Step>

  <Step title="Configure input parameters">
    In the node's **Inputs** tab:

    * **Instructions** (optional): set a system role, e.g. `You are a productivity assistant.`
    * **Prompt**: click the **`</>`** icon, then select **Trigger → Body → prompt** to map the incoming request body.
    * **Advanced → Model**: enter the current model ID you want to use.

    <Frame>
      <img src="https://mintcdn.com/cometapi/SZhlxZhCnMLn__BW/images/integrations/810968_360716.png?fit=max&auto=format&n=SZhlxZhCnMLn__BW&q=85&s=71431b9496c396bbe5fa8d529ca57b27" alt="CometAPI node with Instructions, Prompt, and Model configured" width="1895" height="940" data-path="images/integrations/810968_360716.png" />
    </Frame>
  </Step>

  <Step title="Add a Return Response node and test">
    1. Below the CometAPI node, click **+ Add a new step** and select **Return Response**.
    2. In the **Body** field, click **`</>`** and select the `response` variable from the CometAPI Text Generator node.
    3. Click **Test** in the upper-right corner, select **JSON** input format, and send:

    ```json theme={null}
    {
      "prompt": "hi"
    }
    ```

    4. A successful response in the **Result** panel confirms the workflow is working.

    <Frame>
      <img src="https://mintcdn.com/cometapi/SZhlxZhCnMLn__BW/images/integrations/810968_360717.png?fit=max&auto=format&n=SZhlxZhCnMLn__BW&q=85&s=561ea8bcdfd96a014dab4476840ee377" alt="BuildShip test panel showing a successful CometAPI response" width="1885" height="934" data-path="images/integrations/810968_360717.png" />
    </Frame>

    If the call fails, verify your API key and that the Key-based Integration is set to **CometAPI**, or contact [CometAPI support](https://www.cometapi.com).
  </Step>
</Steps>

<Tip>
  The **Key-based Integration** step (linking the node to CometAPI) is essential — skipping it will cause authentication errors even if your API key is correct.
</Tip>
