githubEdit

Get started

circle-info

For engineers.

WorkflowAI Python SDK is a library that allows you to programmatically create and run agents in Python, while being able to use the full power of the WorkflowAI platform.

Install the SDK

circle-info

workflowai requires Python >= 3.9.

PyPI versionarrow-up-right

pip install workflowai
circle-info

Star the repository on Githubarrow-up-right to get notified when new models are added.

API Key

Get your API key from your WorkflowAI Cloud dashboardarrow-up-right or from your self-hosted WorkflowAI dashboard.

Set the WORKFLOWAI_API_KEY environment variable.

Initialize the SDK

import os
import workflowai

workflowai.init( # This initialization is optional when using default settings
    api_key=os.environ.get("WORKFLOWAI_API_KEY"),  # This is the default and can be omitted
    url="https://run.workflowai.com",  # This is the default and can be omitted
)
circle-check
circle-info

You can also set the WORKFLOWAI_API_URL environment variable to point to your self-hosted WorkflowAI.

Write your first agent

An agent is in essence an async function with the added constraints that:

  • it has a single argument that is a Pydantic model, which is the input to the agent

  • it has a single return value that is a Pydantic model, which is the output of the agent

  • it is decorated with the @workflowai.agent() decorator

circle-info

Pydanticarrow-up-right is a very popular and powerful library for data validation and parsing.

The following agent, given a city, returns the country, capital, and a fun fact about the city.

circle-check

Agents created by the SDK are also available in the Playgroundarrow-up-right.

Playgroundarrow-up-right

Runs are automatically logged as well from the Runsarrow-up-right section.

Runsarrow-up-right

Next steps

Let's go through in more detail how to setup an agent.

Last updated