# boxsdk

> Official Box Python SDK

- **URL**: https://www.freshcrate.ai/projects/boxsdk
- **Author**: Box
- **Category**: Frameworks
- **Latest version**: `v10.11.0` (2026-06-03)
- **License**: non-standard
- **Source**: https://github.com/box/box-python-sdk.git
- **Language**: Python
- **GitHub**: 456 stars, 220 forks
- **Registry**: pypi (`boxsdk`)
- **Tags**: `api`, `box`, `box-sdk-gen`, `boxsdk`, `pypi`, `rest`, `sdk`

## Description

<p align="center">
  <img src="https://github.com/box/sdks/blob/master/images/box-dev-logo.png" alt= “box-dev-logo” width="30%" height="50%">
</p>

# Box Python SDK v10

[![Project Status](http://opensource.box.com/badges/active.svg)](http://opensource.box.com/badges)
![build](https://github.com/box/box-python-sdk/actions/workflows/build.yml/badge.svg?branch=main)
[![PyPI version](https://badge.fury.io/py/boxsdk.svg)](https://badge.fury.io/py/boxsdk)
[![image](https://img.shields.io/pypi/dm/boxsdk.svg)](https://pypi.python.org/pypi/boxsdk)
![Platform](https://img.shields.io/badge/python-3.8+-blue)
[![Coverage](https://coveralls.io/repos/github/box/box-python-sdk/badge.svg?branch=main)](https://coveralls.io/github/box/box-python-sdk?branch=main)

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Introduction](#introduction)
- [Supported versions](#supported-versions)
  - [Version v4](#version-v4)
  - [Version v10](#version-v10)
  - [Which Version Should I Use?](#which-version-should-i-use)
- [Installing](#installing)
- [Getting Started](#getting-started)
- [Authentication](#authentication)
- [Documentation](#documentation)
- [Migration guides](#migration-guides)
- [Versioning](#versioning)
  - [Version schedule](#version-schedule)
- [Contributing](#contributing)
- [FIPS 140-2 Compliance](#fips-140-2-compliance)
- [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)
- [Copyright and License](#copyright-and-license)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

# Introduction

We are excited to introduce the v10 major release of the Box Python SDK,
designed to elevate the developer experience and streamline your integration with the Box Content Cloud.

With this SDK version, we provide the `box_sdk_gen` package, which gives you access to:

1. Full API Support: The new generation of Box SDKs empowers developers with complete coverage of the Box API ecosystem. You can now access all the latest features and functionalities offered by Box, allowing you to build even more sophisticated and feature-rich applications.
2. Rapid API Updates: Say goodbye to waiting for new Box APIs to be incorporated into the SDK. With our new auto-generation development approach, we can now add new Box APIs to the SDK at a much faster pace (in a matter of days). This means you can leverage the most up-to-date features in your applications without delay.
3. Embedded Documentation: We understand that easy access to information is crucial for developers. With our new approach, we have included comprehensive documentation for all objects and parameters directly in the source code of the SDK. This means you no longer need to look up this information on the developer portal, saving you time and streamlining your development process.
4. Enhanced Convenience Methods: Our commitment to enhancing your development experience continues with the introduction of convenience methods. These methods cover various aspects such as chunk uploads, classification, and much more.
5. Seamless Start: The new SDKs integrate essential functionalities like authentication, automatic retries with exponential backoff, exception handling, request cancellation, and type checking, enabling you to focus solely on your application's business logic.

Embrace the new generation of Box SDKs and unlock the full potential of the Box Content Cloud.

# Supported versions

To enhance developer experience, we have introduced the new generated codebase through the `box_sdk_gen` package.
The `box_sdk_gen` package is available in two major supported versions: v4 and v10.

## Version v4

In v4 of the Box Python SDK, we are introducing a version that consolidates both the manually written package (`boxsdk`)
and the new generated package (`box_sdk_gen`). This allows developers to use both packages simultaneously within a single project.

The codebase for v4 of the Box Python SDK is currently available on the [combined-sdk](https://github.com/box/box-python-sdk/tree/combined-sdk) branch.
Migration guide which would help with migration from `boxsdk` to `box_sdk_gen` can be found [here](./migration-guides/from-boxsdk-to-box_sdk_gen.md).

Version v4 is intended for:

- Existing developers of the Box Python SDK v3 who want to access new API features while keeping their current codebase largely unchanged.
- Existing developers who are in the process of migrating to `box_sdk_gen`, but do not want to move all their code to the new package immediately.

## Version v10

Starting with v10, the SDK is built entirely on the generated `box_sdk_gen` package, which fully and exclusively replaces the old `boxsdk` package.
The codebase for v10 of the Box Python SDK is currently available on the [main](https://github.com/box/box-python-sdk/tree/main) branch.

Version v10 is intended for:

- New users of the Box Python SDK.
- Developers already

## Recent releases

| Version | Date | Urgency | Changes |
| --- | --- | --- | --- |
| `v10.11.0` | 2026-06-03 | High | ### New Features and Enhancements  * Add Convert Note API (box/box-codegen[#955](https://github.com/box/box-python-sdk/issues/955)) ([#1458](https://github.com/box/box-python-sdk/issues/1458)) ([1215d52](https://github.com/box/box-python-sdk/commit/1215d52b80e4ab833c6d51615cfa2e60114f9326)) |
| `v4.11.0` | 2026-05-27 | High | ### New Features and Enhancements:  * **boxsdkgen:** Add Convert Note API (box/box-codegen[#955](https://github.com/box/box-python-sdk/issues/955)) ([#1457](https://github.com/box/box-python-sdk/issues/1457)) ([555f8f1](https://github.com/box/box-python-sdk/commit/555f8f175fdf12275d4a1b170ae48e44bed92436)) |
| `v10.10.0` | 2026-05-20 | High | ### New Features and Enhancements  * add failure related fields to `DocGenJob` (box/box-openapi[#598](https://github.com/box/box-python-sdk/issues/598)) ([#1445](https://github.com/box/box-python-sdk/issues/1445)) ([2916907](https://github.com/box/box-python-sdk/commit/29169071c482a3a3ed5ebfefc1d2377f7f049da9)) * Add new event types (box/box-openapi[#597](https://github.com/box/box-python-sdk/issues/597)) ([#1436](https://github.com/box/box-python-sdk/issues/1436)) ([22450ee](https://github.com/ |
| `v10.9.0` | 2026-05-06 | High | ### ⚠ BREAKING CHANGES  * Mark `id` field of `AIAgentReference` required (box/box-openapi[#1629](https://github.com/box/box-python-sdk/issues/1629)) (box/box-openapi[#595](https://github.com/box/box-python-sdk/issues/595)) ([#1422](https://github.com/box/box-python-sdk/issues/1422)) ([d31bca4](https://github.com/box/box-python-sdk/commit/d31bca44f67decd8e2a65eab8d95f45971bba591))  ### Bug Fixes  * Fix metadata template schema (box/box-openapi[#596](https://github.com/box/box-python-sdk/issues/59 |
| `v4.8.0` | 2026-04-30 | High | ### New Features and Enhancements:  * **boxsdkgen:** Automate Public API (box/box-openapi[#594](https://github.com/box/box-python-sdk/issues/594)) ([#1412](https://github.com/box/box-python-sdk/issues/1412)) ([4a39dcc](https://github.com/box/box-python-sdk/commit/4a39dccd6ea375d364687eb9d17f60233e98f37f)) |
| `v10.8.0` | 2026-04-30 | High | ### New Features and Enhancements  * Automate Public API (box/box-openapi[#594](https://github.com/box/box-python-sdk/issues/594)) ([#1409](https://github.com/box/box-python-sdk/issues/1409)) ([3cfb35c](https://github.com/box/box-python-sdk/commit/3cfb35c6a86062658588afd779410bb426472427)) |
| `v10.7.0` | 2026-04-22 | High | ### Bug Fixes  * Correct `retention_length` type hint to accept both integer and string (box/box-codegen[#932](https://github.com/box/box-python-sdk/issues/932)) ([#1382](https://github.com/box/box-python-sdk/issues/1382)) ([e8f93ce](https://github.com/box/box-python-sdk/commit/e8f93ce4da1d2c68d809e4af38741ebf91bc6fe2))   ### New Features and Enhancements  * Add `max_extension_length` field to Retention Policies (box/box-openapi[#593](https://github.com/box/box-python-sdk/issues/593)) ([#1394](h |
| `10.6.0` | 2026-04-21 | Low | Imported from PyPI (10.6.0) |
| `v10.6.0` | 2026-04-01 | Medium | ### ⚠ BREAKING CHANGES  * Correct search content type `tags` to match API (box/box-openapi#591) (#1369)  ### Bug Fixes  * Add missing discriminators for schema types (box/box-codegen[#931](https://github.com/box/box-python-sdk/issues/931)) ([#1368](https://github.com/box/box-python-sdk/issues/1368)) ([fe0a3b8](https://github.com/box/box-python-sdk/commit/fe0a3b86b292d7304c244e4b6933612bbce5f332)) * Align `LegalHoldPolicyAssignedItem` with API (box/box-openapi[#1554](https://github.com/box |
| `v4.6.0` | 2026-04-01 | Medium | ### ⚠ BREAKING CHANGES  * **boxsdkgen:** Correct search content type `tags` to match API (box/box-openapi#591) (#1370)  ### Bug Fixes:  * **boxsdkgen:** Add missing discriminators for schema types (box/box-codegen[#931](https://github.com/box/box-python-sdk/issues/931)) ([#1367](https://github.com/box/box-python-sdk/issues/1367)) ([113faa3](https://github.com/box/box-python-sdk/commit/113faa396043e1e82cf9c73ec43034d7e6be62a6)) * **boxsdkgen:** Align `LegalHoldPolicyAssignedItem` with API |

## Dependency audit

- **Score**: 98/100
- **Total deps**: 0
- **Resolved**: 0
- **Unresolved**: 0
- **License conflicts**: 0
- **Warnings**: 1
- **Scanned**: 2026-05-25

## Citation

- HTML: https://www.freshcrate.ai/projects/boxsdk
- Markdown: https://www.freshcrate.ai/projects/boxsdk.md
- Dependencies JSON: https://www.freshcrate.ai/api/projects/boxsdk/deps

_Generated by freshcrate.ai. Indexes pypi releases for AI-agent ecosystem packages._
