Docugami Python API library

The Docugami Python library provides convenient access to the Docugami REST API from any Python 3.7+ application. The library includes type definitions for all request params and response fields, and offers both synchronous and asynchronous clients powered by httpx.

Documentation

The API documentation can be found here.

Installation

pip install docugami

Usage

The full API of this library can be found in api.md.

import os
from docugami import Docugami

client = Docugami(
    # This is the default and can be omitted
    api_key=os.environ.get("DOCUGAMI_API_KEY"),
)

page = client.documents.list()
print(page.page)

While you can provide an api_key keyword argument, we recommend using python-dotenv to add DOCUGAMI_API_KEY="My API Key" to your .env file so that your API Key is not stored in source control.

Async usage

Simply import AsyncDocugami instead of Docugami and use await with each API call:

import os
import asyncio
from docugami import AsyncDocugami

client = AsyncDocugami(
    # This is the default and can be omitted
    api_key=os.environ.get("DOCUGAMI_API_KEY"),
)


async def main() -> None:
    page = await client.documents.list()
    print(page.page)


asyncio.run(main())

Functionality between the synchronous and asynchronous clients is otherwise identical.

Using types

Nested request parameters are TypedDicts. Responses are Pydantic models, which provide helper methods for things like:

• Serializing back into JSON, model.model_dump_json(indent=2, exclude_unset=True)
• Converting to a dictionary, model.model_dump(exclude_unset=True)

Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set python.analysis.typeCheckingMode to basic.

Pagination

List methods in the Docugami API are paginated.

This library provides auto-paginating iterators with each list response, so you do not have to request successive pages manually:

import docugami

client = Docugami()

all_documents = []
# Automatically fetches more pages as needed.
for document in client.documents.list():
    # Do something with document here
    all_documents.append(document)
print(all_documents)

Or, asynchronously:

import asyncio
import docugami

client = AsyncDocugami()


async def main() -> None:
    all_documents = []
    # Iterate through items across all pages, issuing requests as needed.
    async for document in client.documents.list():
        all_documents.append(document)
    print(all_documents)


asyncio.run(main())

Alternatively, you can use the .has_next_page(), .next_page_info(), or .get_next_page() methods for more granular control working with pages:

first_page = await client.documents.list()
if first_page.has_next_page():
    print(f"will fetch next page using these details: {first_page.next_page_info()}")
    next_page = await first_page.get_next_page()
    print(f"number of items we just fetched: {len(next_page.documents)}")

# Remove `await` for non-async usage.

Or just work directly with the returned data:

first_page = await client.documents.list()

print(f"next URL: {first_page.next}")  # => "next URL: ..."
for document in first_page.documents:
    print(document.id)

# Remove `await` for non-async usage.

Handling errors

When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of docugami.APIConnectionError is raised.

When the API returns a non-success status code (that is, 4xx or 5xx response), a subclass of docugami.APIStatusError is raised, containing status_code and response properties.

All errors inherit from docugami.APIError.

import docugami
from docugami import Docugami

client = Docugami()

try:
    client.documents.list()
except docugami.APIConnectionError as e:
    print("The server could not be reached")
    print(e.__cause__)  # an underlying Exception, likely raised within httpx.
except docugami.RateLimitError as e:
    print("A 429 status code was received; we should back off a bit.")
except docugami.APIStatusError as e:
    print("Another non-200-range status code was received")
    print(e.status_code)
    print(e.response)

Error codes are as followed:

Retries

Certain errors are automatically retried 2 times by default, with a short exponential backoff. Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors are all retried by default.

You can use the max_retries option to configure or disable retry settings:

from docugami import Docugami

# Configure the default for all requests:
client = Docugami(
    # default is 2
    max_retries=0,
)

# Or, configure per-request:
client.with_options(max_retries=5).documents.list()

Timeouts

By default requests time out after 1 minute. You can configure this with a timeout option, which accepts a float or an httpx.Timeout object:

from docugami import Docugami

# Configure the default for all requests:
client = Docugami(
    # default is 60s
    timeout=20.0,
)

# More granular control:
client = Docugami(
    timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
)

# Override per-request:
client.with_options(timeout=5 * 1000).documents.list()

On timeout, an APITimeoutError is thrown.

Note that requests that time out are retried twice by default.

Advanced

Logging

We use the standard library logging module.

You can enable logging by setting the environment variable DOCUGAMI_LOG to debug.

$ export DOCUGAMI_LOG=debug

How to tell whether None means null or missing

In an API response, a field may be explicitly null, or missing entirely; in either case, its value is None in this library. You can differentiate the two cases with .model_fields_set:

if response.my_field is None:
  if 'my_field' not in response.model_fields_set:
    print('Got json like {}, without a "my_field" key present at all.')
  else:
    print('Got json like {"my_field": null}.')

Accessing raw response data (e.g. headers)

The "raw" Response object can be accessed by prefixing .with_raw_response. to any HTTP method call.

from docugami import Docugami

client = Docugami()
response = client.documents.with_raw_response.list()
print(response.headers.get('X-My-Header'))

document = response.parse()  # get the object that `documents.list()` would have returned
print(document.id)

These methods return an APIResponse object.

Configuring the HTTP client

You can directly override the httpx client to customize it for your use case, including:

• Support for proxies
• Custom transports
• Additional advanced functionality

import httpx
from docugami import Docugami

client = Docugami(
    # Or use the `DOCUGAMI_BASE_URL` env var
    base_url="http://my.test.server.example.com:8083",
    http_client=httpx.Client(
        proxies="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

Managing HTTP resources

By default the library closes underlying HTTP connections whenever the client is garbage collected. You can manually close the client using the .close() method if desired, or with a context manager that closes when exiting.

Versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes that only affect static types, without breaking runtime behavior.
2. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals).
3. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Requirements

Python 3.7 or higher.