BeatAPI for Dify

Discover BeatAPI models, social data, web tools and workflows, and create or
monitor image, video, Effect, and music-video tasks from Dify.

• Website: https://beatapi.io/
• API documentation: https://docs.beatapi.io/
• Create an API key: https://beatapi.io/dashboard/apikeys
• Source code: https://github.com/erickkkyt/beatapi-dify-plugin

Tools

The plugin exposes eleven tools against the current BeatAPI public contract:

• Search Capabilities, Inspect Capability, and Run Capability —
  discover current model, social data, web, or workflow capabilities and inspect
  their fields, price, readiness, and execution strategy. Use Run only when
  Inspect says it is supported; direct API capabilities use their documented
  endpoint instead. These are advanced tools for agents that discover
  capabilities at run time. A Run start may spend BeatAPI credits.

• List Generation Models — discover stable image/video aliases and input modes.

• Create Image Task — generate or edit images with ,
  , , or .

• Create Video Task — generate text, frame, or reference video with
  , , , , ,
  , or .

• List Effects and Get Effect — read each published Effect's versioned
  image-count, media, output, and option contract.

• Create Effect Task — run a selected Effect with a retry-safe idempotency key.

• Create Music Video Task — run the higher-level Music Video workflow.

• Get Task — poll every asynchronous task through the shared lifecycle.

Model aliases are BeatAPI's public contract. The plugin never exposes or
selects internal providers, templates, or routing IDs.

For the native Dify LLM node, configure BeatAPI as an OpenAI-compatible model
provider using . Text models that Inspect marks as
use their documented endpoint, not the Run tool. This tool plugin
does not add models to Dify's native model picker.

Create Music Video Task

Starts a BeatAPI workflow using one to seven public HTTPS image
URLs and one public HTTPS audio URL. It returns a task ID immediately, so long
renders do not block the Dify tool call.

The tool exposes BeatAPI's optional creative, quality, aspect-ratio, lip-sync,
subtitle, duration-fallback, and composition controls. composition is the
default and returns a finished hosted video. returns a storyboard that
can be edited and composed through the BeatAPI API.

Get Task

Returns the current task status, stage, output, usage, request ID, and public
error fields. Poll every 5-10 seconds until the task reaches or
; manual tasks can pause at for later editing.

Every current task includes , , and
. Usage values are decimal USD amounts. Compatibility field
names such as remain in the response, where 1 Credit equals
$1 USD.

Install from GitHub

In Dify, open Plugins > Install Plugin > GitHub, then enter:

Configure

1. Create a revocable API key at https://beatapi.io/dashboard/apikeys.
2. Open Tools > BeatAPI > Authorize in Dify.
3. Paste the API key. Dify verifies it with .
4. Add the named media tools you need to a Workflow or Chatflow. For an Agent
   that discovers capabilities dynamically, add Search, Inspect, and Run.

The API key is sent only in the header to
. Never place it in prompts or tool parameters.

Example workflow

1. Call List Generation Models or List Effects when the capability is
   not already known.
2. Supply public HTTPS media URLs and call the matching create tool.
3. Store the returned .
4. Wait 5-10 seconds and call Get Task with that ID.
5. Repeat with a bounded loop until the task reaches a terminal state.
6. Read the BeatAPI-hosted image or video URL from or .

Local development

The plugin requires Python 3.12 and the Dify CLI.

Run the behavior tests:

Package the plugin from the parent directory:

Support

Email [email protected] or visit https://beatapi.io/.