This repository contains code samples and quickstart guides for the Box Developer Documentation. Each quickstart is a standalone, ready-to-run example that demonstrates how to implement specific Box features and capabilities.
The quickstarts in this repository correspond to step-by-step guides in the Box developer documentation. They are designed to help developers:
- Get started quickly with working code examples
- Learn by doing through practical, real-world implementations
- Understand best practices for Box API integration
- Copy and adapt code for their own projects
Each quickstart is self-contained with its own dependencies, configuration, and sample data, making it easy to clone individual examples without needing the entire repository.
The following quickstarts demonstrate Box AI capabilities for intelligent document processing:
| Quickstart | Description | Documentation |
|---|---|---|
| box-ai-extract-quickstart | Extract structured metadata using Box metadata templates | Guide |
| box-ai-enhanced-extract-quickstart | Extract structured metadata with custom field definitions and the Enhanced Extract Agent | Guide |
| box-ai-freeform-extract-quickstart | Extract metadata using flexible, free-form prompts | Guide |
| box-ai-summarize-quickstart | Generate summaries of document content using Box AI | Guide |
Before using any quickstart, you'll need:
- Python 3.11 or higher installed on your system
- A Box account (free developer account available at box.com/developers)
- A Box application configured with appropriate authentication and scopes
Each quickstart follows a similar setup pattern:
-
Clone the quickstart you want to use:
git clone https://github.com/box-community/box-quickstarts.git cd box-quickstarts/<quickstart-name>
-
Create and activate a virtual environment:
python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate
-
Install dependencies:
pip install -r requirements.txt
-
Configure environment variables:
- Copy
.env.templateto.env - Add your Box credentials and configuration values
- Copy
-
Run the quickstart:
python <script-name>.py
Each quickstart directory contains its own README.md with:
- Specific prerequisites and Box app configuration requirements
- Detailed setup instructions
- Explanation of what the code does
- Expected output
- Links to relevant documentation
box-quickstarts/
├── README.md # This file
├── box-ai-extract-quickstart/ # Template-based metadata extraction
├── box-ai-enhanced-extract-quickstart/ # Advanced extraction with custom fields
├── box-ai-freeform-extract-quickstart/ # Free-form prompt extraction
└── box-ai-summarize-quickstart/ # Document summarization
Each quickstart is an independent project with:
- Its own git repository and history
- Complete documentation (README.md)
- Environment configuration template (.env.template)
- Sample data files for testing
- Python scripts with the implementation
This repository will expand to include quickstarts for:
- Authentication methods (OAuth 2.0, JWT, CCG)
- File operations (upload, download, preview)
- Collaboration features (comments, tasks, approvals)
- Metadata and classification
- Webhooks and events
- Search and collections
- And many more Box platform features
- Box Developer Documentation: developer.box.com
- Box Developer Community: community.box.com
- Box Platform SDKs: github.com/box
- Report Issues: GitHub Issues
These quickstarts are maintained by Box and the developer community. If you find issues or have suggestions for improvements, please open an issue or submit a pull request.
See individual quickstart directories for license information.
Note: These quickstarts use developer tokens and are intended for development and testing purposes. For production applications, use OAuth 2.0, JWT, or Client Credentials Grant authentication.