Build AI + human workflow products on top of Orchflow.

If you are evaluating Orchflow for the first time, use the hosted flow first. That lets you see task planning, human checkpoints, and run completion before you spend time on provider setup.

curl -X POST https://api.orchflow.cloud/api/v1/runs \
  -H "X-API-Key: orch_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "task": "Plan and launch a faceless YouTube channel about AI tools for freelancers.",
    "agents": [
      { "name": "research" },
      { "name": "analyst" },
      { "name": "writer" }
    ],
    "ask_me_about": ["brand voice", "target audience"],
    "require_approval": false
  }'

Registration is intentionally lightweight. Orchflow returns the raw API key once, and every protected route after that expects it in the request header.

{
  "name": "Tarun",
  "email": "tarun@example.com"
}

Think of a run as the top-level workflow container. You send one goal, Orchflow creates the task graph, executes what it can, and keeps the full run state available while work is in progress.

{
  "task": "Research 5 competitors, extract pricing, compare positioning, then propose our launch strategy.",
  "human_gates": ["pricing", "launch strategy"],
  "require_approval": false
}

Human tasks are what make Orchflow useful for real products. When the workflow needs brand context, approval, or judgment, it pauses instead of hallucinating past the missing information.

{
  "output": "Brand voice should be practical and founder-friendly. Target audience is solo freelancers and small agencies."
}

• Use `ask_me_about` when you want Orchflow to explicitly ask for missing context.
• Use `human_gates` when you want to route matching tasks to humans.
• Use `require_approval=true` when every task must wait for human approval.

Providers are optional for the first managed trial runs in hosted mode. After that, use `provider_id` in `POST /runs` so Orchflow knows which model account to execute against.

{
  "provider": "gemini",
  "api_key": "your_provider_key",
  "label": "My Gemini key",
  "model": "gemini-3.1-flash-lite-preview"
}

Built-in templates are the fastest path for first runs. You can pass only the agent names and let Orchflow fill the system prompts automatically.

{
  "agents": [
    { "name": "research" },
    { "name": "analyst" },
    { "name": "writer" }
  ]
}

The usual pattern is simple: your app starts a run, stores the returned `run_id`, polls or listens for status changes, and submits human responses when Orchflow pauses.

import requests

api_key = "orch_your_key"

run = requests.post(
    "https://api.orchflow.cloud/api/v1/runs",
    headers={"X-API-Key": api_key},
    json={
        "task": "Research competitors, compare pricing, then draft our launch strategy.",
        "agents": [
            {"name": "research"},
            {"name": "analyst"},
            {"name": "writer"}
        ],
        "ask_me_about": ["company details", "brand voice"],
        "require_approval": False
    }
).json()

run_id = run["run_id"]

import requests

requests.post(
    f"https://api.orchflow.cloud/api/v1/runs/{run_id}/tasks/T1/complete",
    headers={"X-API-Key": api_key},
    json={
        "output": "Target audience is solo freelancers. Brand voice should be practical and founder-friendly."
    }
)

const res = await fetch(`https://api.orchflow.cloud/api/v1/runs/${runId}`, {
  headers: { "X-API-Key": apiKey }
});

const run = await res.json();

if (run.status === "waiting_human") {
  // Show approval form or collect missing context in your UI
}

Most development issues come from missing API keys, consumed trial runs, invalid payloads, or polling too aggressively. The table below covers the usual fixes.

The best demos are tasks with clear planning value: some parallel work, one or two human checkpoints, and a final output that is obviously stronger than a one-shot model response.

{
  "task": "Plan and launch a faceless YouTube channel about AI tools for freelancers. Research 5 competing channels, extract their content patterns, define our positioning, decide the branding direction, design a 30-day content plan, and produce a launch checklist.",
  "agents": [
    { "name": "research" },
    { "name": "analyst" },
    { "name": "writer" }
  ],
  "ask_me_about": ["brand voice", "target audience", "content constraints"],
  "require_approval": false
}