Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clickflow.com/llms.txt

Use this file to discover all available pages before exploring further.

Workflows are long-running AI pipelines (3-20 minutes) that research, write, and optimize content. They run asynchronously — you start one, then poll for completion.

​
Lifecycle

Start workflow → Poll status → Retrieve output
                    ↓
              (may pause for human review)
                    ↓
              Resume with decision → Poll again → Output

​
Starting a workflow

Workflows are started via platform.create_roadmap_item with start_drafting: true. This creates a roadmap item and immediately kicks off the drafting workflow. 
{
  "keyword": "best project management tools",
  "prompt": "Compare top 5 tools for small teams",
  "strategy": "Comparison",
  "start_drafting": true
}
Response: 
{
  "roadmap_item_id": "ri_abc123",
  "workflow_id": "wf_xyz789",
  "status": "In Progress",
  "message": "Roadmap item created and drafting started. Poll workflows.get_status for progress."
}

​
Polling for status

Call workflows.get_status with workflow_id.

​
In Progress

{
  "status": "In Progress",
  "progress": 45,
  "currentAction": "Analyzing competition for target keyword"
}

​
Completed

{
  "status": "Completed",
  "progress": 100,
  "output": {
    "html": "<h1>Best Project Management Tools</h1>...",
    "title": "Best Project Management Tools for Small Teams (2026)",
    "meta_description": "Compare the top 5 project management tools...",
    "thumbnail_url": "https://storage.googleapis.com/..."
  }
}

​
Failed

{
  "status": "Failed",
  "error": "Description of what went wrong"
}

​
Human review

Some workflows pause to let a human review intermediate results before continuing.

​
Detecting a paused workflow

When status is "Human Review", the response includes a review object: 
{
  "status": "Human Review",
  "progress": 85,
  "currentAction": "Waiting for review",
  "review": {
    "type": "implementation_spec_review",
    "task_id": "task_abc",
    "data": {
      "proposed_changes": [...]
    }
  }
}

​
Review types

TypeWorkflowWhat you’re reviewing
implementation_spec_reviewContent optimizationProposed changes to the page
answer_reviewFAQ generationGenerated FAQ question-answer pairs
keywords_reviewInternal linkingSuggested keywords to link
internal_link_reviewInternal linkingPages and anchor text for links

​
Resuming a workflow

Call workflows.resume with the workflow_id and a decision object matching the review type:
{
  "workflow_id": "wf_xyz789",
  "decision": {
    "approved": true,
    "selected_change_ids": [1, 3, 5]
  }
}

​
Decision payloads by review type

implementation_spec_review: 
{"approved": true, "selected_change_ids": [1, 3, 5]}
answer_review: 
{"approved_faqs": [{"question": "What is SEO?", "answer": "SEO stands for..."}]}
keywords_review: 
{"keywords": ["project management", "task tracking", "team collaboration"]}
internal_link_review: 
{
  "selected_pages": [
    {
      "url": "https://example.com/blog/task-management",
      "anchor_text": "task management tools",
      "context": "paragraph about productivity",
      "implementation_method": "auto"
    }
  ]
}

​
Workflow types

WorkflowHow to startDurationOutput
Create Post Draftcreate_roadmap_item with start_drafting: true5-15 minhtml, title, meta_description, thumbnail_url
Optimize ContentDashboard only (content decay suggestion)10-20 minhtml, changes_applied, metadata
Generate FAQsDashboard only (FAQ suggestion)3-8 minfaqs, schema_markup (JSON-LD)
Internal LinkingDashboard only (linking suggestion)5-15 minlinks_created, pages_modified
Only Create Post Draft can be started directly via MCP or API. The other 3 workflows are triggered when you approve optimization suggestions in the ClickFlow dashboard. Once running, all workflows can be polled and resumed via MCP/API.

​
Delivery modes

ModeBehavior
draft (default)Output saved to workflow result + roadmap item draft. Retrieve via workflows.get_status or platform.get_roadmap_item.
cmsAutomatically publishes to your connected CMS on completion. Requires cms_connection_id.