ReplicateTools enables an Agent to generate media using the Replicate platform.

​
Prerequisites

export REPLICATE_API_TOKEN=***

The following example requires the replicate library. To install the Replicate client, run the following command:

pip install -U replicate

​
Example

The following agent will use Replicate to generate images or videos requested by the user.

cookbook/tools/replicate_tool.py
from phi.agent import Agent
from phi.model.openai import OpenAIChat
from phi.tools.replicate import ReplicateTools

"""Create an agent specialized for Replicate AI content generation"""

image_agent = Agent(
    name="Image Generator Agent",
    model=OpenAIChat(id="gpt-4o"),
    tools=[ReplicateTools(model="luma/photon-flash")],
    description="You are an AI agent that can generate images using the Replicate API.",
    instructions=[
        "When the user asks you to create an image, use the `generate_media` tool to create the image.",
        "Return the URL as raw to the user.",
        "Don't convert image URL to markdown or anything else.",
    ],
    markdown=True,
    debug_mode=True,
    show_tool_calls=True,
)

image_agent.print_response("Generate an image of a horse in the dessert.")

​
Toolkit Params

ParameterTypeDefaultDescription
api_keystrNoneIf you want to manually supply the Replicate API key.
modelstrminimax/video-01The replicate model to use. Find out more on the Replicate platform.

​
Toolkit Functions

FunctionDescription
generate_mediaGenerate either an image or a video from a prompt. The output depends on the model.

​
Information