Client

Synchronous Client

Initialize the elluminate SDK client.

Parameters:

Name	Type	Description	Default
base_url	str	Base URL of the elluminate API. Defaults to "https://app.elluminate.de".	None
api_key	str | None	API key for authentication. If not provided, will look for key in environment variable given by api_key_env.	None
token	str | None	OAuth access token for authentication. If not provided, will look for token in environment variable given by token_env.	None
project_id	int | None	Project ID to select.	None
api_key_env	str	Name of environment variable containing API key. Defaults to "ELLUMINATE_API_KEY".	'ELLUMINATE_API_KEY'
token_env	str	Name of environment variable containing OAuth token. Defaults to "ELLUMINATE_OAUTH_TOKEN".	'ELLUMINATE_OAUTH_TOKEN'
base_url_env	str	Name of environment variable containing base URL. Defaults to "ELLUMINATE_BASE_URL". If set, overrides base_url.	'ELLUMINATE_BASE_URL'
timeout	float	Timeout in seconds for API requests. Defaults to 120.0.	120.0
proxy	str | None	Proxy URL for HTTP/HTTPS requests (e.g., "http://proxy.example.com:8080" or "http://user:[email protected]:8080"). If None or empty string, no proxy will be used.	None
skip_version_check	bool	Skip the SDK version compatibility check. Useful for offline or restricted network environments. Defaults to False.	False

Raises:

Type	Description
ValueError	If neither API key nor token is provided or found in environment.

check_version

check_version() -> None

Check if the SDK version is compatible with the required version.

This method makes a network call to the backend to verify SDK compatibility. If the backend is unreachable, the check is silently skipped. If the SDK version is incompatible, a warning is logged with upgrade instructions.

Asynchronous Client

Initialize the elluminate SDK async client.

Parameters:

Name	Type	Description	Default
base_url	str	Base URL of the elluminate API. Defaults to "https://app.elluminate.de".	None
api_key	str | None	API key for authentication. If not provided, will look for key in environment variable given by api_key_env.	None
token	str | None	OAuth access token for authentication. If not provided, will look for token in environment variable given by token_env.	None
project_id	int | None	Project ID to select.	None
api_key_env	str	Name of environment variable containing API key. Defaults to "ELLUMINATE_API_KEY".	'ELLUMINATE_API_KEY'
token_env	str	Name of environment variable containing OAuth token. Defaults to "ELLUMINATE_OAUTH_TOKEN".	'ELLUMINATE_OAUTH_TOKEN'
base_url_env	str	Name of environment variable containing base URL. Defaults to "ELLUMINATE_BASE_URL". If set, overrides base_url.	'ELLUMINATE_BASE_URL'
timeout	float	Timeout in seconds for API requests. Defaults to 120.0.	120.0
proxy	str | None	Proxy URL for HTTP/HTTPS requests (e.g., "http://proxy.example.com:8080" or "http://user:[email protected]:8080"). If None or empty string, no proxy will be used.	None
skip_version_check	bool	Skip the SDK version compatibility check. Useful for offline or restricted network environments. Defaults to False.	False

Raises:

Type	Description
ValueError	If neither API key nor token is provided or found in environment.

check_version async

check_version() -> None

Check if the SDK version is compatible with the required version.

This method makes a network call to the backend to verify SDK compatibility. If the backend is unreachable, the check is silently skipped. If the SDK version is incompatible, a warning is logged with upgrade instructions.

close async

close() -> None

Close the client and release resources.

This closes the underlying HTTP session. After calling close(), the client should not be used for further requests.