SurrealDB for Workflow

Agno supports using SurrealDB as a storage backend for Workflows using the SurrealDb class.

Usage

Run SurreabDB locally with the following command:

docker run --rm --pull always -p 8000:8000 surrealdb/surrealdb:latest start --user root --pass root

surrealdb_for_workflow.py

from agno.agent import Agent
from agno.db.surrealdb import SurrealDb
from agno.models.anthropic import Claude
from agno.team import Team
from agno.tools.hackernews import HackerNewsTools
from agno.tools.hackernews import HackerNewsTools
from agno.workflow.step import Step
from agno.workflow.workflow import Workflow

# SurrealDB connection parameters
SURREALDB_URL = "ws://localhost:8000"
SURREALDB_USER = "root"
SURREALDB_PASSWORD = "root"
SURREALDB_NAMESPACE = "agno"
SURREALDB_DATABASE = "surrealdb_for_workflow"

creds = {"username": SURREALDB_USER, "password": SURREALDB_PASSWORD}
db = SurrealDb(None, SURREALDB_URL, creds, SURREALDB_NAMESPACE, SURREALDB_DATABASE)

# Define agents
hackernews_agent = Agent(
    name="Hackernews Agent",
    model=Claude(id="claude-sonnet-4-5-20250929"),
    tools=[HackerNewsTools()],
    role="Extract key insights and content from Hackernews posts",
)
web_agent = Agent(
    name="Web Agent",
    model=Claude(id="claude-sonnet-4-5-20250929"),
    tools=[HackerNewsTools()],
    role="Search the web for the latest news and trends",
)

# Define research team for complex analysis
research_team = Team(
    name="Research Team",
    model=Claude(id="claude-sonnet-4-5-20250929"),
    members=[hackernews_agent, web_agent],
    instructions="Research tech topics from Hackernews and the web",
)

content_planner = Agent(
    name="Content Planner",
    model=Claude(id="claude-sonnet-4-5-20250929"),
    instructions=[
        "Plan a content schedule over 4 weeks for the provided topic and research content",
        "Ensure that I have posts for 3 posts per week",
    ],
)

# Define steps
research_step = Step(
    name="Research Step",
    team=research_team,
)

content_planning_step = Step(
    name="Content Planning Step",
    agent=content_planner,
)

# Create and use workflow
if __name__ == "__main__":
    content_creation_workflow = Workflow(
        name="Content Creation Workflow",
        description="Automated content creation from blog posts to social media",
        db=db,
        steps=[research_step, content_planning_step],
    )
    content_creation_workflow.print_response(
        input="AI trends in 2024",
        markdown=True,
    )

Params

Parameter	Type	Default	Description
id	Optional[str]	-	The ID of the database instance. UUID by default.
client	Optional[Union[BlockingWsSurrealConnection, BlockingHttpSurrealConnection]]	-	A blocking connection, either HTTP or WebSocket.
db_url	str	-	The SurrealDB connection URL.
db_creds	dict[str, str]	-	Database credentials dictionary (username, password).
db_ns	str	-	The SurrealDB namespace to use.
db_db	str	-	The SurrealDB database name to use.
session_table	Optional[str]	-	Name of the table to store Agent, Team and Workflow sessions.
memory_table	Optional[str]	-	Name of the table to store user memories.
metrics_table	Optional[str]	-	Name of the table to store metrics.
eval_table	Optional[str]	-	Name of the table to store evaluation runs data.
knowledge_table	Optional[str]	-	Name of the table to store knowledge documents data.
culture_table	Optional[str]	-	Name of the table to store cultural knowledge data.
traces_table	Optional[str]	-	Name of the table to store traces.
spans_table	Optional[str]	-	Name of the table to store spans.