SDK Installation
[!NOTE] Python version upgrade policy Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.The SDK can be installed with either pip or poetry package managers.
PIP
PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.Poetry
Poetry is a modern tool that simplifies dependency management and package publishing by using a singlepyproject.toml
file to handle project metadata and dependencies.
Shell and script usage with uv
You can use this SDK in a Python shell with uv and the uvx
command that comes with it like so:
uv run script.py
where
script.py
can be replaced with the actual file name.
IDE Support
PyCharm
Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.SDK Example Usage
Example
Authentication
Per-Client Security Schemes
This SDK supports the following security scheme globally:Name | Type | Scheme | Environment Variable |
---|---|---|---|
api_key_auth | http | HTTP Bearer | DOCUMENTAI_API_KEY_AUTH |
api_key_auth
parameter must be set when initializing the SDK client instance. For example:
Available Resources and Operations
The available API operations and SDK implementation examples can be found within our API Reference documentationPagination
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have aNext
method that can be called to pull down the next group of results. If the
return value of Next
is None
, then there are no more pages to be fetched.
Here’s an example of one such pagination call:
Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK. To change the default retry strategy for a single API call, simply provide aRetryConfig
object to the call:
retry_config
optional parameter when initializing the SDK:
Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception. By default, an API error will raise a models.APIError exception, which has the following properties:Property | Type | Description |
---|---|---|
.status_code | int | The HTTP status code |
.message | str | The error message |
.raw_response | httpx.Response | The raw HTTP response |
.body | str | The response content |
list_async
method may raise the following exceptions:
Error Type | Status Code | Content Type |
---|---|---|
models.BadRequestError | 400 | application/json |
models.UnauthorizedError | 401 | application/json |
models.TooManyRequestsError | 429 | application/json |
models.InternalServerError | 500 | application/json |
models.APIError | 4XX, 5XX | */* |
Example
Server Selection
Override Server URL Per-Client
The default server can be overridden globally by passing a URL to theserver_url: str
optional parameter when initializing the SDK client instance. For example:
Custom HTTP Client
The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance ofHttpClient
or AsyncHttpClient
respectively, which are Protocol’s ensuring that the client has the necessary methods to make API calls.
This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client
or httpx.AsyncClient
directly.
For example, you could specify a header for every request that this sdk makes as follows:
Resource Management
TheDocumentAi
class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.
Debugging
You can setup your SDK to emit debug logs for SDK requests and responses. You can pass your own logger class directly into your SDK.DOCUMENTAI_DEBUG
to true.