Kombo Python SDK

Developer-friendly & type-safe Python SDK for the Kombo Unified API.

Note

The Kombo Python SDK is currently in beta. The core API structure, methods, and input/output objects are considered stable. We may still make minor adjustments such as renames to exported type classes or fixes for code generator oddities, but all changes will be clearly documented in the changelog. We do not foresee any blockers for production use.

Table of Contents

• Kombo Python SDK
  • SDK Installation
  • SDK Example Usage
  • Region Selection
  • Available Resources and Operations
  • Pagination
  • Error Handling
  • Retries
  • Custom HTTP Client
  • Resource Management
  • Debugging
• Development
  • Contributions

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 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 kombo

PIP

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

pip install kombo

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 kombo

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 kombo 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 = [# "kombo",# ]# ///fromkomboimportKombosdk=Kombo(
# 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.

SDK Example Usage

fromkomboimportSDKwithSDK(
api_key="<YOUR_BEARER_TOKEN_HERE>",
) assdk:
res=sdk.general.check_api_key()
# Handle responseprint(res)

Specifying an integration ID

The majority of Kombo API endpoints are for interacting with a single "integration" (i.e., a single connection to one your customers' systems). For using these, make sure to specify the integration_id parameter when initializing the SDK:

fromkomboimportSDKwithSDK(
api_key="<YOUR_BEARER_TOKEN_HERE>",
integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
) assdk:
res=sdk.hris.get_employees()
# Handle responseprint(res)

Region Selection

The Kombo platform is available in two regions: Europe and United States.

By default, the SDK will use the EU region. If you're using the US region (hosted under api.us.kombo.dev), make sure to specify the server parameter when initializing the SDK.

Example

fromkomboimportSDKwithSDK(
server="us",
api_key="<YOUR_BEARER_TOKEN_HERE>",
) assdk:
res=sdk.general.check_api_key()
# Handle responseprint(res)

Available Resources and Operations

Available methods

Assessment

• get_packages - Get packages
• set_packages - Set packages
• get_assessment_orders - Get orders
• update_order_result - Update order result

Ats

• get_applications - Get applications
• move_application_to_stage - Move application to stage
• add_application_result_link - Add result link to application
• add_application_note - Add note to application
• get_application_attachments - Get application attachments
• add_application_attachment - Add attachment to application
• reject_application - Reject application
• get_candidates - Get candidates
• create_candidate - Create candidate
• get_candidate_attachments - Get candidate attachments
• add_candidate_attachment - Add attachment to candidate
• add_candidate_result_link - Add result link to candidate
• add_candidate_tag - Add tag to candidate
• remove_candidate_tag - Remove tag from candidate
• get_tags - Get tags
• get_application_stages - Get application stages
• get_jobs - Get jobs
• create_application - Create application
• get_users - Get users
• get_roles - Get roles
• get_offers - Get offers
• get_rejection_reasons - Get rejection reasons
• get_interviews - Get interviews
• get_notes - Get notes
• import_tracked_application - Import tracked application

Connect

• create_connection_link - Create connection link
• get_integration_by_token - Get integration by token

General

• check_api_key - Check API key
• trigger_sync - Trigger sync
• send_passthrough_request - Send passthrough request
• delete_integration - Delete integration
• get_integration_details - Get integration details
• set_integration_enabled - Set integration enabled
• create_reconnection_link - Create reconnection link
• create_setup_link - Create Setup Flow link
• get_integration_fields - Get integration fields
• update_integration_field - Updates an integration fields passthrough setting
• get_custom_fields - Get custom fields with current mappings
• update_custom_field_mapping - Put custom field mappings
• get_tools - Get tools

Hris

• get_employees - Get employees
• get_employee_form - Get employee form
• create_employee_with_form - Create employee with form
• add_employee_document - Add document to employee
• get_employee_document_categories - Get employee document categories
• get_groups - Get groups
• get_employments - Get employments
• get_locations - Get work locations
• get_absence_types - Get absence types
• get_time_off_balances - Get time off balances
• get_absences - Get absences
• create_absence - Create absence
• delete_absence - Delete absence
• get_legal_entities - Get legal entities
• get_timesheets - Get timesheets
• get_performance_review_cycles - Get performance review cycles
• get_performance_reviews - Get performance reviews
• get_staffing_entities - Get staffing entities

Pagination

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 a Next 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:

fromkomboimportKombowithKombo(
api_key="<YOUR_BEARER_TOKEN_HERE>",
) ask_client:
res=k_client.general.get_integration_fields(integration_id="<id>", page_size=100)
whileresisnotNone:
# Handle itemsres=res.next()

Error Handling

SDKError 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

fromkomboimportKombo, errorswithKombo(
api_key="<YOUR_BEARER_TOKEN_HERE>",
) ask_client:
res=Nonetry:
res=k_client.general.check_api_key()
# Handle responseprint(res)
excepterrors.SDKErrorase:
# The base class for HTTP error responsesprint(e.message)
print(e.status_code)
print(e.body)
print(e.headers)
print(e.raw_response)
# Depending on the method different errors may be thrownifisinstance(e, errors.KomboGeneralError):
print(e.data.status) # models.KomboGeneralErrorStatusprint(e.data.error) # models.KomboGeneralErrorError

Error Classes

Primary error:

• SDKError: The base class for HTTP error responses.

Less common errors (8)

Network errors:

• httpx.RequestError: Base class for request errors.
  • httpx.ConnectError: HTTP client was unable to make a request to a server.
  • httpx.TimeoutException: HTTP request timed out.

Inherit from SDKError:

• KomboAtsError: The standard error response with the error codes for the ATS use case. Applicable to 29 of 62 methods.*
• KomboHrisError: The standard error response with the error codes for the HRIS use case. Applicable to 18 of 62 methods.*
• KomboGeneralError: The standard error response with just the platform error codes. Applicable to 15 of 62 methods.*
• ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

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

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:

fromkomboimportKombofromkombo.utilsimportBackoffStrategy, RetryConfigwithKombo(
api_key="<YOUR_BEARER_TOKEN_HERE>",
) ask_client:
res=k_client.general.check_api_key(,
RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))
# Handle responseprint(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:

fromkomboimportKombofromkombo.utilsimportBackoffStrategy, RetryConfigwithKombo(
retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
api_key="<YOUR_BEARER_TOKEN_HERE>",
) ask_client:
res=k_client.general.check_api_key()
# Handle responseprint(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:

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

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

fromkomboimportKombofromkombo.httpclientimportAsyncHttpClientimporthttpxclassCustomClient(AsyncHttpClient):
client: AsyncHttpClientdef__init__(self, client: AsyncHttpClient):
self.client=clientasyncdefsend(
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"returnawaitself.client.send(
request, stream=stream, auth=auth, follow_redirects=follow_redirects
)
defbuild_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:
returnself.client.build_request(
method,
url,
content=content,
data=data,
files=files,
json=json,
params=params,
headers=headers,
cookies=cookies,
timeout=timeout,
extensions=extensions,
)
s=Kombo(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

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

fromkomboimportKombodefmain():
withKombo(
api_key="<YOUR_BEARER_TOKEN_HERE>",
) ask_client:
# Rest of application here...# Or when using async:asyncdefamain():
asyncwithKombo(
api_key="<YOUR_BEARER_TOKEN_HERE>",
) ask_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.

fromkomboimportKomboimportlogginglogging.basicConfig(level=logging.DEBUG)
s=Kombo(debug_logger=logging.getLogger("kombo"))

Development

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