Skip to main content

UnifAI Python SDK

Project description

unifai-sdk-py

unifai-sdk-py is the Python SDK for UnifAI, an AI native platform for dynamic tools and agent to agent communication.

Installation

pip install unifai-sdk

Getting your UnifAI API key

You can get your API key for free from UnifAI.

There are two types of API keys:

  • Agent API key: for using toolkits in your own agents.

  • Toolkit API key: for creating toolkits that can be used by other agents.

Using tools

To use tools in your agents, you need an agent API key. You can get an agent API key for free at UnifAI.

import unifai

tools = unifai.Tools(api_key='xxx')

Tool Types

UnifAI provides a flexible system for integrating AI tools in your applications:

Dynamic Tools

Dynamic tools are enabled by default, allowing agents to discover and use tools on-the-fly based on the task at hand. Tools will not be visible to agents directly. Instead, agents will see two functions only: one to search tools, one to use tools. Agents will be able to search for tools based on sementic query, get a list of relevant tools, and use tools dynamically.

# Enable dynamic tools (default behavior)
dynamic_tools = await tools.get_tools(dynamic_tools=True)

Static Toolkits

Static toolkits allow you to specify entire toolkits to be exposed to agents so they can be used without search.

static_tools = await tools.get_tools(
    dynamic_tools=False,  # Optional: disable dynamic tools
    static_toolkits=["1", "2"]
)

You can find available toolkits at https://app.unifai.network/toolkits.

Static Actions

Static actions provide granular control, allowing you to specify individual actions (tools) to be exposed to agents.

static_tools = await tools.get_tools(
    dynamic_tools=False,  # Optional: disable dynamic tools
    static_actions=["action_id_1", "action_id_2"]
)

You can find available actions at https://app.unifai.network/actions.

Mixed tools

You can combine these approaches for a customized tool setup:

combined_tools = await tools.get_tools(
    dynamic_tools=True,
    static_toolkits=["essential_toolkit_id"],
    static_actions=["critical_action_id"]
)

Passing tools to LLM

You can pass the tools to any OpenAI compatible API. Popular options include:

  • Model providers' native API
  • Litellm: A library that provides a unified OpenAI compatible API to most LLM providers
  • OpenRouter: A service that gives you access to most LLMs through a single OpenAI compatible API

The tools will work with any API that follows the OpenAI function calling format. This gives you the flexibility to choose the best LLM for your needs while keeping your tools working consistently.

response = await litellm.acompletion(
    model="anthropic/claude-3-7-sonnet-20250219",
    messages=[{"content": "Can you tell me what is trending on Google today?", "role": "user"}],
    tools=await tools.get_tools(),
)

If the response contains tool calls, you can pass them to the tools.call_tools method to get the results. The output will be a list of messages containing the results of the tool calls that can be concatenated to the original messages and passed to the LLM again.

results = await tools.call_tools(response.choices[0].message.tool_calls)
messages.extend(results)
# messages can be passed to the LLM again now

Passing the tool calls results back to the LLM might get you more function calls, and you can keep calling the tools until you get a response that doesn't contain any tool calls. For example:

messages = [{"content": "Can you tell me what is trending on Google today?", "role": "user"}]
while True:
    response = await litellm.acompletion(
        model="anthropic/claude-3-7-sonnet-20250219",
        messages=messages,
        tools=await tools.get_tools(),
    )
    messages.append(response.choices[0].message)
    results = await tools.call_tools(response.choices[0].message.tool_calls)
    if len(results) == 0:
        break
    messages.extend(results)

Using tools in MCP clients

We provide a MCP server to access tools in any MCP clients such as Claude Desktop.

The easiest way to run the server is using uv, see Instaling uv if you haven't installed it yet.

Then in your MCP client config:

{
  "mcpServers": {
    "unifai": {
      "command": "uvx",
      "args": [
        "--from",
        "unifai-sdk",
        "unifai-tools-mcp"
      ],
      "env": {
        "UNIFAI_AGENT_API_KEY": ""
      }
    }
  }
}

Now your MCP client will be able to access all the tools in UnifAI automatically through dynamic tools.

You can use environment variable to choose dynamic/static tools exposed by the MCP server, for example:

{
  "mcpServers": {
    "unifai": {
      "command": "uvx",
      "args": [
        "--from",
        "unifai-sdk",
        "unifai-tools-mcp"
      ],
      "env": {
        "UNIFAI_AGENT_API_KEY": "",
        "UNIFAI_DYNAMIC_TOOLS": "true",
        "UNIFAI_STATIC_TOOLKITS": "1,2,3",
        "UNIFAI_STATIC_ACTIONS": "ACTION_A,ACTION_B"
      }
    }
  }
}

Creating tools

Anyone can create dynamic tools in UnifAI by creating a toolkit.

A toolkit is a collection of tools that are connected to the UnifAI infrastructure, and can be searched and used by agents dynamically.

Initialize a toolkit client with your toolkit API key. You can get a toolkit API key for free at UnifAI.

import unifai

toolkit = unifai.Toolkit(api_key='xxx')

Update the toolkit name and/or description if you need:

await toolkit.update_toolkit(name="EchoChamber", description="What's in, what's out.")

or running it as a synchronous method with asyncio.run():

asyncio.run(toolkit.update_toolkit(name="EchoChamber", description="What's in, what's out."))

Register action handlers:

@toolkit.action(
    action="echo",
    action_description='Echo the message',
    payload_description={"content": {"type": "string"}},
)
async def echo(ctx: unifai.ActionContext, payload={}): # can be a sync function too
    return ctx.Result(f'You are agent <{ctx.agent_id}>, you said "{payload.get("content")}".')

Note that payload_description can be any string or a dict that contains enough information for agents to understand the payload format. It doesn't have to be in a certain format, as long as agents can understand it as natural language and generate the correct payload. Think of it as the comments and docs for your API, agents read it and decide what parameters to use. In practice we recommend using JSON schema to match the format of training data.

Start the toolkit:

await toolkit.run()

or running it as a synchronous method with asyncio.run():

asyncio.run(toolkit.run())

Examples

You can find examples in the examples directory.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unifai_sdk-0.3.1.tar.gz (192.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

unifai_sdk-0.3.1-py3-none-any.whl (47.8 kB view details)

Uploaded Python 3

File details

Details for the file unifai_sdk-0.3.1.tar.gz.

File metadata

  • Download URL: unifai_sdk-0.3.1.tar.gz
  • Upload date:
  • Size: 192.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for unifai_sdk-0.3.1.tar.gz
Algorithm Hash digest
SHA256 d5146f5c8171f56d5aa4453bbe514e916b8fbaaa1ead7e810f493a2b65134868
MD5 6ccc4ceee95d79f711208586a11b46b5
BLAKE2b-256 e370197e39d2c8cfbbb5f48310030ae699c0b8cd9e0118a37ac0b35228eff4da

See more details on using hashes here.

Provenance

The following attestation bundles were made for unifai_sdk-0.3.1.tar.gz:

Publisher: publish-to-pypi.yml on unifai-network/unifai-sdk-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file unifai_sdk-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: unifai_sdk-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 47.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for unifai_sdk-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8107010e5e4c615d262e6b705b40fe3af5286c643312497ea5c9837682fdbbcd
MD5 060e84310fade92b23f6b690a867c516
BLAKE2b-256 457958749852fde259e4843da4f7c18780ac830e557bd733fdeaf3e31fe6c6aa

See more details on using hashes here.

Provenance

The following attestation bundles were made for unifai_sdk-0.3.1-py3-none-any.whl:

Publisher: publish-to-pypi.yml on unifai-network/unifai-sdk-py

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page