Skip to main content

Python SDK Overview

The Custodian Labs Python SDK helps developers build and deploy conversational AI assistants in their applications.

Use it to configure an assistant, add examples or knowledge files, deploy it as a reusable app, and continue multi-turn conversations.

When to Use the SDK

Your goalRecommended path
Build a conversational assistant with custom instructions, knowledge files, and chat sessionsUse the Python SDK
Transform sensitive text or files directly in your applicationUse the Guardian Layer API
Try privacy data transformation before integrating it into your applicationUse the Dashboard

If your application only needs direct de-identification, start with the Guardian Layer Overview instead.

Core Concepts at a Glance

ConceptWhat it means
CustodianStores your model, instructions, examples, and optional knowledge files.
AppA deployed assistant that can receive chat messages.
AgentTeamA deployed group of specialized agents that can route messages by topic.
Data sourceA file used to provide relevant context through RAG.
Chat sessionA conversation that retains context across multiple messages.

The basic lifecycle is:

Configure an Assistant → deploy it as an App → start a Chat Session

The following pages explain each step in more detail.

Next Steps

  1. Install the Python SDK
  2. Authenticate with Your API Key
  3. Create Your First Assistant
  4. Add Data Sources and RAG
  5. Build a Multi-Agent Team