Welcome
Welcome to the bizsupply API documentation. This guide will help you integrate with the bizsupply document processing platform.
Welcome to the bizsupply API documentation. This guide will help you integrate with the bizsupply document processing platform.
Getting Started
New to bizsupply? Start here.
| Guide | Description |
|---|---|
| System Overview | Platform capabilities and core workflows |
| Key Concepts | Essential concepts: plugins, ontologies, pipelines, documents |
SDK
Build plugins using the bizsupply-sdk package:
pip install bizsupply-sdk| Command | Description |
|---|---|
bizsupply init <type> --name <name> | Scaffold a new plugin, benchmark, or ontology |
bizsupply validate <file> | Validate plugin or ontology code |
bizsupply tutorial | Interactive development workflow tutorial |
Developer Journeys
Step-by-step guides for common tasks.
Plugin Development
| Journey | Description |
|---|---|
| Create a Plugin | Overview of plugin development |
| Classification Plugin | Categorize documents with labels |
| Extraction Plugin | Extract structured data from documents |
| Source Plugin | Ingest documents from external sources |
| Benchmark | Score documents and compare metrics |
Workflows
| Journey | Description |
|---|---|
| Use Plugins | Execute plugins via pipelines |
| Create an Ontology | Define data extraction schemas |
| Create a Prompt | Create reusable LLM prompt templates |
| Process Documents | End-to-end document processing workflow |
Reference
Technical specifications and API documentation.
| Reference | Description |
|---|---|
| Plugin Interface | REQUIRED - Plugin contract and requirements |
| Plugin Service API | Available helper methods for plugins |
Integrations
Connect AI assistants and external tools to bizSupply.
| Integration | Description |
|---|---|
| MCP Integration | Connect Claude Desktop, Cursor, or Claude Code via MCP |
Templates
Use the SDK CLI to scaffold new plugins, or copy templates from the dedicated guides:
bizsupply init classification --name my_classifier
bizsupply init extraction --name my_extractor
bizsupply init source --name my_source| Plugin Type | Guide |
|---|---|
| Source Plugin | Create a Source Plugin |
| Classification Plugin | Create a Classification Plugin |
| Extraction Plugin | Create an Extraction Plugin |
Quick Navigation
I want to...
Understand the platform
- Read the System Overview
Learn core concepts
- Read Key Concepts
Build a custom plugin
- Install the SDK:
pip install bizsupply-sdk - Classification Plugin - Categorize documents
- Extraction Plugin - Extract structured data
- Source Plugin - Ingest from external sources
- Benchmark - Score and compare documents
Process documents end-to-end
- Follow the Process Documents journey
Define extraction schemas
- Follow the Create an Ontology journey
Connect an AI assistant
- Follow the MCP Integration guide for Claude, Cursor, or Claude Code
Authentication
All API endpoints require JWT Bearer token authentication:
Authorization: Bearer <your_jwt_token>Tokens are obtained through OAuth2 authentication with Google or Microsoft.
API Reference
For detailed API endpoint documentation, see the API Reference.
Support
Need help? Contact support@bizsupply.ai