SoulFire Python SDK

Use this reference to connect to SoulFire, control bots, and run server tasks. It documents the SDK source and generated protocol types for the version in the page title. For a first bot, start with the Python tutorial.

Choose an API

Goal

Start here

Connect or install SoulFire

soulfire.SoulFire

Provision accounts in an instance

soulfire.SoulFireInstance

Start a bot, read state, or perform actions

soulfire.SoulFireBot

Run and inspect server jobs

soulfire.SoulFireTasks, soulfire.SoulFireTask

Observe events and maintain live state

soulfire.BotSession

Query or change inventory

soulfire.SoulFireInventory

Discover and execute routes

soulfire.SoulFirePathfinder

Operations return lazy Effects or Streams. The lifecycle and task pages explain readiness, scope cleanup, failure handling, and cancellation ownership. Complete protobuf and RPC documentation remains available in the package reference.