Steamship

Steamship is an SDK and hosting platform for AI Agents and Tools.

Follow our Agent Guidebook for a complete tutorial.

Steamship in 30 seconds

• Build Agents which run in the cloud.
• Use Plugins for common operations like generating text with GPT, converting a CSV to text, or generating an image from text. Steamship manages asynchronicity and retries.
• Store data in Files, Blocks, and Tags. This allows you to query or search it later.
• Deploy as a Package, creating a scalable API for your front end.
• Create as many instances of the Package as you want, each with its own data.

The best way to start is to make a simple package:

Start from our Multimodal Agent Template

Clone our starter repository:

git clone https://github.com/steamship-core/multimodal-agent-starter

Create a virtual environment and install dependencies:

python3 -m venv venv
source venv/bin/activate
 
pip install -r requirements.txt
pip install -r requirements.dev.txt

Then run:

ship run local

Now that you’ve interacted with your new agent, you’re ready to start modifying it in src/api.py.

See the Agent Guidebook for details.

Contents

• Agent Guidebook

• Configuration

  • Authentication
    • Steamship Configuration File
    • Using Multiple Profiles
    • Environment Variables
  • Client Libraries
    • Python Client
    • Typescript Client
  • CLI
  • HTTP API
    • Requests
      • Optional Headers
      • Engine Response Format
    • Creating a Package Instance
    • Invoking a Package Method

• Agents

  • Agent
  • AgentContext
  • Tool
  • AgentService

• Packages

• Plugins

  • File Importers
  • Blockifiers
  • Taggers
  • Generators
  • Embedders

• Data

  • Workspaces
    • Creating Workspaces
  • Files
    • Creating Files Directly
    • Making File Data Public
  • Blocks
    • Creating Blocks
    • Making Block Data Public
  • Tags
    • Ways to use Tags
    • Tag Schemas
    • Block and File Tags
  • Querying Data
    • Usage
    • Language Description
      • Unary Predicates
      • Binary Predicates
      • Binary Relations
      • Conjunctions
      • Special Predicates

• Embedding Search Index

• Inserting Data

• Querying Data

• Developer Reference

  • Cloning a Starter Project
  • The Steamship Manifest file
    • Plugin Configuration
    • Steamship Registry
  • Python Environment Setup
  • Accepting Configuration
    • Defining and Accepting configuration in your code
  • Storing Secrets
  • Running on Localhost
    • Localhost caveats
  • Writing Tests
    • Logging
    • Throwing Errors
    • Manual Testing
    • Automated testing
      • Automated testing setup
      • Modifying or removing automated testing
  • Deploying
    • Deploying with the Steamship CLI
    • Deploying via GitHub Actions
      • Automated Deployment Setup
      • Modifying or disabling automated deployments
    • Troubleshooting Deployments
      • The deployment fails because the version already exists
      • The deployment fails because the tag does not match the manifest file
      • The deployment fails with an authentication error
  • Monitoring your Instances
    • Monitoring via Web
      • Logs
      • Usage
      • Tasks
    • Using Logging in Instances
    • Logs Retrieval with ship CLI

• License

• Authors