Skip to main content
By the end of this guide, you’ll have a workflow running in the dashboard and a public cURL snippet you can use to invoke it from your app.

​
Prerequisites

  • A Fetch Hive workspace
  • A workspace API key if you want to run the public cURL example - see API Keys

​
Step 1: Create a workflow

Open Workflows in the sidebar, then click Add Workflow. Enter a Name. If your workspace uses categories, you can also choose a Category. Click Save to open the workflow editor. The first time you open the workflow editor, a short walkthrough highlights the canvas, copilot, and toolbar.

​
Step 2: Add your first step

In the editor, click Add Step in the bottom control bar to append a step before End, or click the + connector between Start and End to insert a step between two nodes. This opens Search steps…. Choose AI Prompt for the quickest possible first workflow. When the new step appears on the canvas, click it to open Step settings.

​
Step 3: Configure the step

Add a short instruction in Step settings so the workflow has something useful to do. If your workflow needs input from the caller, define that input on the Start step first, then reference it inside your AI Prompt step. Keep the first version simple. You do not need Copilot, advanced step types, or multiple branches for this quick start.

​
Step 4: Run the workflow in the editor

Click Run Workflow in the bottom control bar. This opens Run History. Click Start to open Start a new Workflow Run, then click Start Workflow Run. This is a two-step flow in the UI. Run Workflow does not start the workflow immediately by itself.

​
Step 5: Save a named version

Click Save Version in the bottom control bar. Enter a description of what changed, then save the version. This gives you a named version you can refer back to later.

​
Step 6: Create a deployment

Click Deploy in the bottom control bar, then choose Create a Deployment. Enter a Deployment key and save it. This creates the live workflow deployment you can invoke through the public API.

​
Step 7: Copy the public invoke snippet

Open More in the sidebar and click Get Code, or open Code Snippet from the deployment page. Select your Deployment and Variant. The dialog shows a public invoke snippet for POST /v1/workflow/invoke. Use the Agent Prompt tab to copy a ready-to-paste instruction block for a coding agent such as Cursor or Claude Code. It tells the agent to add a call to this workflow deployment using the official Fetch Hive SDK for your project’s language. The public payload now uses deployment and variant, matching the language shown in the UI.
If you want Fetch Hive to return immediately and send the final result later, the UI supports a Callback delivery toggle in the code snippet dialog. That adds an async block with enabled and callback_url.

​
Next steps