DeerFlow API Client
Sends messages and files to the DeerFlow agent platform and manages its threads.
Install
npx skills add bytedance/deer-flow --skill claude-to-deerflow -g -a claude-code -y- Repository
- bytedance/deer-flow84.8k
- Category
- AI and agents
- Updated
- 3d ago
- License
- MIT
- Context cost
- Mediumabout 1,576 tokens
- Runs scripts
- Yes, review before use
What it does
Interact with DeerFlow AI agent platform via its HTTP API. Use this skill when the user wants to send messages or questions to DeerFlow for research/analysis, start a DeerFlow conversation thread, check DeerFlow status or health, list available models/skills/agents in DeerFlow, manage DeerFlow memory, upload files to DeerFlow threads, or delegate complex research tasks to DeerFlow. Also use when the user mentions deerflow, deer flow, or wants to run a deep research task that DeerFlow can handle.
DeerFlow Skill
Communicate with a running DeerFlow instance via its HTTP API. DeerFlow is an AI agent platform built on LangGraph that orchestrates sub-agents for research, code execution, web browsing, and more.
Architecture
DeerFlow exposes two API surfaces behind an Nginx reverse proxy:
| Service | Direct Port | Via Proxy | Purpose |
|---|---|---|---|
| Gateway API | 8001 | $DEERFLOW_GATEWAY_URL | REST endpoints and embedded agent runtime |
| LangGraph-compatible API | 8001 | $DEERFLOW_LANGGRAPH_URL | Agent threads, runs, streaming |
Environment Variables
All URLs are configurable via environment variables. Read these env vars before making any request.
| Variable | Default | Description |
|---|---|---|
DEERFLOW_URL | http://localhost:2026 | Unified proxy base URL |
DEERFLOW_GATEWAY_URL | ${DEERFLOW_URL} | Gateway API base (models, skills, memory, uploads) |
DEERFLOW_LANGGRAPH_URL | ${DEERFLOW_URL}/api/langgraph | LangGraph API base (threads, runs) |
When making curl calls, always resolve the URL like this:
# Resolve base URLs from env (do this FIRST before any API call)
DEERFLOW_URL="${DEERFLOW_URL:-http://localhost:2026}"
DEERFLOW_GATEWAY_URL="${DEERFLOW_GATEWAY_URL:-$DEERFLOW_URL}"
DEERFLOW_LANGGRAPH_URL="${DEERFLOW_LANGGRAPH_URL:-$DEERFLOW_URL/api/langgraph}"
Available Operations
1. Health Check
Verify DeerFlow is running:
curl -s "$DEERFLOW_GATEWAY_URL/health"
2. Send a Message (Streaming)
This is the primary operation. It creates a thread and streams the agent's response.
