Skip to main content

​
Workflows API

The Workflows API enables creation and execution of AI-powered automation workflows with triggers, steps, and community sharing.

​
Workflow Object

​
id
string
Unique workflow identifier
​
title
string
Workflow title
​
description
string
Workflow description
​
trigger_config
object
Trigger configuration
  • type: Trigger type (manual, scheduled, event)
  • enabled: Whether trigger is active
  • schedule: Cron expression (for scheduled triggers)
​
steps
array
Array of workflow steps with tool configurations
​
status
string
Workflow status: active, inactive, generating, failed
​
is_public
boolean
Whether workflow is published to community marketplace

​
Endpoints

​
Create Workflow

Create a new workflow. 
POST /api/v1/workflows
Request
{
  "title": "Daily Email Summary",
  "description": "Summarize important emails every morning",
  "trigger_config": {
    "type": "scheduled",
    "enabled": true,
    "schedule": "0 9 * * *",
    "timezone": "America/New_York"
  },
  "generate_immediately": true
}

​
List Workflows

Get all workflows for the current user. 
GET /api/v1/workflows

​
Get Workflow

Get a specific workflow. 
GET /api/v1/workflows/{workflow_id}

​
Update Workflow

Update workflow details. 
PUT /api/v1/workflows/{workflow_id}

​
Delete Workflow

Delete a workflow. 
DELETE /api/v1/workflows/{workflow_id}

​
Workflow Execution

​
Execute Workflow

Run a workflow immediately. 
POST /api/v1/workflows/{workflow_id}/execute
Request
{
  "context": {
    "user_input": "Generate report for Q1 2026"
  }
}

​
Get Workflow Status

Get current execution status. 
GET /api/v1/workflows/{workflow_id}/status
Response
{
  "workflow_id": "wf_123",
  "status": "running",
  "current_step": 2,
  "total_steps": 5,
  "progress": 0.4
}

​
Get Execution History

Get past workflow executions. 
GET /api/v1/workflows/{workflow_id}/executions
​
limit
integer
default:"10"
Maximum executions to return
​
offset
integer
default:"0"
Offset for pagination

​
Workflow Management

​
Activate Workflow

Enable workflow trigger. 
POST /api/v1/workflows/{workflow_id}/activate

​
Deactivate Workflow

Disable workflow trigger. 
POST /api/v1/workflows/{workflow_id}/deactivate

​
Regenerate Steps

Regenerate workflow steps with AI. 
POST /api/v1/workflows/{workflow_id}/regenerate-steps
Request
{
  "reason": "Need different approach",
  "force_different_tools": true
}

​
Community Workflows

​
Explore Workflows

Get featured/explore workflows. 
GET /api/v1/workflows/explore
​
limit
integer
default:"25"
Number of workflows to return
​
offset
integer
default:"0"
Offset for pagination

​
Community Workflows

Get public community workflows. 
GET /api/v1/workflows/community

​
Get Public Workflow

Get a public workflow by ID (no auth required). 
GET /api/v1/workflows/public/{workflow_id}

​
Publish Workflow

Publish workflow to community marketplace. 
POST /api/v1/workflows/{workflow_id}/publish

​
Unpublish Workflow

Remove workflow from marketplace. 
POST /api/v1/workflows/{workflow_id}/unpublish

​
Todo Workflows

​
Create from Todo

Generate workflow from a todo item. 
POST /api/v1/workflows/from-todo
Request
{
  "todo_id": "todo_123",
  "todo_title": "Plan team offsite",
  "todo_description": "Organize company retreat for 50 people"
}

​
Trigger Types

​
Manual Trigger

Manually executed workflows. 
{
  "type": "manual",
  "enabled": true
}

​
Scheduled Trigger

Cron-based scheduled workflows. 
{
  "type": "scheduled",
  "enabled": true,
  "schedule": "0 9 * * 1-5",
  "timezone": "America/New_York"
}

​
Event Trigger

Event-based workflows (integration events). 
{
  "type": "event",
  "enabled": true,
  "event_type": "gmail.new_email",
  "filters": {
    "from": "[email protected]"
  }
}

​
Next Steps

Goals API

Track goals with AI roadmaps

Memory API

Store contextual memories

Build docs developers (and LLMs) love

Get started for freeTalk to us