构建视频生成提供商插件

视频生成（video-gen）提供商插件注册一个后端，用于服务每次 video_generate 工具调用。内置提供商（xAI、FAL）作为插件提供。通过将目录放入 plugins/video_gen/<name>/ 中，可以添加新的提供商或覆盖捆绑的提供商。

提示

视频生成几乎逐行镜像了图像生成提供商插件——如果你已经构建过图像生成后端，你就已经了解了其结构。主要区别在于：一个用于宣传模态/宽高比/时长的 capabilities() 方法，以及一种路由约定（传递 image_url 以使用图生视频，省略它以使用文生视频——提供商在内部选择正确的端点）。

统一接口（一个工具，两种模态）

video_generate 工具通过一个参数暴露两种模态：

文生视频 — 仅使用 prompt 调用。提供商将其路由到文生视频端点。
图生视频 — 使用 prompt + image_url 调用。提供商将其路由到图生视频端点。

编辑和扩展功能故意不在范围内。大多数后端不支持这些功能，且这种不一致性会迫使代理的工具描述中包含针对每个后端的说明文字。

发现机制如何工作

Hermes 在三个位置扫描视频生成后端：

捆绑 — <repo>/plugins/video_gen/<name>/（随 kind: backend 自动加载）
用户 — ~/.hermes/plugins/video_gen/<name>/（通过 plugins.enabled 启用）
Pip — 声明了 hermes_agent.plugins 入口点的包

每个插件的 register(ctx) 函数调用 ctx.register_video_gen_provider(...)。活动提供商由 config.yaml 中的 video_gen.provider 选定；hermes tools → Video Generation 会引导用户进行选择。与 image_generate 不同，代码库中没有遗留的后端——每个提供商都是一个插件。

目录结构

plugins/video_gen/my-backend/
├── __init__.py      # VideoGenProvider subclass + register()
└── plugin.yaml      # Manifest with kind: backend

VideoGenProvider 抽象基类

子类化 agent.video_gen_provider.VideoGenProvider。必需项：name 属性和 generate() 方法。

# plugins/video_gen/my-backend/__init__.py
from typing import Any, Dict, List, Optional
import os

from agent.video_gen_provider import (
    VideoGenProvider,
    error_response,
    success_response,
)


class MyVideoGenProvider(VideoGenProvider):
    @property
    def name(self) -> str:
        return "my-backend"

    @property
    def display_name(self) -> str:
        return "My Backend"

    def is_available(self) -> bool:
        return bool(os.environ.get("MY_API_KEY"))

    def list_models(self) -> List[Dict[str, Any]]:
        # Each entry is a model FAMILY — a name the user picks once.
        # Your provider's generate() routes within the family based on
        # whether image_url was passed.
        return [
            {
                "id": "fast",
                "display": "Fast",
                "speed": "~30s",
                "strengths": "Cheapest tier",
                "price": "$0.05/s",
                "modalities": ["text", "image"],  # advisory
            },
        ]

    def default_model(self) -> Optional[str]:
        return "fast"

    def capabilities(self) -> Dict[str, Any]:
        return {
            "modalities": ["text", "image"],
            "aspect_ratios": ["16:9", "9:16"],
            "resolutions": ["720p", "1080p"],
            "min_duration": 1,
            "max_duration": 10,
            "supports_audio": False,
            "supports_negative_prompt": True,
            "max_reference_images": 0,
        }

    def get_setup_schema(self) -> Dict[str, Any]:
        return {
            "name": "My Backend",
            "badge": "paid",
            "tag": "Short description shown in `hermes tools`",
            "env_vars": [
                {
                    "key": "MY_API_KEY",
                    "prompt": "My Backend API key",
                    "url": "https://mybackend.example.com/keys",
                },
            ],
        }

    def generate(
        self,
        prompt: str,
        *,
        model: Optional[str] = None,
        image_url: Optional[str] = None,
        reference_image_urls: Optional[List[str]] = None,
        duration: Optional[int] = None,
        aspect_ratio: str = "16:9",
        resolution: str = "720p",
        negative_prompt: Optional[str] = None,
        audio: Optional[bool] = None,
        seed: Optional[int] = None,
        **kwargs: Any,  # always ignore unknown kwargs for forward-compat
    ) -> Dict[str, Any]:
        # ROUTE: image_url presence picks the endpoint.
        if image_url:
            endpoint = "my-backend/image-to-video"
            modality_used = "image"
        else:
            endpoint = "my-backend/text-to-video"
            modality_used = "text"

        # ... call your API ...

        return success_response(
            video="https://your-cdn/output.mp4",
            model=model or "fast",
            prompt=prompt,
            modality=modality_used,
            aspect_ratio=aspect_ratio,
            duration=duration or 5,
            provider=self.name,
        )


def register(ctx) -> None:
    ctx.register_video_gen_provider(MyVideoGenProvider())

插件清单

# plugins/video_gen/my-backend/plugin.yaml
name: my-backend
version: 1.0.0
description: "My video generation backend"
author: Your Name
kind: backend
requires_env:
  - MY_API_KEY

`video_generate` 模式

该工具在所有后端之间暴露统一的模式。提供商忽略其不支持的参数。

参数	作用
`prompt`	文本指令（必需）
`image_url`	设置时 → 图生视频；省略时 → 文生视频
`reference_image_urls`	风格/角色参考（取决于提供商）
`duration`	秒数——由提供商限制范围
`aspect_ratio`	`"16:9"`、`"9:16"`、`"1:1"` 等——由提供商限制范围
`resolution`	`"480p"` / `"540p"` / `"720p"` / `"1080p"`——由提供商限制范围
`negative_prompt`	要避免的内容（仅限 Pixverse/Kling）
`audio`	原生音频（Veo3 / Pixverse 定价层级）
`seed`	可复现性
`model`	覆盖活动模型/系列

提供商的 capabilities() 会宣传哪些参数受支持。代理在工具描述中看到活动后端的功能，当用户通过 hermes tools 更改后端时，这些功能会动态重建。

模型系列和端点路由（FAL 模式）

当你的后端每个“模型”有多个端点时——例如 FAL，其中每个系列（Veo 3.1、Pixverse v6、Kling O3）都有 /text-to-video 和 /image-to-video URL——将每个系列表示为一个目录条目。你的 generate() 根据是否传递了 image_url 来选择正确的端点：

FAMILIES = {
    "veo3.1": {
        "text_endpoint": "fal-ai/veo3.1",
        "image_endpoint": "fal-ai/veo3.1/image-to-video",
        # ... family-specific capability flags ...
    },
}

def generate(self, prompt, *, image_url=None, model=None, **kwargs):
    family_id, family = _resolve_family(model)
    endpoint = family["image_endpoint"] if image_url else family["text_endpoint"]
    # ... build payload from family's declared capability flags, call endpoint ...

用户在 hermes tools 中选择一次 veo3.1。代理从不考虑端点——它只是传递（或不传递）image_url。

选择优先级

对于每个实例的模型调节参数（参见 plugins/video_gen/fal/__init__.py）：

工具调用中的 model= 关键字
<PROVIDER>_VIDEO_MODEL 环境变量
config.yaml 中的 video_gen.<provider>.model
config.yaml 中的 video_gen.model（当它是你的 ID 之一时）
提供商的 default_model()

响应结构

success_response() 和 error_response() 生成每个后端返回的字典结构。请使用它们——不要手动构建字典。

成功键：success、video（URL 或绝对路径）、model、prompt、modality（"text" 或 "image"）、aspect_ratio、duration、provider，以及 extra。

错误键：success、video（None）、error、error_type、model、prompt、aspect_ratio、provider。

保存工件的位置

如果你的后端返回 base64，请使用 save_b64_video() 写入 $HERMES_HOME/cache/videos/ 下。对于来自后续 HTTP 获取的原始字节，请使用 save_bytes_video()。否则直接返回上游 URL——网关会在交付时解析远程 URL。

测试

将冒烟测试放入 tests/plugins/video_gen/test_<name>_plugin.py。xAI 和 FAL 测试展示了模式——注册、验证目录、在有和没有 image_url 的情况下练习路由、断言在缺少身份验证时的干净错误响应。

统一接口（一个工具，两种模态）​

发现机制如何工作​

目录结构​

VideoGenProvider 抽象基类​

插件清单​

video_generate 模式​

模型系列和端点路由（FAL 模式）​

选择优先级​

响应结构​

保存工件的位置​

测试​