Skip to content

buildwithdeck/sdk-python

BranchesTags

Repository files navigation

deck-sdk

Developer-friendly & type-safe Python SDK specifically catered to leverage deck-sdk API.



Summary

Deck API: # Deck API makes it straightforward for users to connect to any portal securely and quickly.

Welcome! Looking for a quick introduction to our API? Check out the 🚀Quickstart guide.

Starting on the sandbox server is easy:

  1. Create an account using the dashboard to get your client id and sandbox secret
  2. Enter your client id and sandbox secret in the Authentication section below
  3. Hit the "Try" buttons below for each endpoint.

Happy querying!

Table of Contents

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.

pip install deck-sdk

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add deck-sdk

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:

uvx --from deck-sdk python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "deck-sdk",
# ]
# ///

from deck_sdk import DeckSDK

sdk = DeckSDK(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with 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

# Synchronous Example
from deck_sdk import DeckSDK, models
import os


with DeckSDK(
    security=models.Security(
        client_id=os.getenv("DECKSDK_CLIENT_ID", ""),
        secret=os.getenv("DECKSDK_SECRET", ""),
    ),
) as ds_client:

    res = ds_client.jobs.submit(request={
        "job_code": "FetchDocuments",
        "input": {
            "access_token": "access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7",
            "key1": "value1",
            "someProperty": "someValue",
        },
    })

    # Handle response
    print(res)

The same SDK client can also be used to make asychronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from deck_sdk import DeckSDK, models
import os

async def main():

    async with DeckSDK(
        security=models.Security(
            client_id=os.getenv("DECKSDK_CLIENT_ID", ""),
            secret=os.getenv("DECKSDK_SECRET", ""),
        ),
    ) as ds_client:

        res = await ds_client.jobs.submit_async(request={
            "job_code": "FetchDocuments",
            "input": {
                "access_token": "access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7",
                "key1": "value1",
                "someProperty": "someValue",
            },
        })

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name Type Scheme Environment Variable
client_id apiKey API key DECKSDK_CLIENT_ID
secret apiKey API key DECKSDK_SECRET

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

from deck_sdk import DeckSDK, models
import os


with DeckSDK(
    security=models.Security(
        client_id=os.getenv("DECKSDK_CLIENT_ID", ""),
        secret=os.getenv("DECKSDK_SECRET", ""),
    ),
) as ds_client:

    res = ds_client.jobs.submit(request={
        "job_code": "FetchDocuments",
        "input": {
            "access_token": "access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7",
            "key1": "value1",
            "someProperty": "someValue",
        },
    })

    # Handle response
    print(res)

Available Resources and Operations

Available methods

connection

connections

jobs

jobs_documents

  • list - List documents

link

links

links.authentication

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 a RetryConfig object to the call:

from deck_sdk import DeckSDK, models
from deck_sdk.utils import BackoffStrategy, RetryConfig
import os


with DeckSDK(
    security=models.Security(
        client_id=os.getenv("DECKSDK_CLIENT_ID", ""),
        secret=os.getenv("DECKSDK_SECRET", ""),
    ),
) as ds_client:

    res = ds_client.jobs.submit(request={
        "job_code": "FetchDocuments",
        "input": {
            "access_token": "access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7",
            "key1": "value1",
            "someProperty": "someValue",
        },
    },
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from deck_sdk import DeckSDK, models
from deck_sdk.utils import BackoffStrategy, RetryConfig
import os


with DeckSDK(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    security=models.Security(
        client_id=os.getenv("DECKSDK_CLIENT_ID", ""),
        secret=os.getenv("DECKSDK_SECRET", ""),
    ),
) as ds_client:

    res = ds_client.jobs.submit(request={
        "job_code": "FetchDocuments",
        "input": {
            "access_token": "access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7",
            "key1": "value1",
            "someProperty": "someValue",
        },
    })

    # Handle response
    print(res)

Error Handling

DeckSDKError is the base class for all HTTP error responses. It has the following properties:

Property Type Description
err.message str Error message
err.status_code int HTTP response status code eg 404
err.headers httpx.Headers HTTP response headers
err.body str HTTP body. Can be empty string if no body is returned.
err.raw_response httpx.Response Raw HTTP response
err.data Optional. Some errors may contain structured data. See Error Classes.

Example

from deck_sdk import DeckSDK, errors, models
import os


with DeckSDK(
    security=models.Security(
        client_id=os.getenv("DECKSDK_CLIENT_ID", ""),
        secret=os.getenv("DECKSDK_SECRET", ""),
    ),
) as ds_client:
    res = None
    try:

        res = ds_client.jobs.submit(request={
            "job_code": "FetchDocuments",
            "input": {
                "access_token": "access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7",
                "key1": "value1",
                "someProperty": "someValue",
            },
        })

        # Handle response
        print(res)


    except errors.DeckSDKError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, errors.BadRequestJobResponseError):
            print(e.data.error_code)  # models.ErrorCodeEnum
            print(e.data.message)  # Optional[str]
            print(e.data.error_message)  # str

Error Classes

Primary errors:

Less common errors (7)

Network errors:

Inherit from DeckSDKError:

* Check the method documentation to see if the error is applicable.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Description
0 https://sandbox.deck.co/api/v1 Deck Sandbox API
1 https://live.deck.co/api/v1 Deck API

Example

from deck_sdk import DeckSDK, models
import os


with DeckSDK(
    server_idx=1,
    security=models.Security(
        client_id=os.getenv("DECKSDK_CLIENT_ID", ""),
        secret=os.getenv("DECKSDK_SECRET", ""),
    ),
) as ds_client:

    res = ds_client.jobs.submit(request={
        "job_code": "FetchDocuments",
        "input": {
            "access_token": "access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7",
            "key1": "value1",
            "someProperty": "someValue",
        },
    })

    # Handle response
    print(res)

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

from deck_sdk import DeckSDK, models
import os


with DeckSDK(
    server_url="https://live.deck.co/api/v1",
    security=models.Security(
        client_id=os.getenv("DECKSDK_CLIENT_ID", ""),
        secret=os.getenv("DECKSDK_SECRET", ""),
    ),
) as ds_client:

    res = ds_client.jobs.submit(request={
        "job_code": "FetchDocuments",
        "input": {
            "access_token": "access-development-6599f8dd-1a1c-4586-39d1-08ddb97283f7",
            "key1": "value1",
            "someProperty": "someValue",
        },
    })

    # Handle response
    print(res)

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 of HttpClient 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:

from deck_sdk import DeckSDK
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = DeckSDK(client=http_client)

or you could wrap the client with your own custom logic:

from deck_sdk import DeckSDK
from deck_sdk.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = DeckSDK(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The DeckSDK 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.

from deck_sdk import DeckSDK, models
import os
def main():

    with DeckSDK(
        security=models.Security(
            client_id=os.getenv("DECKSDK_CLIENT_ID", ""),
            secret=os.getenv("DECKSDK_SECRET", ""),
        ),
    ) as ds_client:
        # Rest of application here...


# Or when using async:
async def amain():

    async with DeckSDK(
        security=models.Security(
            client_id=os.getenv("DECKSDK_CLIENT_ID", ""),
            secret=os.getenv("DECKSDK_SECRET", ""),
        ),
    ) as ds_client:
        # Rest of application here...

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.

from deck_sdk import DeckSDK
import logging

logging.basicConfig(level=logging.DEBUG)
s = DeckSDK(debug_logger=logging.getLogger("deck_sdk"))

You can also enable a default debug logger by setting an environment variable DECKSDK_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

About

No description, website, or topics provided.

Resources

Readme

Contributing

Contributing
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases 1

python - v0.0.2 - 2025-07-31 18:03:02 Latest
Jul 31, 2025

Packages

No packages published

Contributors 2

  •  
  •  

Languages