Platform

Manage the building blocks of Codat, including companies, connections, and more.

Summary

Platform API: An API for the common components of all of Codat's products.

These end points cover creating and managing your companies, data connections, and integrations.

Explore solution | See OpenAPI spec

Endpoints

Table of Contents

• Summary
• Endpoints
• SDK Installation
• IDE Support
• SDK Example Usage
• Available Resources and Operations
• Retries
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication
• Resource Management
• Support

SDK Installation

The SDK can be installed with uv, pip, or poetry package managers.

uv

uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

uv add codat-platform

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install codat-platform

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 codat-platform

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 codat-platform 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.10"
# dependencies = [
#     "codat-platform",
# ]
# ///

from codat_platform import CodatPlatform

sdk = CodatPlatform(
  # 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.

• PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
from codat_platform import CodatPlatform
from codat_platform.models import shared


with CodatPlatform(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
) as cp_client:

    res = cp_client.companies.list(request={
        "order_by": "-modifiedDate",
        "query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
        "tags": "region=uk && team=invoice-finance",
    })

    # Handle response
    print(res)

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

# Asynchronous Example
import asyncio
from codat_platform import CodatPlatform
from codat_platform.models import shared

async def main():

    async with CodatPlatform(
        security=shared.Security(
            auth_header="Basic BASE_64_ENCODED(API_KEY)",
        ),
    ) as cp_client:

        res = await cp_client.companies.list_async(request={
            "order_by": "-modifiedDate",
            "query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
            "tags": "region=uk && team=invoice-finance",
        })

        # Handle response
        print(res)

asyncio.run(main())

Available Resources and Operations

Retries

Every operation in this SDK retries failed requests with a default backoff strategy. By default it retries connection errors and responses with status 408, 429 or 5XX, starting at 500 ms and backing off by a factor of 1.5 up to 60 s between attempts, for at most an hour. You can override the retry strategy for a single call, 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 codat_platform import CodatPlatform
from codat_platform.models import shared
from codat_platform.utils import BackoffStrategy, RetryConfig


with CodatPlatform(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
) as cp_client:

    res = cp_client.companies.list(request={
        "order_by": "-modifiedDate",
        "query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
        "tags": "region=uk && team=invoice-finance",
    }, retries=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, you can use the retry_config optional parameter when initializing the SDK:

from codat_platform import CodatPlatform
from codat_platform.models import shared
from codat_platform.utils import BackoffStrategy, RetryConfig


with CodatPlatform(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
) as cp_client:

    res = cp_client.companies.list(request={
        "order_by": "-modifiedDate",
        "query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
        "tags": "region=uk && team=invoice-finance",
    })

    # Handle response
    print(res)

Error Handling

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

Example

from codat_platform import CodatPlatform
from codat_platform.models import errors, shared


with CodatPlatform(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
) as cp_client:
    res = None
    try:

        res = cp_client.companies.list(request={
            "order_by": "-modifiedDate",
            "query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
            "tags": "region=uk && team=invoice-finance",
        })

        # Handle response
        print(res)

    except errors.CodatPlatformError 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.ErrorMessage):
            print(e.data.can_be_retried)  # Optional[str]
            print(e.data.correlation_id)  # Optional[str]
            print(e.data.detailed_error_code)  # Optional[int]
            print(e.data.error)  # Optional[str]
            print(e.data.service)  # Optional[str]

Error Classes

Primary errors:

• CodatPlatformError: The base class for HTTP error responses.
  • ErrorMessage: A Codat API error response. Its structured fields are on err.data.

Network failures, such as a refused connection or a timeout, are raised by the underlying HTTP library: urllib3 by default, or httpx when you pass client.

Server Selection

Override Server URL Per-Client

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

from codat_platform import CodatPlatform
from codat_platform.models import shared


with CodatPlatform(
    server_url="https://api.codat.io",
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
) as cp_client:

    res = cp_client.companies.list(request={
        "order_by": "-modifiedDate",
        "query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
        "tags": "region=uk && team=invoice-finance",
    })

    # Handle response
    print(res)

Custom HTTP Client

The Python SDK can make its API calls through an httpx client you provide. This is a convenient way to configure cookies, proxies, custom headers, and other low-level settings. Pass an httpx.Client instance as the client parameter when initializing the SDK. It carries every request, including those made by the _async methods. The async_client parameter is accepted for compatibility with earlier SDK versions but is not used.

The SDK sets the timeout of every request itself, so a timeout configured on the httpx.Client is overridden. Use the timeout_ms parameter instead, when initializing the SDK or on a single call. The default is 5000 ms.

For example, you could specify a header for every request that this SDK makes as follows:

from codat_platform import CodatPlatform
import httpx

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

or you could subclass httpx.Client to wrap each request in your own custom logic:

from codat_platform import CodatPlatform
import httpx


class CustomClient(httpx.Client):
    def send(self, request: httpx.Request, **kwargs) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"
        return super().send(request, **kwargs)


s = CodatPlatform(client=CustomClient())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

from codat_platform import CodatPlatform
from codat_platform.models import shared


with CodatPlatform(
    security=shared.Security(
        auth_header="Basic BASE_64_ENCODED(API_KEY)",
    ),
) as cp_client:

    res = cp_client.companies.list(request={
        "order_by": "-modifiedDate",
        "query": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
        "tags": "region=uk && team=invoice-finance",
    })

    # Handle response
    print(res)

Resource Management

The CodatPlatform class implements the context manager protocol, so existing code that uses it in a with or async with block keeps working. Leaving the context does not close any HTTP connections: if you pass your own client, close it yourself when you are done. In longer-lived programs, create a single SDK instance via a context manager and reuse it across the application.

from codat_platform import CodatPlatform
from codat_platform.models import shared
def main():

    with CodatPlatform(
        security=shared.Security(
            auth_header="Basic BASE_64_ENCODED(API_KEY)",
        ),
    ) as cp_client:
        # Rest of application here...
        pass


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

    async with CodatPlatform(
        security=shared.Security(
            auth_header="Basic BASE_64_ENCODED(API_KEY)",
        ),
    ) as cp_client:
        # Rest of application here...
        pass

Support

If you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance. You can raise any issues by contacting your dedicated Codat representative or reaching out to our support team. We're here to help ensure a smooth experience for you.