Method generate

src/openrouter/video_generation.py:16–220

r"""Submit a video generation request Submits a video generation request and returns a polling URL to check status :param model: :param prompt: :param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.

(
        self,
        *,
        model: str,
        prompt: str,
        http_referer: Optional[str] = None,
        x_open_router_title: Optional[str] = None,
        x_open_router_categories: Optional[str] = None,
        aspect_ratio: Optional[components.VideoGenerationRequestAspectRatio] = None,
        callback_url: Optional[str] = None,
        duration: Optional[int] = None,
        frame_images: Optional[
            Union[
                Iterable[components.FrameImage],
                Iterable[components.FrameImageTypedDict],
            ]
        ] = None,
        generate_audio: Optional[bool] = None,
        input_references: Optional[
            Union[
                Iterable[components.InputReference],
                Iterable[components.InputReferenceTypedDict],
            ]
        ] = None,
        provider: Optional[
            Union[
                components.VideoGenerationRequestProvider,
                components.VideoGenerationRequestProviderTypedDict,
            ]
        ] = None,
        resolution: Optional[components.VideoGenerationRequestResolution] = None,
        seed: Optional[int] = None,
        size: Optional[str] = None,
        retries: OptionalNullable[utils.RetryConfig] = UNSET,
        server_url: Optional[str] = None,
        timeout_ms: Optional[int] = None,
        http_headers: Optional[Mapping[str, str]] = None,
    )

    r"""Video Generation endpoints"""

    def generate(
        self,
        *,
        model: str,
        prompt: str,
        http_referer: Optional[str] = None,
        x_open_router_title: Optional[str] = None,
        x_open_router_categories: Optional[str] = None,
        aspect_ratio: Optional[components.VideoGenerationRequestAspectRatio] = None,
        callback_url: Optional[str] = None,
        duration: Optional[int] = None,
        frame_images: Optional[
            Union[
                Iterable[components.FrameImage],
                Iterable[components.FrameImageTypedDict],
            ]
        ] = None,
        generate_audio: Optional[bool] = None,
        input_references: Optional[
            Union[
                Iterable[components.InputReference],
                Iterable[components.InputReferenceTypedDict],
            ]
        ] = None,
        provider: Optional[
            Union[
                components.VideoGenerationRequestProvider,
                components.VideoGenerationRequestProviderTypedDict,
            ]
        ] = None,
        resolution: Optional[components.VideoGenerationRequestResolution] = None,
        seed: Optional[int] = None,
        size: Optional[str] = None,
        retries: OptionalNullable[utils.RetryConfig] = UNSET,
        server_url: Optional[str] = None,
        timeout_ms: Optional[int] = None,
        http_headers: Optional[Mapping[str, str]] = None,
    ) -> components.VideoGenerationResponse:
        r"""Submit a video generation request

        Submits a video generation request and returns a polling URL to check status

        :param model:
        :param prompt:
        :param http_referer: The app identifier should be your app's URL and is used as the primary identifier for rankings.
            This is used to track API usage per application.

        :param x_open_router_title: The app display name allows you to customize how your app appears in OpenRouter's dashboard.

        :param x_open_router_categories: Comma-separated list of app categories (e.g. \"cli-agent,cloud-agent\"). Used for marketplace rankings.

        :param aspect_ratio: Aspect ratio of the generated video
        :param callback_url: URL to receive a webhook notification when the video generation job completes. Overrides the workspace-level default callback URL if set. Must be HTTPS.
        :param duration: Duration of the generated video in seconds
        :param frame_images: Images to use as the first and/or last frame of the generated video. Each image must specify a frame_type of first_frame or last_frame.
        :param generate_audio: Whether to generate audio alongside the video. Defaults to the endpoint's generate_audio capability flag, false if not set.
        :param input_references: Reference assets to guide video generation. Accepts image, audio, and video references. Audio and video references are only honored by providers that support them (currently BytePlus Seedance 2.0); other providers use image references and ignore the rest.
        :param provider: Provider-specific passthrough configuration