# Docs ## architecture - [Platform Architecture](/architecture): ByteChef is an open-source, enterprise-ready platform for API integration and workflow automation. ## glossary - [Glossary](/glossary): Terms used in ByteChef platform. ## introduction - [Introduction](/introduction): This is the documentation for ByteChef, an open-source workflow automation platform that connects your entire tech stack with AI-powered intelligence. ## quickstart - [Quick Start](/quickstart): This guide walks you through the basics of ByteChef in a few minutes. You'll learn how to build a workflow quickly, so no much configuration needed. ## what-is-bytechef - [What is ByteChef?](/what-is-bytechef): ByteChef is an open-source, enterprise-ready platform for building AI agents, automating workflows, and integrating applications across SaaS, APIs, and databases with flexible deployment. ## automation - [Introduction](/automation/overview): Learn the basics of ByteChef Automation and how to create your first workflow. - [Overview](/automation/build): An introduction to building and managing projects and workflows in ByteChef. - [Projects](/automation/build/projects): Learn how to create, manage, and organize projects within ByteChef. - [Universal AI](/automation/build/universal-ai): Learn how to work with AI Text and AI Image - [Workflows](/automation/build/workflows): Learn how to create, edit, and manage workflows effectively. - [Overview](/automation/monitor): An introduction to monitoring projects and workflows in ByteChef. - [Projects](/automation/monitor/projects): Learn how to monitor projects and workflows in ByteChef. - [Overview](/automation/connect-data/overview): Learn how to connect and manage third-party application connections in ByteChef. - [Troubleshooting](/automation/connect-data/troubleshooting): Common issues and solutions when setting up or using connections in ByteChef. - [Overview](/automation/deploy): An introduction to deploying projects and workflows in ByteChef. - [Projects](/automation/deploy/projects): Learn how to deploy projects and workflows in ByteChef. - [Configure Workflow Trigger](/automation/quick-start/configure-workflow-trigger): Learn how to create and configure a workflow with a trigger in ByteChef. - [Star Repository on GitHub](/automation/quick-start/star-repository-on-github): Learn how to connect your GitHub account to ByteChef and star a repository. - [API Key Authentication](/automation/connect-data/authentication/api-key): Learn how to use API Keys to connect to third-party services in ByteChef - [Basic Authentication](/automation/connect-data/authentication/basic): Learn how to use Basic Authentication to connect to third-party services in ByteChef - [Bearer Authentication](/automation/connect-data/authentication/bearer): Learn how to use Bearer Tokens to connect to third-party services in ByteChef - [OAuth 2.0 Authentication](/automation/connect-data/authentication/oauth2): Learn how to use OAuth 2.0 to connect to third-party services in ByteChef ## developer-guide - [Developer Guide](/developer-guide): This guide provides comprehensive information on building components and enabling observability features. - [Working with Triggers](/developer-guide/working-with-triggers): Working with Triggers as a developer - [Add Connection](/developer-guide/build-component/add-connection): How to create connection for a component. - [Create Action](/developer-guide/build-component/create-action): How to create an action for a component. - [Create Component Definition](/developer-guide/build-component/create-component-definition): How to create a new component definition. - [Create Trigger](/developer-guide/build-component/create-trigger): How to create a trigger for a component. - [Initial Setup](/developer-guide/build-component/initial-setup): Learn how to create a new component - [Write Tests](/developer-guide/build-component/write-tests): How to write tests for your component. - [Action](/developer-guide/component-specification/action): undefined - [Component](/developer-guide/component-specification/component): undefined - [Connection](/developer-guide/component-specification/connection): undefined - [Property](/developer-guide/component-specification/property): undefined - [Trigger](/developer-guide/component-specification/trigger): undefined - [Create Trigger](/developer-guide/generate-component/create-trigger): How to create a trigger for a component. - [Customize Component](/developer-guide/generate-component/customize-component): undefined - [Generate Component](/developer-guide/generate-component): undefined - [Initial Setup](/developer-guide/generate-component/initial-setup): undefined - [OpenAPI Specification](/developer-guide/generate-component/open-api-specification): undefined ## embedded - [Introduction](/embedded): undefined - [Quick Start](/embedded/quickstart): undefined - [Automations](/embedded/automations): Monitor automation workflows running for connected users. - [App Events](/embedded/app-events): Trigger integration workflows based on events from your application. - [Integration Configurations](/embedded/configurations): Deploy and manage integration instances assigned to specific environments. - [Connections](/embedded/connections): Manage authentication credentials and connection configurations for third-party services. - [Workflow Executions](/embedded/executions): View the execution history of all integration and automation workflows. - [Connected Users](/embedded/connected-users): View and manage end users who have connected integrations through your embedded iPaaS. - [Integrations](/embedded/integrations): Create and manage integrations that connect your product to third-party services. - [MCP Servers](/embedded/mcp-servers): Expose integration components as MCP-compatible tool servers. ## openapi - [Overview](/openapi): undefined - [Get all planets](/openapi/getAllData): It’s easy to say you know them all, but do you really? Retrieve all the planets and check whether you missed one. - [Create a planet](/openapi/createPlanet): Time to play god and create a new planet. What do you think? Ah, don’t think too much. What could go wrong anyway? - [Get a planet](/openapi/getPlanet): You’ll better learn a little bit more about the planets. It might come in handy once space travel is available for everyone. - [Delete a planet](/openapi/deletePlanet): This endpoint was used to delete planets. Unfortunately, that caused a lot of trouble for planets with life. So, this endpoint is now deprecated and should not be used anymore. - [Update a planet](/openapi/updatePlanet): Sometimes you make mistakes, that's fine. No worries, you can update all planets. - [Upload an image to a planet](/openapi/uploadImage): Got a crazy good photo of a planet? Share it with the world! - [Create a user](/openapi/createUser): Time to create a user account, eh? - [Get a token](/openapi/getToken): Yeah, this is the boring security stuff. Just get your super secret token and move on. - [Get authenticated user](/openapi/getMe): Find yourself they say. That’s what you can do here. - [New Planet](/openapi/newplanet): undefined ## platform - [AI Copilot](/platform/copilot): Use the AI Copilot to ask questions and build workflows in ByteChef - [MCP Server](/platform/mcp-server): Connect AI assistants to ByteChef using the Model Context Protocol - [Overview](/platform/overview): ByteChef is an open-source, enterprise-ready platform for API integration and workflow automation. - [Evals](/platform/ai/agent/evals): Test and evaluate your AI agents with scenario-based evaluations and automated judges - [Skills](/platform/ai/agent/skills): Package expert instructions, coding guidelines, and process documentation into reusable modules for your AI agents - [Check For Violations](/platform/ai/agent/guardrails/check-for-violations): The blocking parent action that runs configured guardrails and short-circuits the request when any child flags a violation - [Custom Regex](/platform/ai/agent/guardrails/custom-regex): Operator-supplied regex patterns with named placeholders for project-specific identifiers - [Custom](/platform/ai/agent/guardrails/custom): Operator-defined LLM classifier prompts for arbitrary policy checks - [Guardrails](/platform/ai/agent/guardrails): Block, mask, or rewrite content flowing into and out of your AI agents with rule-based and LLM-based safety checks - [Jailbreak](/platform/ai/agent/guardrails/jailbreak): LLM-based classifier for prompt-injection and role-override attempts - [Keywords](/platform/ai/agent/guardrails/keywords): Word-boundary-aware match against a configured keyword list, run at PREFLIGHT against the raw input. Available as both a Check (block) and a Sanitize (mask) variant. - [LLM PII](/platform/ai/agent/guardrails/llm-pii): Classifier-based PII detection for free-form spans that rule-based regex misses - [NSFW](/platform/ai/agent/guardrails/nsfw): LLM-based classifier for sexual, violent, self-harm, hate-speech, and illegal-activity content - [PII](/platform/ai/agent/guardrails/pii): Rule-based detection of personally-identifiable information — emails, phones, SSNs, IBANs, credit cards, IPs, and locale-specific identifiers - [Sanitize Text](/platform/ai/agent/guardrails/sanitize-text): The non-blocking parent action that runs configured sanitizers and rewrites matched spans with placeholders - [Secret Keys](/platform/ai/agent/guardrails/secret-keys): Rule-based detection of API tokens and credential shapes — AWS, GitHub, Stripe, OpenAI, Slack, Google, JWT, and a tunable random-string detector - [Topical Alignment](/platform/ai/agent/guardrails/topical-alignment): LLM-based classifier that the input stays inside an operator-defined topic scope - [URLs](/platform/ai/agent/guardrails/urls): Allowlist-based URL policy enforcement with scheme, port, userinfo, and subdomain controls ## reference - [Expressions](/reference/expressions): Expressions in ByteChef provide a powerful way to dynamically access, transform, and manipulate data within your workflows. They allow you to reference data from previous steps, perform calculations, implement conditional logic, and create dynamic configurations for your automation processes. - [Overview](/reference): The Reference section provides comprehensive documentation for all ByteChef components and flow controls. - [Branch](/reference/flow-controls/branch_v1): Executes one and only one branch of execution based on the `expression` value. - [Condition](/reference/flow-controls/condition_v1): Directs a stream based on true/false results of comparisons. - [Each](/reference/flow-controls/each_v1): Iterates over each item in list, in parallel. Note, that since it iterates over each item in parallel, there is no guarantee of completion order. - [Fork/Join](/reference/flow-controls/fork-join_v1): Executes each branch in parallel (list of tasks) as a separate and isolated sub-flow. Branches are executed internally in sequence. - [Loop Break](/reference/flow-controls/loop-break_v1): Breaks the loop execution. - [Loop](/reference/flow-controls/loop_v1): Loops sequentially over list of items. - [Map](/reference/flow-controls/map_v1): Produces a new collection of values by mapping each value in list through defined task, in parallel. When execution is finished on all items, the `map` task will return a list of execution results in an order which corresponds to the order of the source list. - [Error Handler](/reference/flow-controls/on-error_v1): Triggers an error branch with an error object if an exception occurs in the main branch. - [Parallel](/reference/flow-controls/parallel_v1): Run collection of tasks in parallel, without waiting until the previous function has completed. - [Subflow](/reference/flow-controls/subflow_v1): Starts a new job as a sub-flow of the current job. Output of the sub-flow job is the output of the task. - [Stop Job](/reference/flow-controls/terminate_v1): Stops a job execution with specified status and message. - [Wait for Approval](/reference/flow-controls/wait-for-approval_v1): Allows a person to review and either approve or reject requests. - [Accelo](/reference/components/accelo_v1): Accelo is a cloud-based platform designed to streamline operations for service businesses by integrating project management, CRM, and billing functionalities into one unified system. - [ActiveCampaign](/reference/components/active-campaign_v1): ActiveCampaign is a customer experience automation platform that offers email marketing, marketing automation, sales automation, and CRM tools. - [Acumbamail](/reference/components/acumbamail_v1): Acumbamail is an email marketing and automation platform that allows users to create, manage, and analyze email campaigns, newsletters, and SMS marketing with an intuitive interface and API integration. - [Affinity](/reference/components/affinity_v1): Affinity is a customer relationship management (CRM) platform that leverages relationship intelligence to help businesses strengthen connections and drive engagement with client and prospects. - [Agile CRM](/reference/components/agile-crm_v1): All-in-One CRM. Automate your sales, marketing, and service in one platform. Avoid data leaks and enable consistent messaging. - [Aha!](/reference/components/aha_v1): Aha! is a comprehensive product management software platform that helps teams set strategy, capture ideas, and plan, prioritize, and track work to build products customers love. - [Ahrefs](/reference/components/ahrefs_v1): Ahrefs is a comprehensive suite of SEO (Search Engine Optimization) tools used by digital marketers and businesses to improve their website's visibility in search engine results. - [AI Agent](/reference/components/ai-agent_v1): With the AI Agent, you can chat with the AI agent. - [AI Image](/reference/components/ai-image_v1): AI Helper component for image analysis and generation. - [AI Text](/reference/components/ai-text_v1): AI Helper component for text analysis and generation. - [AI Agent Utils](/reference/components/ai_agent-utils_v1): AI Agent Utils brings Claude Code-inspired tools and agent skills. - [Airtable](/reference/components/airtable_v1): Airtable is a user-friendly and flexible cloud-based database management tool. - [AITable.ai](/reference/components/aitable_v1): AITable is an AI-powered platform that enables users to create interactive and dynamic tables for data visualization and analysis without requiring coding skills. - [Amazon Bedrock](/reference/components/amazon-bedrock_v1): Amazon Bedrock is a fully managed service that offers a choice of high-performing foundation models (FMs) from leading AI companies. - [Amplitude](/reference/components/amplitude_v1): Build better products by turning your user data into meaningful insights, using Amplitude's digital analytics platform and experimentation tools. - [Anthropic](/reference/components/anthropic_v1): Anthropic is an AI safety and research company that's working to build reliable, interpretable, and steerable AI systems. - [Apify](/reference/components/apify_v1): Apify is the largest ecosystem where developers build, deploy, and publish data extraction and web automation tools. - [Apollo](/reference/components/apollo_v1): Apollo.io is a sales intelligence and engagement platform that provides tools for prospecting, lead generation, and sales automation to help businesses improve their sales processes and outreach efforts. - [Approval Link](/reference/components/approval-link_v1): The Approval Link component that create approval/disapproval links. - [Approval](/reference/components/approval_v1): Approval component for manual intervention in workflows. - [Asana](/reference/components/asana_v1): Asana is a web and mobile application designed to help teams organize, track, and manage their work tasks and projects efficiently. - [Attio](/reference/components/attio_v1): Attio is the AI-native CRM that builds, scales and grows your company to the next level. - [AWS S3](/reference/components/aws-s3_v1): AWS S3 is a simple object storage service provided by Amazon Web Services. - [Azure OpenAI](/reference/components/azure-open-ai_v1): Azure OpenAI is a research organization that aims to develop and direct artificial intelligence (AI) in ways that benefit humanity as a whole. - [BambooHR](/reference/components/bamboohr_v1): BambooHR is a human resources software that helps HR teams manage employee data, hiring, onboarding, time tracking, payroll, performance management, and more in one platform. - [Baserow](/reference/components/baserow_v1): Baserow is an open-source, no-code database platform that enables users to create, manage, and collaborate on databases through a user-friendly interface. - [Bash](/reference/components/bash_v1): Allows you to run arbitrary Bash scripts. - [Beamer](/reference/components/beamer_v1): Beamer is a customer engagement platform that helps businesses communicate updates, collect feedback, and boost user engagement through in-app notifications, changelogs, and announcements. - [Binance](/reference/components/binance_v1): Binance is an online exchange where users can trade cryptocurrencies. - [Bitbucket](/reference/components/bitbucket_v1): Elevate your software delivery from planning to production and beyond, with built-in AI, CI/CD, and a best-in-class Jira integration. - [Bolna](/reference/components/bolna_v1): Bolna AI is an open-source platform that enables businesses to create and deploy voice-driven conversational agents - [Box](/reference/components/box_v1): Box is a cloud content management and file sharing service that enables businesses to securely store, manage, and collaborate on documents. - [Brave](/reference/components/brave_v1): Brave gives you access to the same powerful, independent search index that powers the privacy-first search engine trusted by millions. - [Brevo](/reference/components/brevo_v1): Brevo is an email marketing platform that offers a cloud-based marketing communication software suite with transactional email, marketing automation, customer-relationship management and more. - [Browser Use](/reference/components/browser-use_v1): AI-powered browser automation that enables agents to perform web tasks such as navigating websites and extracting data. - [Cal.com](/reference/components/calcom_v1): A fully customizable scheduling software for individuals, businesses taking calls and developers building scheduling platforms where users meet users. - [Calendly](/reference/components/calendly_v1): Calendly is a scheduling tool that allows users to easily set up and manage appointments and meetings. - [Canva](/reference/components/canva_v1): Canva is a web and mobile application designed to help users create, design, and collaborate on visual content. - [Capsule CRM](/reference/components/capsule-crm_v1): Capsule CRM is a cloud-based customer relationship management platform designed to help businesses manage contacts, track sales opportunities, and collaborate with their teams efficiently. - [Cassandra Chat Memory](/reference/components/cassandra-chat-memory_v1): Cassandra Chat Memory stores conversation history in Apache Cassandra for distributed, scalable persistent storage. - [Chat Memory](/reference/components/chat-memory_v1): Built-in chat memory. - [Chat](/reference/components/chat_v1): Actions and triggers for using with the chat widget. - [Check for Violations](/reference/components/checkForViolations_v1): Runs configured guardrail checks on the user prompt. - [Claude Code](/reference/components/claude-code_v1): Allows you to chat with Claude Code and added MCP tools - [ClickUp](/reference/components/clickup_v1): ClickUp is a cloud-based collaboration tool that offers task management, document sharing, goal tracking, and other productivity features for teams. - [Coda](/reference/components/coda_v1): Coda is a collaborative all-in-one productivity tool that combines documents, spreadsheets, apps and databases into a single platform. - [Contiguity](/reference/components/contiguity_v1): Contiguity is an SMS service for your needs - quick and simple. - [Copper](/reference/components/copper_v1): Copper is a customer relationship management (CRM) software designed to streamline and optimize sales processes, providing tools for managing contact, leads, opportunities, and communications in one centralized platform. - [Couchbase](/reference/components/couchbase_v1): Couchbase is a distributed, JSON document database, with all the desired capabilities of a relational DBMS. - [Crypto Helper](/reference/components/crypto-helper_v1): The Crypto Helper allows you to use cryptographic functions. - [CSV File](/reference/components/csv-file_v1): Reads and writes data from a csv file. - [Custom Regex](/reference/components/customRegex_v1): User-defined regex guardrail — flags or masks matches of a custom pattern. - [Custom](/reference/components/custom_v1): User-defined LLM-based guardrail. - [Data Mapper](/reference/components/data-mapper_v1): The Data Mapper enables you to configure data mappings. - [Data Storage](/reference/components/data-storage_v1): Using the Data Storage component, you can easily manage and operate on lists and objects by setting or retrieving any desired data. This process employs a key-value store mechanism, where the key represents the field's name and the value corresponds to the particular data's actual value. - [Processor](/reference/components/data-stream-processor_v1): Processes and transforms data in data streams. - [Date Helper](/reference/components/date-helper_v1): Helper component for date and time manipulation. - [DeepSeek](/reference/components/deepseek_v1): DeepSeek AI provides the open-source DeepSeek V3 model, renowned for its cutting-edge reasoning and problem-solving capabilities. - [Delay](/reference/components/delay_v1): Sets a value which can then be referenced in other tasks. - [Dev.to](/reference/components/devto_v1): Dev.to is an online community and platform where software developers share articles, tutorials, and discussions about programming and technology. - [DHL](/reference/components/dhl_v1): DHL is the global leader in the logistics industry. Specializing in international shipping, courier services and transportation. - [Discord](/reference/components/discord_v1): Discord is a communication platform designed for creating communities, chatting with friends, and connecting with others through text, voice, and video channels. - [Document Enricher](/reference/components/document-enricher_v1): Document Enricher. - [Document Joiner](/reference/components/document-joiner_v1): Document Joiner. - [Document Reader](/reference/components/document-reader_v1): Document Reader. - [Document Splitter](/reference/components/document-splitter_v1): Document Splitter. - [DocuSign](/reference/components/docusign_v1): DocuSign is a cloud-based e-signature platform that enables secure digital document signing and workflow automation. - [Dropbox](/reference/components/dropbox_v1): Dropbox is a file hosting service that offers cloud storage, file synchronization, personal cloud, and client software. - [ElevenLabs](/reference/components/elevenlabs_v1): ElevenLabs is an AI-powered voice synthesis company specializing in ultra-realistic text-to-speech and voice cloning technology. - [Email](/reference/components/email_v1): The Email connector sends emails using an SMTP email server. - [Encharge](/reference/components/encharge_v1): Encharge is a marketing automation platform that helps businesses automate their customer communication and marketing campaigns. - [Example](/reference/components/example_v1): Component description. - [Figma](/reference/components/figma_v1): Figma is a cloud-based design and prototyping tool that enables teams to collaborate in real-time on user interface and user experience projects. - [File Storage](/reference/components/file-storage_v1): Reads and writes data from a file stored inside the file storage. - [Filesystem](/reference/components/filesystem_v1): Allows multiple operations over files on the filesystem. - [Firecrawl](/reference/components/firecrawl_v1): Firecrawl allows you to turn entire websites into LLM-ready markdown - [Form](/reference/components/form_v1): Component for handling form submissions and requests. - [Freshdesk](/reference/components/freshdesk_v1): Freshdesk is a cloud-based customer support software that helps businesses manage customer queries and tickets efficiently. - [Freshsales](/reference/components/freshsales_v1): Freshsales is a customer relationship management (CRM) software designed to help businesses streamline sales processes and manage customer interactions effectively. - [FTP](/reference/components/ftp_v1): FTP (File Transfer Protocol) is a standard network protocol for transferring files between a client and a server. It allows uploading, downloading, and managing files on remote servers. - [Bank Connect](/reference/components/gaurus_v1): Bank Connect API specification - [Gemini](/reference/components/gemini_v1): Google Gemini is a multimodal generative AI model. This component supports both Vertex AI and the Gemini Developer API. - [GitHub](/reference/components/github_v1): GitHub is a web-based platform for version control and collaboration using Git. - [GitLab](/reference/components/gitlab_v1): GitLab is a web-based DevOps lifecycle tool that provides a Git repository manager, CI/CD pipelines, issue tracking, and more in a single application. - [Google Application Setup](/reference/components/google-application-setup_v1): Steps for setting up Google Cloud API Console for every Google component. - [Google BigQuery](/reference/components/google-bigquery_v1): Google BigQuery is the autonomous data to AI platform, automating the entire data life cycle, from ingestion to AI-driven insights, so you can go from data to AI to action faster. - [Google Calendar](/reference/components/google-calendar_v1): Google Calendar is a web-based application that allows users to schedule and organize events, appointments, and reminders, synchronizing across multiple devices. - [Google Chat](/reference/components/google-chat_v1): Google Chat is an intelligent and secure communication and collaboration tool, built for teams. - [Google Contacts](/reference/components/google-contacts_v1): Google Contacts is a cloud-based address book service provided by Google, allowing users to store, manage, and synchronize their contact information across multiple devices and platforms. - [Google Docs](/reference/components/google-docs_v1): Google Docs is a cloud-based collaborative word processing platform that allows multiple users to create, edit, and share documents in real-time. - [Google Drive](/reference/components/google-drive_v1): Google Drive is a cloud storage service by Google that enables users to store, sync, share files, and collaborate online. - [Google Forms](/reference/components/google-forms_v1): Google Forms is a web-based application that allows users to create surveys, quizzes, and forms for data collection and analysis, with real-time collaboration and response tracking. - [Gmail](/reference/components/google-mail_v1): Gmail is a widely used email service by Google, offering free and feature-rich communication, organization, and storage capabilities accessible through web browsers and mobile apps. - [Google Maps](/reference/components/google-maps_v1): Google Maps is a widely used mapping service by Google, offering free and feature-rich navigation, location discovery, and real-time traffic updates accessible through web browsers and mobile apps. - [Google Meet](/reference/components/google-meet_v1): Google Meet is a communication service designed to help you have interactions with your friends, family, colleagues and classmates. - [Google Photos](/reference/components/google-photos_v1): Google Photos is a photo sharing and storage service. - [Google Search Console](/reference/components/google-search-console_v1): The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone). - [Google Sheets](/reference/components/google-sheets_v1): Google Sheets is a cloud-based spreadsheet software that allows users to create, edit, and collaborate on spreadsheets in real-time. - [Google Slides](/reference/components/google-slides_v1): Google Slides is a cloud-based presentation software that allows users to create, edit, and collaborate on presentations online in real-time. - [Google Tasks](/reference/components/google-tasks_v1): Google Tasks is a cloud-based task management tool that allows users to create, edit, and organize to-do lists, set deadlines, and track tasks across devices in real-time. - [Google Workspace Admin](/reference/components/google-workspace-admin_v1): Google Workspace Admin is responsible for managing users, groups, devices, and security settings across the organization. - [Gotify](/reference/components/gotify_v1): A simple server for sending and receiving messages. - [GraphQL Client](/reference/components/graphql-client_v1): Execute GraphQL queries against a GraphQL API, allowing you to fetch exactly the data you need using queries and variables. - [Groq](/reference/components/groq_v1): The LPU Inference Engine by Groq is a hardware and software platform that delivers exceptional compute speed, quality, and energy efficiency. - [Guardrails](/reference/components/guardrails_v1): Content validation and safety guardrails for AI agents. Detect and protect against sensitive content, PII, and custom patterns. - [Hacker News](/reference/components/hacker-news_v1): Hacker News is a social news website focused on computer science, startups and technology-related topics. - [HeyGen](/reference/components/heygen_v1): HeyGen is an AI Video Generator that lets you create explainer videos, marketing and sales promos, product demos, training and onboarding content. - [HTTP Client](/reference/components/http-client_v1): Makes an HTTP request and returns the response data. - [Hubspot](/reference/components/hubspot_v1): HubSpot is a CRM platform with all the software, integrations, and resources you need to connect marketing, sales, content management, and customer service. - [Hunter](/reference/components/hunter_v1): Hunter is a tool that helps users find and verify professional email addresses, enabling effective outreach and communication. - [Image Helper](/reference/components/image-helper_v1): Helper component which contains various actions for image manipulation. - [In Memory Chat Memory](/reference/components/in-memory-chat-memory_v1): In Memory Chat Memory. - [Components](/reference/components): Blocks for workflow definitions. - [Infobip](/reference/components/infobip_v1): Infobip is a global communications platform that provide cloud-based messaging and omnichannel communication solutions for businesses. - [Insightly](/reference/components/insightly_v1): Insightly is a customer relationship management (CRM) software that helps businesses manage contacts, sales, projects, and tasks in one platform. - [Intercom](/reference/components/intercom_v1): Intercom is the complete AI-first customer service solution, giving exceptional experiences for support teams with AI agent, AI copilot, tickets, ... - [Jailbreak](/reference/components/jailbreak_v1): LLM-based detection of jailbreak / prompt-injection attempts. - [JDBC Chat Memory](/reference/components/jdbc-chat-memory_v1): JDBC Chat Memory stores conversation history in a relational database. - [Jenkins](/reference/components/jenkins_v1): Jenkins is leading open source automation server, Jenkins provides hundreds of plugins to support building, deploying and automating any project. - [Jira](/reference/components/jira_v1): Jira is a proprietary issue tracking product developed by Atlassian that allows bug tracking and agile project management. - [JotForm](/reference/components/jotform_v1): JotForm is an online form builder that enables users to create customized forms for various purposes without needing coding skills. - [JSON File](/reference/components/json-file_v1): Reads and writes data from a JSON file. - [JSON Helper](/reference/components/json-helper_v1): JSON helper component provides actions for parsing and stringifying JSON. - [JWT Helper](/reference/components/jwt-helper_v1): JWT helper component provides actions for signing and verifying JWT tokens. - [Keap](/reference/components/keap_v1): Keap is a customer comprehensive customer relationship management platform designed to help small businesses streamline sales, marketing, and customer management processes in one integrated system. - [Keywords](/reference/components/keywords_v1): Flags or masks the input if any listed keyword appears in it. - [Klaviyo](/reference/components/klaviyo_v1): Klaviyo is a marketing automation platform primarily used for email and SMS marketing, especially by e-commerce businesses. - [Knowledge Base](/reference/components/knowledgeBase_v1): Search ByteChef's internal knowledge base to retrieve relevant document chunks using semantic similarity search powered by vector embeddings. - [Liferay](/reference/components/liferay_v1): Liferay is an open-source digital experience platform for enterprise content management (ECM) and portal development. - [Linear](/reference/components/linear_v1): Linear is a project management and issue tracking tool designed primarily for software teams. - [LinkedIn](/reference/components/linkedin_v1): LinkedIn is a professional networking platform that enables users to connect with colleagues, discover job opportunities, and share industry-related content. - [LLM PII](/reference/components/llmPii_v1): LLM-assisted detection and masking of PII (names, addresses, emails, etc.). - [Logger](/reference/components/logger_v1): Logs a value to the system log. - [Loops](/reference/components/loops_v1): Loops is an email marketing and transactional email platform built for modern SaaS companies, helping businesses automate onboarding, product updates, and lifecycle messaging with simple workflows, API integrations, and scalable contact management. - [Mailchimp](/reference/components/mailchimp_v1): Mailchimp is a marketing automation and email marketing platform. - [MailerLite](/reference/components/mailerlite_v1): MailerLite is an intuitive email marketing platform that offers automation, landing pages, and subscriber management for businesses and creators. - [Map](/reference/components/map_v1): Produces a new collection of values by mapping each value in list through defined task, in parallel. When execution is finished on all items, the `map` task will return a list of execution results in an order which corresponds to the order of the source list. - [MariaDB Vector Store](/reference/components/mariaDbVectorStore_v1): MariaDB Vector Store uses MariaDB 11.7+ native vector storage and similarity search capabilities to store and query document embeddings. - [Math Helper](/reference/components/math-helper_v1): Helper component to perform mathematical operations. - [Mattermost](/reference/components/mattermost_v1): Mattermost is an open-source, self-hosted messaging platform designed for secure team collaboration and communication. - [Mautic](/reference/components/mautic_v1): Simplifying campaign design and optimization with a user-friendly click-and-drag interface allowing you to build complex campaigns. - [MCP Client](/reference/components/mcp-client_v1): Connects to external MCP servers to discover and call their tools. - [Merge Helper](/reference/components/mergeHelper_v1): Combine multiple inputs into one output. - [Microsoft Dynamics CRM](/reference/components/microsoft-dynamics-crm_v1): Microsoft Dynamics CRM is a customer relationship management software that helps businesses manage customer interactions, sales, marketing, and customer service processes efficiently. - [Microsoft Excel](/reference/components/microsoft-excel_v1): Microsoft Excel is a spreadsheet program used for organizing, analyzing, and visualizing data in tabular form. - [Microsoft Application Setup](/reference/components/microsoft-graph-application-setup_v1): Steps for setting up Microsoft Graph API for every Microsoft component. - [Microsoft OneDrive](/reference/components/microsoft-one-drive_v1): Microsoft OneDrive is a cloud storage service provided by Microsoft for storing, accessing, and sharing files online. - [Microsoft Outlook 365](/reference/components/microsoft-outlook-365_v1): Microsoft Outlook 365 is a comprehensive email and productivity platform that integrates email, calendar, contacts, and tasks to streamline communication and organization. - [Microsoft SharePoint](/reference/components/microsoft-share-point_v1): Microsoft SharePoint is a web-based collaborative platform that integrates with Microsoft Office, providing document management, intranet, and content management features for organizations. - [Microsoft Teams](/reference/components/microsoft-teams_v1): Microsoft Teams is a collaboration platform that combines workplace chat, video meetings, file storage, and application integration. - [Microsoft To Do](/reference/components/microsoft-to-do_v1): Microsoft To Do is a cloud-based task management application that helps users organize, prioritize, and track tasks across devices with features like lists, reminders, and collaboration. - [Milvus](/reference/components/milvus_v1): Milvus is an open-source vector database that has garnered significant attention in the fields of data science and machine learning. - [MistralAI](/reference/components/mistral_v1): Open, efficient, helpful and trustworthy AI models through ground-breaking innovations. - [Mixpanel](/reference/components/mixpanel_v1): Mixpanel is a product analytics tool that helps you track user interactions and behaviors in your app or website to make data-driven decisions. - [Modular RAG](/reference/components/modular-rag_v1): A modular RAG (Retrieval-Augmented Generation) component that provides a flexible and customizable approach to building RAG systems. It allows you to combine different retrieval, augmentation, and generation strategies into a cohesive pipeline for enhanced AI-driven information processing and response generation. - [monday.com](/reference/components/monday_v1): Monday.com is a work operating system that powers teams to run projects and workflows with confidence. - [MongoDB Chat Memory](/reference/components/mongo-db-chat-memory_v1): MongoDB Chat Memory stores conversation history in MongoDB for flexible, document-based persistent storage. - [MongoDB Atlas Vector Search](/reference/components/mongodbAtlas_v1): MongoDB Atlas Vector Search combines document storage with vector similarity search, enabling storage and retrieval of high-dimensional embeddings for AI and machine learning applications. - [MongoDB](/reference/components/mongodb_v1): MongoDB is a source-available, cross-platform, document-oriented database. Query, insert, update and delete documents in your collections. - [Myob](/reference/components/myob_v1): MYOB is an accounting software that helps businesses manage their finances, invoicing, and payroll. - [MySQL](/reference/components/mysql_v1): Query, insert and update data from MySQL. - [Nano GPT](/reference/components/nano-gpt_v1): The NanoGPT API allows you to generate text, images and video using any AI model available. - [NASA](/reference/components/nasa_v1): NASA is a United States government agency that provides public APIs offering access to space-related data, including astronomy images, Mars rover photos, and other scientific information for developers and applications. - [Neo4j Chat Memory](/reference/components/neo4j-chat-memory_v1): Neo4j Chat Memory stores conversation history in Neo4j graph database for persistent storage with graph-based relationships. - [Neo4j](/reference/components/neo4j_v1): Neo4j is an open-source NoSQL graph database. It is a fully transactional database (ACID) that stores data structured as graphs consisting of nodes, connected by relationships. - [Nifty](/reference/components/nifty_v1): Nifty Project Management is a software tool that streamlines team collaboration and project tracking with features like task management, timelines, and communication tools to enhance productivity. - [NocoDB](/reference/components/nocodb_v1): NocoDB is an open-source platform that transforms databases into smart spreadsheets, enabling users to manage and collaborate on data with a no-code interface. - [Notion](/reference/components/notion_v1): Notion is an all-in-one workspace for notes, tasks, wikis, and databases. - [NSFW](/reference/components/nsfw_v1): LLM-based detection of NSFW content. - [Nutshell](/reference/components/nutshell_v1): Nutshell CRM is a user-friendly customer relationship management software designed to help small businesses manage sales, track leads, and streamline communication. - [NVIDIA LLM](/reference/components/nvidia_v1): Generative AI and digitalization are reshaping the $3 trillion automotive industry, from design and engineering to manufacturing, autonomous driving, and customer experience. NVIDIA is at the epicenter of this industrial transformation. - [Object Helper](/reference/components/object-helper_v1): Object Helper allows you to do various operations on objects. - [ODS File](/reference/components/ods-file_v1): Reads and writes data from a ODS file. - [Ollama](/reference/components/ollama_v1): Get up and running with large language models. - [One Simple API](/reference/components/one-simple-api_v1): A toolbox with all the things you need to get your project to success: Image resize and CDN, PDF and Screenshots generation, Currency Exchange and Discounts, Email Validation, QR codes, and much more! - [OpenAI](/reference/components/open-ai_v1): OpenAI is a research organization that aims to develop and direct artificial intelligence (AI) in ways that benefit humanity as a whole. - [Open Router](/reference/components/open-router_v1): OpenRouter provides a unified API that gives you access to hundreds of AI models through a single endpoint, while automatically handling fallbacks and selecting the most cost-effective options. - [Oracle Vector Store](/reference/components/oracle_v1): Oracle Vector Store uses Oracle Database 23ai's native vector storage and similarity search capabilities to store and query document embeddings. - [PagerDuty](/reference/components/pagerduty_v1): With PagerDuty, you can get real-time alerts, manage on-call schedules, and automate parts of your incident response process. - [PDF Helper](/reference/components/pdf-helper_v1): null - [Perplexity](/reference/components/perplexity_v1): Perplexity AI provides a unique AI service that integrates its language models with real-time search capabilities. - [Petstore](/reference/components/petstore_v1): This is a sample Pet Store Server based on the OpenAPI 3.0 specification. - [PGVector](/reference/components/pgVector_v1): PGVector is an open-source PostgreSQL extension for vector similarity search. - [PII](/reference/components/pii_v1): Detects — and optionally masks — personally identifiable information. - [Pinecone](/reference/components/pinecone_v1): Pinecone is a vector database designed for efficient similarity search and storage of high-dimensional data, commonly used in machine learning and AI applications. - [Pipedrive](/reference/components/pipedrive_v1): The first CRM designed by salespeople, for salespeople. Do more to grow your business. - [Pipeliner](/reference/components/pipeliner_v1): Pipeliner CRM is a comprehensive sales management tool that helps streamline sales processes through visual pipline management, contact organization, sales forecasting, and reporting. - [PostgreSQL](/reference/components/postgresql_v1): Query, insert and update data from PostgreSQL. - [PostHog](/reference/components/posthog_v1): PostHog is the only all-in-one platform for product analytics, feature flags, session replays, experiments, and surveys that's built for developers. - [Productboard](/reference/components/productboard_v1): Productboard is a product management platform that helps teams prioritize features, gather customer feedback, and align their product strategy to deliver better products. - [Property Testing](/reference/components/property-testing_v1): Component fo testing. - [Pushover](/reference/components/pushover_v1): Pushover is a notification service that sends real-time alerts to mobile and desktop devices, integrating with apps, scripts, and services. - [Qdrant](/reference/components/qdrant_v1): Qdrant is an open-source vector similarity search engine designed to handle high-dimensional data, enabling efficient and scalable nearest neighbor search for applications like recommendation systems and machine learning. - [Query Augmenter](/reference/components/query-augmenter_v1): Query Augmenter. - [Query Expander](/reference/components/query-expander_v1): Query Expander. - [Query Transformer](/reference/components/query-transformer_v1): Query Transformer. - [Question Answer RAG](/reference/components/questionanswer-rag_v1): A component that enables Question-Answer Retrieval Augmented Generation (RAG) capabilities. It combines natural language processing with document retrieval to provide accurate answers based on the given context. - [QuickBooks](/reference/components/quickbooks_v1): QuickBooks is an accounting software package developed and marketed by Intuit. It is geared mainly toward small and medium-sized businesses and offers on-premises accounting applications as well as cloud-based versions that accept business payments, manage and pay bills, and payroll functions. - [RabbitMQ](/reference/components/rabbitmq_v1): RabbitMQ is an open-source message broker software that enables efficient communication between different systems, applications, and services. It supports multiple messaging protocols and facilitates a reliable and flexible messaging system. - [Random Helper](/reference/components/random-helper_v1): The Random Helper allows you to generate random values. - [Reckon](/reference/components/reckon_v1): Reckon is an accounting software used for financial management and bookkeeping tasks. - [Reddit](/reference/components/reddit_v1): Reddit is a social news aggregation, discussion, and content-sharing platform where users post and vote on content organized into communities called subreddits. - [Redis Chat Memory](/reference/components/redis-chat-memory_v1): Redis Chat Memory stores conversation history in Redis for fast, persistent storage. - [Redis](/reference/components/redis_v1): Redis is an open-source, in-memory data structure store used as a database, cache, and message broker, known for its high performance and support for various data structures like strings, hashes, lists, sets, and more. - [Request](/reference/components/request_v1): Send an HTTP request from your application to a designated integration and workflow, with the option to receive a synchronous response. - [Resend](/reference/components/resend_v1): Resend is the email API for developers. - [Retable](/reference/components/retable_v1): Retable is a online database and spreadsheet platform designed for teams and individuals who want to organize, manage, and collaborate on structured data. - [Rocket.Chat](/reference/components/rocketchat_v1): Rocket.Chat is a communication platform that enables team collaboration through messaging, audio/video calls, and integrations, all customizable and self-hostable. - [RSS](/reference/components/rss_v1): RSS.app is a web-based tool that helps you create, customize, and manage RSS feeds—even from websites that don’t provide them natively. - [S3 Vector Store](/reference/components/s3_v1): Amazon S3 Vector Store uses AWS S3 as a persistent storage backend for vector embeddings, enabling scalable and durable similarity search. - [Salesflare](/reference/components/salesflare_v1): Salesflare is a CRM software designed to help small businesses and startups manage their customer relationships efficiently. - [Salesforce](/reference/components/salesforce_v1): Salesforce is a cloud-based customer relationship management (CRM) platform that provides tools for sales, service, marketing, and analytics to help businesses manage customer interactions and data. - [Sanitize Text](/reference/components/sanitizeText_v1): Runs configured sanitizers on the model response. - [Schedule](/reference/components/schedule_v1): With the Scheduled trigger, you can initiate customized workflows at specific time intervals. - [ScrapeGraphAI](/reference/components/scrape-graph-ai_v1): ScrapeGraphAI is a web scraping python library that uses LLM and direct graph logic to create scraping pipelines for websites and local documents. - [Script](/reference/components/script_v1): Executes user-defined code. User can write custom workflow logic in Java, JavaScript, Python, R or Ruby programming languages. - [Secret Keys](/reference/components/secretKeys_v1): Detects — and optionally masks — API keys and credential-shaped secrets. - [SendFox](/reference/components/sendfox_v1): SendFox lets you automate email campaigns, complete with custom opt-in forms and landing pages, so you're not tanking your budget to get new subscribers. - [Sendgrid](/reference/components/sendgrid_v1): Trusted for reliable email delivery at scale. - [Shopify](/reference/components/shopify_v1): Shopify is an e-commerce platform that allows businesses to create online stores and sell products. - [Slack](/reference/components/slack_v1): Slack is a messaging platform for teams to communicate and collaborate. - [Snowflake](/reference/components/snowflake_v1): Snowflake enables organizations to collaborate, build AI-powered data apps, and unlock data insights-all within a secure and scalable AI Data Cloud. - [Spotify](/reference/components/spotify_v1): Spotify is a popular music streaming service that offers a vast library of songs, podcasts, and playlists for users to enjoy. - [Stability AI](/reference/components/stability_v1): Activating humanity's potential through generative AI. Open models in every modality, for everyone, everywhere. - [Stripe](/reference/components/stripe_v1): Stripe is a payment processing platform that allows businesses to accept online payments and manage transactions securely. - [Supabase](/reference/components/supabase_v1): Supabase is an open source Firebase alternative. Start your project with a Postgres database, Authentication, instant APIs, Edge Functions, Realtime subscriptions, Storage, and Vector embeddings. - [Tavily](/reference/components/tavily_v1): Tavily is an AI-powered search tool designed to help users quickly find accurate, relevant and up-to-date information from the web. - [Teamwork](/reference/components/teamwork_v1): Teamwork is a project management software that helps teams collaborate, organize tasks, and track progress efficiently. - [Telegram](/reference/components/telegram_v1): Telegram is a cloud-based messaging platform that enables users to send messages, media, and files, and supports automation and integrations through its API. - [Text Helper](/reference/components/text-helper_v1): Helper component which contains operations to help you work with text. - [Todoist](/reference/components/todoist_v1): Todoist is a task management application that helps users organize and prioritize their to-do lists. - [Topical Alignment](/reference/components/topicalAlignment_v1): LLM-based check that input stays within an allowed topic. - [Trello](/reference/components/trello_v1): Trello is a project management tool that uses boards, lists and cards to help users organize tasks and collaborate with teams. - [Twilio](/reference/components/twilio_v1): Twilio is a cloud communications platform that enables developers to integrate messaging, voice, and video capabilities into their applications. - [Typeform](/reference/components/typeform_v1): Typeform is an online survey and form-building tool that enables users to create interactive and engaging forms for collecting data and feedback. - [Typesense](/reference/components/typesense_v1): Typesense is an open-source, in-memory search engine designed for fast, typo-tolerant, and relevance-focused full-text search across large datasets. - [URLs](/reference/components/urls_v1): Detects — and optionally masks — URLs outside a configured allowlist. - [Urlscan.io](/reference/components/urlscan_v1): Urlscan.io is an online service that allows you to safely analyze websites and URLs to determine potential security threats and risks. - [Var](/reference/components/var_v1): Sets a value which can then be referenced in other tasks. - [Vbout](/reference/components/vbout_v1): VBOUT is an AI-enabled marketing platform that helps businesses manage and streamline their digital marketing efforts. - [Vector Store Chat Memory](/reference/components/vector-store-chat-memory_v1): Vector Store Chat Memory. - [Vector Store Document Retriever](/reference/components/vector-store-document-retriever_v1): Vector Store Document Retriever. - [VTiger](/reference/components/vtiger_v1): VTiger is a comprehensive customer relationship management (CRM) platform that offers sales, marketing, and support solutions to streamline business. - [Wait](/reference/components/wait_v1): Pauses the workflow execution for a specified amount of time or until a webhook call is received. - [Weaviate](/reference/components/weaviate_v1): Weaviate is an open-source vector search engine and database that enables efficient storage, retrieval, and management of high-dimensional data, often used in machine learning and AI applications. - [Webflow](/reference/components/webflow_v1): Webflow is a web design and development platform that allows users to build responsive websites visually without writing code. - [Webhook](/reference/components/webhook_v1): Webhook is a method utilized by applications to supply real-time information to other apps. Such a process usually delivers data immediately as and when it occurs. Webhook Trigger enables users to receive callouts whenever a service provides the option of distributing signals to a user-defined URL. - [WhatsApp](/reference/components/whatsapp_v1): WhatsApp is a free-to-use messaging app offering end-to-end encrypted chat, voice, and video communication, along with document and media sharing, available on multiple platforms. - [Wolfram Alpha Full Results](/reference/components/wolfram-alpha-full-results_v1): Wolfram Alpha Full Results returns the computed results of your query in a variety of formats. - [Wolfram Alpha Short Answers](/reference/components/wolfram-alpha-shortanswers_v1): Wolfram Alpha Short Answers returns a single plain text result as an answer to your query. - [WooCommerce](/reference/components/woocommerce_v1): WooCommerce is a e-commerce plugin for WordPress that allows you to turn a standard WordPress website into a fully functional online store. - [Wordpress](/reference/components/wordpress_v1): WordPress is a web content management system. - [Workflow](/reference/components/workflow_v1): Triggers and actions for workflow-to-workflow communication. - [Wrike](/reference/components/wrike_v1): Wrike's Powerful Project Management Software Provides Users with Enterprise-Level Security. - [X](/reference/components/x_v1): X (formerly known as Twitter) is a social media platform that enables users to share short messages, known as posts or tweets, and interact with others in real time. - [Xero](/reference/components/xero_v1): Xero is an online accounting software platform designed for small businesses and accountants to manage finances efficiently. - [XLSX File](/reference/components/xlsx-file_v1): Reads and writes data from a XLS/XLSX file. - [XML File](/reference/components/xml-file_v1): Reads and writes data from a XML file. - [XML Helper](/reference/components/xml-helper_v1): Converts between XML string and object/array. - [YouTube](/reference/components/youtube_v1): Enjoy the videos and music you love, upload original content, and share it all with friends, family, and the world on YouTube. - [Zendesk](/reference/components/zendesk_v1): Zendesk is a customer service and sales platform that helps businesses manage customer interactions across various channels. - [ZenRows](/reference/components/zenrows_v1): ZenRows is a web scraping service with an advanced toolkit and APIs that simplify data extraction from bot-protected websites. - [Zeplin](/reference/components/zeplin_v1): Zeplin is a collaboration tool that bridges the gap between designers and developers by providing a platform to share, organize, and translate design files into development. - [Zoho Application Setup](/reference/components/zoho-application-setup_v1): Steps for setting up Zoho API console for every Zoho component. - [Zoho Books](/reference/components/zoho-books_v1): Zoho Books is cloud-based accounting software for managing your accounting tasks and organizing your transactions. - [Zoho CRM](/reference/components/zoho-crm_v1): Zoho CRM is a cloud-based customer relationship management platform that integrates sales, marketing, and customer support activities to streamline business processes and enhance team. - [Zoho Invoice](/reference/components/zoho-invoice_v1): Zoho Invoice is an online invoicing software used to create, send, and manage professional invoices, along with tracking payments and automating billing workflows. - [Zoom](/reference/components/zoom_v1): Zoom is a cloud-based video conferencing platform that enables virtual meetings, webinars, and collaboration through video, audio, and chat. - [ZoomInfo](/reference/components/zoominfo_v1): ZoomInfo is a platform that provides companies with accurate contact data and sales insights to help them find and engage potential customers. ## self-hosting - [Configure Instance](/self-hosting/configuration/configure-instance): Learn how to configure your ByteChef instance - [Environment Variables](/self-hosting/configuration/environment-variables): Configuration options for ByteChef through environment variables - [Manage Instance](/self-hosting/configuration/manage-instance): Learn how to manage your ByteChef instance - [AWS EC2](/self-hosting/deployment/aws-ec2): Learn how to deploy ByteChef on AWS EC2 - [AWS EC3](/self-hosting/deployment/aws-ec3): Learn how to deploy ByteChef on AWS EC3 - [Azure](/self-hosting/deployment/azure): Learn how to deploy ByteChef on Microsoft Azure - [DigitalOcean](/self-hosting/deployment/digitalocean): Learn how to deploy ByteChef on DigitalOcean's cloud platform - [Google Cloud](/self-hosting/deployment/google-cloud): Learn how to deploy ByteChef on Google Cloud Platform - [Kubernetes](/self-hosting/deployment/kubernetes): Deploy ByteChef on Kubernetes - [Local Docker](/self-hosting/deployment/local-docker): Run ByteChef locally with Docker for development