### Hello World API

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

A basic 'Hello World' API to help you get started with BuildShip. This serves as a fundamental example for creating APIs.

```REST
A simple hello world API to get your familiar with BuildShip
```

--------------------------------

### AI Assistant Instructions for Web Scraping

Source: https://docs.buildship.com/ai-assistant/assistant

These instructions guide an AI assistant on how to use the 'get website' tool. It specifies that when a user asks for information about a specific website, the assistant must use the 'get website' node to scrape the provided URL and return the content.

```text
You are an expert in searching for information from different sources. Your goal is to respond to the users' questions
and requests using the source they provide. You must respond in a concise way and readable way. When you are given tools
to use, you must use them following the guidelines for each tool. Guidelines:
- when a user asks for information about a specific website you must use 'get website' to scrape a given website and
  return the information
```

--------------------------------

### User Query: Common Learning Challenges

Source: https://docs.buildship.com/ai-assistant/assistant

This example demonstrates a follow-up query to the AI assistant, requesting information on common learning challenges identified in the user survey data. It includes a 'threadId' to maintain conversation context.

```json
{ "message":"Which are the most common challenges when learning?","threadId":"thread_Ey5hYxgvbXK674uaCCjOq2ux" }
```

--------------------------------

### Hello World

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

A simple hello world API to get you familiar with BuildShip. This serves as a basic example for understanding BuildShip's API functionality.

```REST
Create a simple 'Hello World' API endpoint.
```

--------------------------------

### Test Web Scraping Node with User Query

Source: https://docs.buildship.com/ai-assistant/assistant

This example demonstrates how to test the configured web scraping node by sending a user query to the AI assistant. The query asks for plans in Barcelona and provides a specific URL to scrape.

```json
{
"message":"What plans I can do in Barcelona? Use this website to answer: https://www.timeout.com/barcelona/things-to-do/best-things-to-do-in-barcelona"
}
```

--------------------------------

### SHIP an API Guide

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

A guide on how to use BuildShip to create and deploy APIs. Covers the process from workflow creation to API endpoint management.

```BuildShip
SHIP an API
```

--------------------------------

### BuildShip Workflow Creation

Source: https://docs.buildship.com/workflows/workflow-101

Guide on creating a new workflow in BuildShip. It explains how to start from scratch or use templates, and how to add workflow inputs either manually or by connecting a trigger.

```BuildShip
Click the + icon on the navigation panel on the left to create a new flow.
You can start from scratch or select a suitable template closest to the idea you are building.
```

--------------------------------

### ElevenLabs Voice Agent Setup with Custom Tool

Source: https://docs.buildship.com/tools/elevenlabs

Guide to setting up a webhook-based custom tool for an ElevenLabs Voice Agent using BuildShip. This allows the agent to interact with external workflows and integrations.

```English
## Prerequisites
  * **ElevenLabs Account:** Create or log in to your account at ElevenLabs Voice Agents Dashboard (opens in a new tab).
  * **Agent Setup:** Ensure you have a conversational AI Agent created. If not, follow the on-screen steps to set one up.

## Step 1: Add a Custom Tool
### Navigate to your Agent
Open the agent for which you want to add a tool.
### Open the Tools Section
Scroll to the bottom of your agent's setup page to find the **Tools** section.
### Add a Tool
Click **Add tool** and select **Custom Tool** from the dropdown.
## Step 2: Configure the Tool
### Select the Tool Type
Select **Webhook** as the tool type.
### Add a Tool Name & Description
  * **Name:** Use a unique, CamelCase identifier (e.g., `LinearChangeLog`).
  * **Description:** Paste or generate a concise description for your tool's purpose.
```

--------------------------------

### Install BuildShip Framer Plugin

Source: https://docs.buildship.com/tutorials/framer-cms

Instructions for installing the BuildShip Framer Plugin from the Framer Plugin Marketplace. This involves searching for the plugin, opening it, and creating a new collection.

```English
1. Navigate to the Framer Plugin Marketplace (opens in a new tab) and search for "CMS Data Sync" or click on the link here: CMS Data Sync (opens in a new tab)

1. Click on the **Open Plugin** button to add the plugin to your Framer project
2. This will open a modal for you to create a new collection which will be used to sync data from your external source

1. Choose a name for your collection and click **Create Collection**. The plugin will now create a new collection in your Framer project.
2. Once the collection is created, you will be redirected to the plugin settings page where you can configure your data source and sync settings.
```

--------------------------------

### Creating Workflows Tutorial

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

A guide on the basics of creating workflows in BuildShip. Covers the fundamental steps and concepts for building automated processes.

```BuildShip
Creating Workflows
```

--------------------------------

### Hello World API

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

A simple hello world API to get you familiar with BuildShip.

```REST
GET /

```

--------------------------------

### Chat with Database Assistant

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

Get an assistant to give recommendations to customers based on dishes from a database and handle commands and orders.

--------------------------------

### BuildShip Assistant Instructions for Email Sending

Source: https://docs.buildship.com/ai-assistant/assistant

Defines the core instructions for an AI assistant specialized in sending emails. It outlines the assistant's role, how to use provided tools ('send email', 'get contacts'), and specific guidelines for interacting with contacts and sending emails using the Gmail API.

```text
You are specialized in sending emails with a concise response given a context. Users will describe the message they want to send and the expected recipient.
When you are given tools to use, you must use them following the guidelines for each tool. Guidelines:
- After accessing contacts must use 'send email' tool to send an email using Gmail API
- You must always use 'get contacts' to access contacts and return a list of emails
```

--------------------------------

### BuildShip Assistant Instructions with Signature

Source: https://docs.buildship.com/ai-assistant/assistant

Provides updated instructions for the AI assistant, including a specific signature for outgoing emails. It reiterates the email sending specialization and the use of tools like 'get contacts' and 'send email'.

```text
You are specialized in sending emails with a concise response given a context. Users will describe the message they want to send and the expected recipient. When you are given tools to use, you must use them following the guidelines for each tool. Guidelines:
- After accessing contacts must use 'send email' tool to send an email using Gmail API
- Always must use 'get contacts' to access contacts and return a list of emails Your signature should be always: AI
  curated message from Mail Assistant
```

--------------------------------

### BuildShipFile Instance Example

Source: https://docs.buildship.com/file-handling

Demonstrates how to manually create a BuildShipFile instance for 'local-file' type. This is useful for testing or when a file needs to be explicitly represented.

```javascript
const buildShipFile = new BuildShipFile(
  "my-file.txt",
  "local-file",
  "/path/to/my/local/file.txt"
);
```

--------------------------------

### AI Autofill Prompt for Unix Timestamp

Source: https://docs.buildship.com/ai-nodes

An example prompt for the AI Autofill feature, requesting the current Unix timestamp. This showcases how to guide the AI to generate specific data values for node inputs.

```Plain Text
I need to autofill the value to the current unix timestamp
```

--------------------------------

### BuildShip Switch Node: Case Example

Source: https://docs.buildship.com/core-nodes/switch

Shows an example of a case value in the BuildShip Switch Node, used to check if a query's type matches 'image'.

```BuildShip
"image"
```

--------------------------------

### Hello World API

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

A simple 'Hello World' API designed to help users get familiar with the BuildShip platform and its capabilities.

```javascript
// Example usage:
// callHelloWorldAPI();
```

--------------------------------

### Website Q&A Assistant

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

Scrape a website and get your Assistant to answer questions about it.

--------------------------------

### Website Q&A

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

Scrape a website and get your Assistant to answer questions about it. This enables an AI to provide information based on website content.

```OpenAI
Scrape a website.
Answer questions about the website content.
```

--------------------------------

### Using Templates Feature

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

Allows users to leverage pre-built workflow templates to accelerate development. Provides starting points for common use cases.

```BuildShip
Using Templates
```

--------------------------------

### BuildShip API Key Header Configuration

Source: https://docs.buildship.com/tools/elevenlabs

This example demonstrates how to configure the necessary header for authenticating with the BuildShip API, using BUILDSHIP_API_KEY.

```text
Name: BUILDSHIP_API_KEY
Value: your_api_key_here
```

--------------------------------

### BuildShip x WebStudio Integration Tutorial

Source: https://docs.buildship.com/connect-with/webstudio

This tutorial video guides users in using BuildShip with WebStudio. It covers integrating BuildShip with WebStudio, building workflows, making API calls, and connecting the front-end and back-end of an app. Ideal for those looking to simplify app building with BuildShip and WebStudio.

```English
This tutorial video guides users in using BuildShip with WebStudio. The tutorial covers how to integrate BuildShip with WebStudio, including building workflows, making API calls, and integrating the front-end and back-end of the app. The video is ideal for anyone interested in leveraging the capabilities of BuildShip and WebStudio to simplify their app building process.
```

--------------------------------

### Groq Assistant Setup in BuildShip

Source: https://docs.buildship.com/ai-assistant/groq-assistant

This snippet outlines the initial steps to add and configure the Groq AI Assistant Node in a BuildShip workflow. It details finding the node, inputting the API key, and setting up system instructions for the AI.

```BuildShip
Add Node -> Search 'Groq AI Assistant' -> Add to canvas
Configure Node:
  API Key: [Your Groq API Key]
  Instructions: "You are a helpful travel assistant providing recommendations for vacation destinations based on the user's preferences."
```

--------------------------------

### Simple Hello World API

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

A simple hello world API to get your familiar with BuildShip. This provides a basic endpoint for testing the platform.

--------------------------------

### Install Algolia Firebase Extension

Source: https://docs.buildship.com/tutorials/firebase-full-text-search

Instructions for setting up the Algolia Firebase Extension to enable full-text search. This involves getting Algolia API keys and installing the extension.

```bash
firebase ext:install algolia/firestore-algolia-search
```

--------------------------------

### BuildShip WordPress Integration Tutorial

Source: https://docs.buildship.com/connect-with/wordpress

This tutorial demonstrates how to build a low-code application using BuildShip and WordPress. It covers creating workflows, making API calls, importing data into WordPress, and integrating front-end and back-end components.

```N/A
This tutorial video guides users in building a low-code app by leveraging the strengths of BuildShip and WordPress. The tutorial covers creating workflows in BuildShip, making API calls, importing data into WordPress, and seamlessly integrating the front-end and back-end of the app. This video is perfect for anyone looking to streamline their app development process using the low-code functionalities of BuildShip and the versatility of WordPress.
```

--------------------------------

### Typesense Node Output Examples

Source: https://docs.buildship.com/search/typesense

Illustrates the output structure for Typesense operations, including success status and document information.

```json
{
  "success": true,
  "documents": [
    {
      "id": "string"
    }
  ]
}
```

```json
{
  "success": true,
  "document": object
}
```

```json
{
  "success": true
}
```

--------------------------------

### BuildShip Assistant Node: Get Contacts

Source: https://docs.buildship.com/ai-assistant/assistant

Details the 'get contacts' node, a function designed to access contact information and return a list of emails. This is a prerequisite for sending emails to specific recipients.

```text
Name → get contacts   
Description → a function to access contacts and return a list of emails
```

--------------------------------

### Assistant Instructions Prompt Structure

Source: https://docs.buildship.com/ai-assistant/assistant

This snippet shows a recommended structure for instructions when using Assistants with tools. It emphasizes providing clear guidelines for tool usage and specific tool descriptions.

```text
{Your Instructions}
When you are given tools to use, you must use them following the guidelines for each tool
Guidelines:
{tool condition} you must use '{toolName}' to {toolDescription}
```

--------------------------------

### BuildShip x Bubble Integration Tutorial

Source: https://docs.buildship.com/connect-with/bubble

This tutorial guides users through building a low-code app with Bubble, covering workflow creation, API calls, data import, and front-end/back-end integration. It's designed for those looking to streamline app development with Bubble's low-code capabilities.

```English
This tutorial video guides users in building a low-code app using Bubble. The tutorial covers building workflows in Bubble, making API calls, importing data, and integrating the front-end and back-end of the app. The video is ideal for anyone interested in simplifying their app building process using the low-code capabilities of Bubble.
```

--------------------------------

### BuildShip x WeWeb Integration Tutorial

Source: https://docs.buildship.com/connect-with/weweb

This tutorial demonstrates how to build a low-code application by combining BuildShip and WeWeb. It covers creating workflows in BuildShip, making API calls, importing data into WeWeb, and integrating the front-end and back-end of the application. This is ideal for users looking to streamline app development with low-code tools.

```English
This tutorial video guides users in building a low-code app combining the powers of BuildShip and WeWeb. The tutorial covers building workflows in BuildShip, making API calls, importing data to WeWeb, and integrating the front-end and back-end of the app. The video is ideal for anyone interested in simplifying their app building process using the low-code capabilities of BuildShip and WeWeb.
```

--------------------------------

### Access Restaurant Menu Data

Source: https://docs.buildship.com/ai-assistant/assistant

This snippet demonstrates configuring an assistant to access a restaurant menu stored in a BuildShip Collection. It involves updating a node's name and description to 'access menu' and 'get the list of dishes from the restaurant menu' respectively. The instructions guide the assistant to use this tool for menu recommendations.

```text
INSTRUCTIONS :
```
You are an expert waitress at an Italian fine-dining restaurant. You are familiar with all of the dishes on the menu and
are able to recommend the best dishes to customers based on their preferences. When you are given tools to use, you must
use them following the guidelines for each tool. Guidelines:
- When the user asks for a menu recommendation you must use the 'access menu' to get the list of dishes from the
  restaurant menu
```
```

--------------------------------

### Generate Meditation Session with OpenAI

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

Generates a 10-minute guided meditation session, complete with relaxing background music and breathing exercises, using OpenAI.

```javascript
// Example usage:
// generateMeditationSession();
```

--------------------------------

### Get Started with Stable Diffusion XL API

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

Access Stable Diffusion XL through its API to integrate its capabilities into your applications. This model is part of a fast-growing open software project.

```text
Get Started with API
```

--------------------------------

### RAG with Meilisearch Starter Template

Source: https://docs.buildship.com/tutorials/rag

This snippet refers to a starter template for implementing Retrieval-Augmented Generation (RAG) using Meilisearch. It's a pre-built solution that can be remixed to get started quickly.

```N/A
You can access the RAG using Meilisearch templates from thisRemix link (opens in a new tab).
```

--------------------------------

### Maintain Conversation with Thread ID

Source: https://docs.buildship.com/ai-assistant/assistant

This example shows how to maintain a conversation with an AI Assistant by including the 'threadId' in subsequent requests. It's crucial for preserving chat context when interacting with the assistant.

```JSON
{
  "message":"your_new_message",
  "threadId":"your_thread_id"
}
```

--------------------------------

### Generate Meditation Session with Replicate

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

Generates a 10-minute meditation session with a relaxing background, gentle music, and guided breathing exercises using Replicate.

```python
from replicate import Client

client = Client(api_token="YOUR_REPLICATE_API_TOKEN")
output = client.run(
    "replicate/meditate-gpt:77031721073a3837333111477117111711171117111711171117111711171117",
    input={"prompt": "Generate a 10-minute meditation session"}
)
print(output)
```

--------------------------------

### OpenAI Assistant Instructions

Source: https://docs.buildship.com/ai-assistant/assistant

These are the instructions for an OpenAI Assistant designed to act as an expert on Douglas Engelbart. The instructions specify the persona, tone, and requirements for providing detailed, casual, and referenced answers based on provided materials.

```text
You are an expert on Douglas Engelbart. You have access to his original papers and books, and you can answer questions
in a comprehensive, casual, and easy-to-read manner. You give detailed insights and explanations with a friendly and
approachable tone. You are here to make learning about this computing legend as engaging and accessible as possible.
You must always provide references from the materials you have access to.
```

--------------------------------

### Runtime Service Account Email

Source: https://docs.buildship.com/tutorials/custom-domain

This snippet provides the email address of the runtime service account for BuildShip. This email is used to grant ownership permissions in Google Search Console.

```text
runtime@buildship-app.iam.gserviceaccount.com
```

--------------------------------

### Configure CNAME Record for Subdomain

Source: https://docs.buildship.com/tutorials/custom-domain

This snippet shows how to configure a CNAME record for a subdomain, pointing it to a specific hostname. This is a common step in connecting custom domains or subdomains to services.

```text
Name: api
Type: CNAME
Value: ghs.googlehosted.com
```

--------------------------------

### Set CNAME Record for Custom Domain

Source: https://docs.buildship.com/tutorials/custom-domain

This snippet shows the general DNS configuration required for setting up a custom domain. It specifies the record type (CNAME) and the necessary values for the host and target.

```text
Record Type: CNAME
Host: your-subdomain
Target: your-buildship-workspace.buildship.run
```

--------------------------------

### AI Assistant Use Cases with BuildShip

Source: https://docs.buildship.com/ai-assistant/assistant

Explore various practical applications of AI assistants built with BuildShip, including interacting with documents, answering website queries, analyzing data, and managing quizzes. Each use case provides a step-by-step approach to implementation.

```English
Use case (I): Chat with Assistant
Use Case (II): Document Retrieval from OpenAI
Use case (III): Website Q&A
Step 1. Decide which nodes to use
Step 2. Decide which inputs will be auto-filled
Step 3. Test it out
Use case (IV): Chat with your GSheets
Use case (V): Data analyst assistant
Use case (VI): Chat with your database
Step 1. Prepare your data
Step 2. Update instructions and node descriptions
Step 3 Test it out
Use case (VII): Quiz Master
Step 1. Add nodes and describe them
Step 2. Decide which inputs will be auto-filled
Step 3. Modify the instructions
Use case (VIII): Email Assistant
Step 1. Create the Assistant
Step 2. Add the nodes and describe them
Step 3. Test it out
```

--------------------------------

### Hello World API

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

A basic 'Hello World' API designed to familiarize users with BuildShip.

--------------------------------

### BuildShip x WebFlow Integration Tutorial

Source: https://docs.buildship.com/connect-with/webflow

This tutorial demonstrates how to build a low-code application by integrating BuildShip and WebFlow. It covers creating workflows in BuildShip, making API calls, importing data into WebFlow, and connecting the front-end and back-end components of the application.

```English
This tutorial video guides users in building a low-code app combining the powers of BuildShip and WebFlow. The tutorial covers building workflows in BuildShip, making API calls, importing data to WebFlow, and integrating the front-end and back-end of the app. The video is ideal for anyone interested in simplifying their app building process using the low-code capabilities of BuildShip and WebFlow.
```

--------------------------------

### BuildShip Google Workspace Authentication Initiation

Source: https://docs.buildship.com/productivity/google-workspace

This describes the process of initiating authentication for Google Workspace nodes in BuildShip. It highlights the 'Fingerprint Icon' which indicates the authentication status and guides users on how to click it to start the OAuth flow.

```Markdown
* Click on the Fingerprint Icon associated with the desired Google Workspace node.
  * This action initiates an OAuth authentication window, prompting users to log in to the integration securely via their associated Google Accounts.
```

--------------------------------

### Prompt for Complementary Product Recommendation

Source: https://docs.buildship.com/ai-assistant/assistant

This JSON object demonstrates a follow-up prompt to the AI assistant, seeking a complementary product for a previously recommended item. It includes the user's preference ('I like the Valetta one, which small table combines with it') and a thread identifier for context.

```json
{ "message":"I like the Valetta one, which small table combines with it","threadId":"your_thread_id" }
```

--------------------------------

### Chat with Database: Recommend Dishes

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

Provides an assistant to recommend dishes to customers based on data from a database and handle commands and orders.

--------------------------------

### Transcribe Speech to Text with Whisper

Source: https://docs.buildship.com/ai-models/fal-ai

Converts spoken audio into written text using Fal AI's Whisper model. Requires the public download URL of an audio file. Upload audio to BuildShip Storage Manager to get the URL.

```python
from buildship.ai.whisper import Whisper

# Initialize the model
model = Whisper()

# Provide the public download URL of the audio file
audio_url = "YOUR_AUDIO_FILE_PUBLIC_URL"

# Transcribe the audio
text = model.transcribe(audio_url=audio_url)

# Print the transcribed text
print(text)
```

--------------------------------

### Test WhatsApp Message Setup

Source: https://docs.buildship.com/triggers-bots/whatsapp-bot

A guide on testing the WhatsApp bot integration by sending a test message. It involves selecting a 'From' number (Meta test number) and a 'To' number, then sending a message to confirm receipt of a 'Hello World' response.

```Meta API
Meta Developer Account (WhatsApp >> API Setup):
  Select 'From' number (Meta test number).
  Select 'To' number (recipient phone number).
  Click 'Send message' to test.
```

--------------------------------

### Configure Scrape Web URL Node

Source: https://docs.buildship.com/ai-assistant/assistant

This snippet shows how to update the name and description for a 'Scrape Web URL' node in BuildShip. It defines the new name as 'get website' and the description as 'Scrape a given web url and return the text content'.

```text
New Name → get website
New Description → Scrape a given web url and return the text content
```

--------------------------------

### User Query: Count Teachers

Source: https://docs.buildship.com/ai-assistant/assistant

This is an example of a user's message to the AI assistant, asking a specific question about the data. The query 'How many users are teachers?' is designed to test the assistant's ability to retrieve and count specific information from the linked spreadsheet.

```json
{ "message":"How many users are teachers?" }
```

--------------------------------

### Perplexity AI Node - Sample System Prompt

Source: https://docs.buildship.com/ai-models/perplexity

Provides an example of a system prompt for the Perplexity AI Node, setting the context for the AI model as a kitchen assistant.

```text
You are a helpful kitchen assistant. You'll be asked to provide recipes for various dishes.
```

--------------------------------

### AI Assistant Instructions for Data Analysis

Source: https://docs.buildship.com/ai-assistant/assistant

This section provides detailed instructions for an AI assistant acting as a Data Insight Analyst. It outlines the expected persona, tone, and behavior, including how to use provided tools like 'Get Sheets' for data analysis and when to request more information.

```text
You are a Data Insight Analyst. You should be concise and accurate and provide accurate analysis, ensuring that its
interpretations and groupings are well-supported by the data. You have a formal, professional tone, focusing on
providing concise, evidence-based responses. When additional information is needed for a comprehensive analysis, you
will request more data rather than making assumptions. You should avoid speculation and you should provide precise, relevant analytical insights, tailored to enhance the user's understanding of the data
When you are given tools to use, you must use them following the guidelines for each tool. Guidelines:
- when you start, you must use 'Get Sheets' to access user survey data from Google Spreadsheets
```

--------------------------------

### Chat with your Database

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

Get an assistant to give recommendations to customers based on dishes from a database and handle commands and orders. This allows for an AI-powered customer service interface.

```OpenAI
Provide recommendations based on database content.
Handle customer commands and orders.
```

```BuildShip database
Access data from a database.
```

--------------------------------

### Update Tool Description for Google Sheets Access

Source: https://docs.buildship.com/ai-assistant/assistant

This code snippet illustrates how to update the description of a tool, specifically the 'get sheets' node, to clearly state its function. A concise and accurate description helps the AI understand and utilize the tool correctly when processing user requests.

```text
access Azure Home collection of products in Google Spreadsheets
```

--------------------------------

### Website Q&A: Scrape and Answer Questions

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

Scrapes a website to allow an assistant to answer questions about its content.

--------------------------------

### Get Started with Stable Diffusion 3 API

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

Access Stable Diffusion 3, Stability AI's most advanced image model, via API. This model offers improved performance in multi-subject prompts, image quality, and spelling. Contact Stability AI for deployment options.

```text
Get Started with API
```

--------------------------------

### Setup BuildShip AI Assistant with Google Sheets

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

This snippet outlines the steps to set up an AI assistant using the BuildShip Chat with GSheets template. It involves cloning the template, configuring API keys, authenticating with Google, and deploying the workflow.

```bash
1. Setup an account on BuildShip
2. Create a workflow by cloning this template
3. Add your Open API key and your Assistant ID to the secret manager
4. Auth with Google within the ‘Get sheet’ node
5. Finally, click Ship 🚀 to deploy the workflow
```

--------------------------------

### Telegram Bot Trigger Setup

Source: https://docs.buildship.com/triggers-bots/telegram-bot

This section details the steps to set up a Telegram Bot Trigger in BuildShip. It covers cloning a template, adding a personal UID, and starting the bot on Telegram. It also outlines the manual process of creating a workflow, adding the trigger, and configuring nodes.

```BuildShip Workflow
1. Clone the Telegram Bot Template.
2. Add your personal UID.
3. Search and start your bot on Telegram.
4. Start chatting with your Bot.

Manual Option:
1. Add the Telegram Bot Trigger.
2. Verification Code (optional).
3. Add "Send Telegram message" Node.
4. Return success status and click Ship.
5. Send a message to Test.
```

--------------------------------

### Connect Tools and Databases

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

Add your tools and databases to the AI assistant. The AI will intelligently select the best tool or data source for the job and populate necessary values.

```N/A
Add your tools and database. AI picks the best for the job and fills values
```

--------------------------------

### Telegram Bot Trigger Setup

Source: https://docs.buildship.com/trigger-nodes/telegram-bot

This section details the steps to set up a Telegram Bot Trigger in BuildShip. It covers cloning a template, adding a personal UID, and starting the bot on Telegram. It also outlines the manual process of creating a workflow, adding the trigger, and configuring nodes.

```BuildShip Workflow
1. Clone the Telegram Bot Template.
2. Add your personal UID.
3. Search and start your bot on Telegram.
4. Start chatting with your Bot.

Manual Option:
1. Add the Telegram Bot Trigger.
2. Verification Code (optional).
3. Add "Send Telegram message" Node.
4. Return success status and click Ship.
5. Send a message to Test.
```

--------------------------------

### BuildShip Node Submission Process

Source: https://docs.buildship.com/community-nodes

This outlines the steps required to submit a newly created node to the BuildShip community library. It details opening the node menu, passing automated submission checks, completing the submission form, and the subsequent review and approval process.

```English
1. Open the Node Menu
2. Pass Submission Checks
3. Fill Out the Submission Form
4. Review and Approval
```

--------------------------------

### Continue Conversation with OpenAI Assistant using Thread ID

Source: https://docs.buildship.com/ai-assistant/assistant

This example shows how to maintain a conversation with an OpenAI Assistant by including the previous thread ID in the subsequent request. It illustrates sending a reply along with the thread ID to continue the dialogue, followed by the assistant's response confirming the correct answer and maintaining the thread.

```json
{ "message":"The School Of Athens","threadId":"your_thread_id" }
```

```json
{
"response":"Correct! *The School of Athens* is not a work by Leonardo da Vinci. It was actually painted by Raphael,
another master of the Renaissance.",
"threadId":"thread_KHdD6NGPwx0yY6mIkj0UgMPe"
}
```

--------------------------------

### AI Handoff Prompt for BuildShip API

Source: https://docs.buildship.com/tools/vibe-coder

This prompt template is designed for AI App Builders to auto-generate a frontend that connects to a BuildShip API endpoint. It includes rules for input validation, output handling, and provides example inputs and expected output structure. The prompt also contains a JavaScript function for calling the endpoint.

```JavaScript
Create an intuitive & responsive webapp using the given endpoint and the example inputs
Rules:
- Use only the inputs given
- Include validation for required fields if needed
- Handle the output properly depending what it returns (string, number, etc) especially incase of returning lists or json outputs

async function callEndpoint(param1, param2) {
  const url = "{YOUR_HOST}/executeWorkflow/{YOUR_FLOW_ID}/{YOUR_TRIGGER_ID}";
  const apiKey = "YOUR_API_KEY"; // Replace with your actual API key
  const params = {
    param1: param1,
    param2: param2
  };
  try {
    const response = await fetch(url, {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
        'BUILDSHIP_API_KEY': apiKey
      },
      body: JSON.stringify(params)
    });
    const result = await response.json();
    console.log('Success:', result);
    return result;
  } catch (error) {
    console.error('Error:', error);
  }
}

Here are sample inputs:
{
  param1: string,
  param2: number
}

The output of this endpoint is:
{
  result: string
}
```

--------------------------------

### Verify Node.js and npm Installation

Source: https://docs.buildship.com/tools/claude

This snippet demonstrates how to verify the installation of Node.js and npm on your system. It uses command-line commands to check the versions of both Node.js and npm, ensuring they are correctly installed and accessible.

```shell
node -v
npm -v
```

--------------------------------

### Prompt for Sofa Recommendations

Source: https://docs.buildship.com/ai-assistant/assistant

This JSON object represents a user's message to the AI assistant, requesting specific product recommendations. It includes the core query ('Give me 3 sofa recommendations for less than 1k') and is formatted for interaction with the assistant.

```json
{ "message":"Give me 3 sofa recommendations for less than 1k" }
```

--------------------------------

### Install Node.js Dependencies for BuildShip

Source: https://docs.buildship.com/tools/node-js

This snippet shows how to install the 'node-fetch' package, version 2, which is required for Node.js integration with BuildShip workflows. Ensure you have Node.js and npm installed.

```bash
npminstallnode-fetch@2
```

--------------------------------

### User Query: Challenges with Quotes and Percentages

Source: https://docs.buildship.com/ai-assistant/assistant

This user query requests a more detailed analysis of learning challenges, specifically asking for the data to be presented as percentages with supporting quotes from users. It also includes the 'threadId' for conversational continuity.

```json
{
"message":"give me this data of difficulty on understanding concepts in % and with quotes of users",
"threadId":"thread_Ey5hYxgvbXK674uaCCjOq2ux"
}
```

--------------------------------

### BuildShip x FlutterFlow Integration Tutorial

Source: https://docs.buildship.com/connect-with/flutterflow

This tutorial demonstrates integrating BuildShip with FlutterFlow. It covers creating workflows in BuildShip, executing API calls, importing data into FlutterFlow, and connecting the front-end and back-end of an application. It's designed for users looking to streamline app development with low-code tools.

```English
This tutorial video guides users in building a low-code app combining the powers of BuildShip and Flutterflow. The tutorial covers building workflows in BuildShip, making API calls, importing data to Flutterflow, and integrating the front-end and back-end of the app. The video is ideal for anyone interested in simplifying their app building process using the low-code capabilities of BuildShip and Flutterflow.
```

--------------------------------

### BuildShip Database Nodes - Get Document

Source: https://docs.buildship.com/basics/buildship-tables

Illustrates how to retrieve a specific document from a BuildShip database collection using its unique ID with the 'Get Document' node.

```BuildShip Nodes
Get Document:
  Collection: "your_collection"
  Document ID: "document_id"
```

--------------------------------

### BuildShip Node Output Configuration Example

Source: https://docs.buildship.com/nodes/output

This JSON object represents a sample output configuration for a node within the BuildShip platform. It includes fields for description, type, title, and properties, defining the structure of the node's output.

```json
{
"buildship": {},
"description":"The response from the Cohere detectLanguage API",
"type":"object",
"title":"Cohere Response",
"properties": {}
}
```

--------------------------------

### Gmail Nodes: Get Labels

Source: https://docs.buildship.com/productivity/google-workspace/gmail

The Get Labels node retrieves a list of label IDs and names from your Gmail account using the Gmail API. This is useful for organizing or filtering emails.

```Node.js
const getGmailLabels = async () => {
  // Implementation details for retrieving labels using Gmail API
  console.log('Retrieving Gmail labels...');
  // ... API call to get labels ...
  return [{ id: 'INBOX', name: 'INBOX' }, { id: 'SENT', name: 'SENT' }];
};
```

--------------------------------

### Chat with Database AI Assistant

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

Build an AI assistant to provide customer recommendations based on dishes from a database and handle commands and orders.

```BuildShip database
Get an assistant to give recommendations to customers based on dishes from a database and handle commands and orders.
```

--------------------------------

### Get Single Record from Airtable

Source: https://docs.buildship.com/database/airtable

Explains the Get Record Node, which allows users to retrieve a specific record from an Airtable base using its Record ID.

```text
Use the Record ID to get the record.
```

--------------------------------

### BuildShip Database Nodes - Get Field Value

Source: https://docs.buildship.com/basics/buildship-tables

Explains how to retrieve the value of a specific field from a document in a BuildShip database using the 'Get Field Value' node.

```BuildShip Nodes
Get Field Value:
  Collection: "your_collection"
  Document ID: "document_id"
  Field: "fieldName"
```

--------------------------------

### Perplexity AI Node - Sample User Input

Source: https://docs.buildship.com/ai-models/perplexity

Demonstrates a sample user input for the Perplexity AI Node, posing a question about a recipe and listing available ingredients.

```text
What is the recipe for a classic Margherita pizza? I have pizza dough, tomato sauce, mozzarella cheese, garlic cloves, and fresh basil.
```

--------------------------------

### Typesense Add Document Input Example

Source: https://docs.buildship.com/search/typesense

Shows an example of a document object that can be inserted into a Typesense collection using the 'Add Document' node in BuildShip. The structure should align with the collection's defined schema.

```json
{
"id":"1",
"name":"Jon Snow",
"email":"jonsnow@gmail.com"
}
```

--------------------------------

### MongoDB Connection String Example

Source: https://docs.buildship.com/database/mongodb

An example of a MongoDB connection string used to establish a connection to a MongoDB Atlas cluster. This string includes placeholders for username, password, cluster address, and database name.

```text
mongodb+srv://<username>:<password>@<cluster>/<database>?retryWrites=true&w=majority
```

--------------------------------

### Generate Image with Stable Diffusion XL

Source: https://docs.buildship.com/ai-models/fal-ai

Generates an image based on a text prompt using the Stable Diffusion XL model. Users input a descriptive prompt to guide the image creation process.

```python
from buildship.ai.stable_diffusion_xl import StableDiffusionXL

# Initialize the model
model = StableDiffusionXL()

# Define the prompt
prompt = "photo of a rhino dressed suit and tie sitting at a table in a bar with a bar stools, award winning photography, Elke vogelsang"

# Generate the image
image = model.generate(prompt=prompt)

# Save or display the image
image.save("rhino_in_bar.png")
```

--------------------------------

### Music Generation with Replicate and OpenAI

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

Generate music based on a prompt, including lyrics created by OpenAI and music generated by Replicate's MusicGen model. This is a low-code, extensible solution.

```MusicGen
Generate music for any giving prompt style. First generate a lyrics using OpenAI then generate music for that lyrics using Replicate MusicGen model. All this visually, using low-code. Fully extensible...
```

--------------------------------

### Using 'Get Data' Feature in BuildShip

Source: https://docs.buildship.com/triggers

This explains how to use the 'Get Data' feature in BuildShip to dynamically set workflow inputs based on incoming request data. It requires the trigger to be connected and supports API-based and integration-based triggers.

```BuildShip
1. **Connect** your Trigger.
2. If available on the preview tab, the trigger supports 'Get Data'.
3. For API-based triggers: Copy the endpoint to a testing platform (Postman, Hoppscotch) and send a request.
4. For integration-based triggers (Stripe, Supabase): Send a dummy webhook request from the developer dashboard or trigger the event.
5. Once a request is received, a tree structure of properties will be displayed. Select required inputs and click 'Add inputs to schema'.
```

--------------------------------

### Generate Music with Replicate MusicGen

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

This snippet describes the process of generating music using the Replicate MusicGen model. It involves first creating lyrics with OpenAI and then using Replicate to generate music based on those lyrics. The process is designed to be visually manageable with a low-code approach and is fully extensible.

```text
Generate music for any giving prompt style. First generate a lyrics using OpenAI then generate music for that lyrics using Replicate MusicGen model. All this visually, using low-code. Fully extensible...
```

--------------------------------

### Syncing Documentation to Vector Index with BuildShip

Source: https://docs.buildship.com/tutorials/vector-applications

Demonstrates a workflow for syncing website documentation to a vector index using BuildShip nodes. It involves fetching sitemap URLs, scraping content, generating embeddings, and upserting to a vector database like Pinecone.

```workflow
Fetch sitemap XML
Convert XML to JSON
Extract URLs from JSON
Loop through URLs:
  Scrape Web URL content
  Generate Embeddings (OpenAI ada model)
  Parse embeddings to JSON
Upsert Document to Pinecone
```

--------------------------------

### Using 'Get Data' Feature in BuildShip

Source: https://docs.buildship.com/basics/trigger

This explains how to use the 'Get Data' feature in BuildShip to dynamically set workflow inputs based on incoming request data. It requires the trigger to be connected and supports API-based and integration-based triggers.

```BuildShip
1. **Connect** your Trigger.
2. If available on the preview tab, the trigger supports 'Get Data'.
3. For API-based triggers: Copy the endpoint to a testing platform (Postman, Hoppscotch) and send a request.
4. For integration-based triggers (Stripe, Supabase): Send a dummy webhook request from the developer dashboard or trigger the event.
5. Once a request is received, a tree structure of properties will be displayed. Select required inputs and click 'Add inputs to schema'.
```

--------------------------------

### Calculate Workflow Executions (Example)

Source: https://docs.buildship.com/tutorial/scrape/crawler-output

This example demonstrates how to calculate the number of workflow executions based on available execution hours and the average execution time of a workflow. It's useful for understanding usage limits.

```text
3 hours in seconds / 2 seconds = 5400 workflow executions
```