Files
dify/api
crazywoola 2d90b4c6c2 fix(workflow-generator): complete file-input schema + scope builder cheatsheet per node
Follow-up of #32130. The "/create" generator produced a start node whose
file variable lacked the required allowed_file_types, so Studio rejected the
draft ("supported file types is required") for prompts like "take a file,
extract its content, summarize".

Root cause: the builder cheatsheet was one static blob that never documented
allowed_file_types/allowed_file_upload_methods, and nothing backfilled them.

- builder_prompts: split the monolithic cheatsheet into a per-node-type map
  assembled dynamically from the planner's chosen node types
  (build_node_config_cheatsheet / get_builder_system_prompt(mode, node_types)),
  so the builder prompt carries each type's FULL schema and drops config for
  unused node types (~45% smaller prompt for small workflows). The start
  snippet now documents the file upload fields.
- runner: pass the plan's node-type set into the builder prompt; add
  _normalize_start_file_variables as a final backstop that fills
  allowed_file_types / upload methods, drops "custom" without extensions, and
  promotes a paragraph var consumed by a document-extractor to a file type.
- runner: fix the variable-reference walker mistaking any 2-element string
  list (allowed_file_upload_methods, a 2-option select) for a [node_id, var]
  selector via _NON_SELECTOR_LIST_KEYS.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-05 17:14:40 +08:00
..
2026-04-16 02:21:04 +00:00
2026-04-16 02:21:04 +00:00
2026-04-16 08:50:02 +00:00
2026-04-16 02:21:04 +00:00

Dify Backend API

Setup and Run

Important

In the v1.3.0 release, poetry has been replaced with uv as the package manager for Dify API backend service.

uv and pnpm are required to run the setup and development commands below.

The scripts resolve paths relative to their location, so you can run them from anywhere.

  1. Run setup (copies env files and installs dependencies).

    ./dev/setup
    
  2. Review api/.env, web/.env.local, and docker/middleware.env values (see the SECRET_KEY note below).

  3. Start middleware (PostgreSQL/Redis/Weaviate).

    ./dev/start-docker-compose
    
  4. Start backend (runs migrations first).

    ./dev/start-api
    
  5. Start Dify web service.

    ./dev/start-web
    

    ./dev/setup and ./dev/start-web install JavaScript dependencies through the repository root workspace, so you do not need a separate cd web && pnpm install step.

  6. Set up your application by visiting http://localhost:3000.

  7. Start the worker service (async and scheduler tasks, runs from api).

    ./dev/start-worker
    
  8. Optional: start Celery Beat (scheduled tasks).

    ./dev/start-beat
    

Environment notes

Important

When the frontend and backend run on different subdomains, set COOKIE_DOMAIN to the sites top-level domain (e.g., example.com). The frontend and backend must be under the same top-level domain in order to share authentication cookies.

  • Generate a SECRET_KEY in the .env file.

    bash for Linux

    sed -i "/^SECRET_KEY=/c\\SECRET_KEY=$(openssl rand -base64 42)" .env
    

    bash for Mac

    secret_key=$(openssl rand -base64 42)
    sed -i '' "/^SECRET_KEY=/c\\
    SECRET_KEY=${secret_key}" .env
    

Testing

  1. Install dependencies for both the backend and the test environment

    cd api
    uv sync --group dev
    
  2. Run the tests locally with mocked system environment variables in tool.pytest_env section in pyproject.toml, more can check Claude.md

    cd api
    uv run pytest                           # Run all tests
    uv run pytest tests/unit_tests/         # Unit tests only
    uv run pytest tests/integration_tests/  # Integration tests
    
    # Code quality
    ./dev/reformat               # Run all formatters and linters
    uv run ruff check --fix ./   # Fix linting issues
    uv run ruff format ./        # Format code
    uv run pyrefly check         # Type checking
    

Generate TS stub

uv run dev/generate_swagger_specs.py --output-dir openapi

use https://jsontotable.org/openapi-to-typescript to convert to typescript