Skip to content

eGain/egain-api-python

BranchesTags

Repository files navigation

egain-api-python

Developer-friendly & type-safe Python SDK specifically catered to leverage egain-api-python API.

Summary

Knowledge Portal Manager APIs:

License

The following licenses are required to use the Knowledge Access APIs:

  • If the user is an agent, then the Knowledge + AI license is required.
  • If the user is a customer, the Self-Service and Advanced Self-Service licenses must be available.

Tiers

Tier Tier Name Named Users Description
Tier 1 Starter Up to 10 Designed for small-scale implementations or pilot environments
Tier 2 Growth Up to 1000 Suitable for mid-scale deployments requiring moderate scalability
Tier 3 Enterprise Greater than 1000 Supports large-scale environments with extended configuration options

API Resource Limits

The following Resources have predefined limits for specific access attributes for Starter, Growth and Enterprise use.

Resource Limits Starter Growth Enterprise
Article Reference Number of attachments used in any article 25 50 50
Number of custom attributes in an article 10 25 50
Number of publish views used in an article version 20 20 20
Topic Reference User-defined topics in a department 1000 5000 50000
Depth of topics 5 20 20
Topics at any level 500 2500 2500
Number of custom attributes in a topic 10 10 10
Portal Reference Tag categories in a portal 15 15 15
Topics to be included in a portal 100 500 5000
Number of articles to display in announcements 10 25 25
Usage links and link groups setup for a portal 5 10 25

For more information about the API: Full SDK Documentation

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 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 egain-api-python

PIP

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

pip install egain-api-python

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 egain-api-python

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 egain-api-python 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 = [
#     "egain-api-python",
# ]
# ///

from egain_api_python import Egain

sdk = Egain(
  # 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 egain_api_python import Egain
import os


with Egain(
    access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
) as egain:

    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
        "PROD-1234": [
            "PROD-2000",
            "PROD-2003",
        ],
        "PROD-2005": [
            "PROD-2007",
        ],
    }, channel={
        "name": "Eight Bank Website",
    })

    # Handle response
    print(res)

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

# Asynchronous Example
import asyncio
from egain_api_python import Egain
import os

async def main():

    async with Egain(
        access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
    ) as egain:

        res = await egain.aiservices.retrieve.retrieve_chunks_async(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
            "PROD-1234": [
                "PROD-2000",
                "PROD-2003",
            ],
            "PROD-2005": [
                "PROD-2007",
            ],
        }, channel={
            "name": "Eight Bank Website",
        })

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme Environment Variable
access_token http HTTP Bearer EGAIN_ACCESS_TOKEN

To authenticate with the API the access_token parameter must be set when initializing the SDK client instance. For example:

from egain_api_python import Egain
import os


with Egain(
    access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
) as egain:

    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
        "PROD-1234": [
            "PROD-2000",
            "PROD-2003",
        ],
        "PROD-2005": [
            "PROD-2007",
        ],
    }, channel={
        "name": "Eight Bank Website",
    })

    # Handle response
    print(res)

Available Resources and Operations

Available methods

aiservices.answers

aiservices.retrieve

content.health

content.import_

portal.article

portal.articlelists

portal.attachment

portal.bookmark

portal.connectorssearchevents

portal.escalation

portal.export

portal.federatedsearchevent

portal.general

portal.guidedhelp

portal.populararticles

portal.search

  • ai_search - Get the best search results for a user query

portal.suggestion

portal.topic

portal.userdetails

portal.usermilestones

portal.userprofile

File uploads

Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

Tip

For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.

from egain_api_python import Egain
import os


with Egain(
    access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
) as egain:

    egain.portal.attachment.upload_attachment(accept_language="en-US", signature="<value>", request_body=open("example.file", "rb"))

    # Use the SDK ...

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 egain_api_python import Egain
from egain_api_python.utils import BackoffStrategy, RetryConfig
import os


with Egain(
    access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
) as egain:

    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
        "PROD-1234": [
            "PROD-2000",
            "PROD-2003",
        ],
        "PROD-2005": [
            "PROD-2007",
        ],
    }, channel={
        "name": "Eight Bank Website",
    },
        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 egain_api_python import Egain
from egain_api_python.utils import BackoffStrategy, RetryConfig
import os


with Egain(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
) as egain:

    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
        "PROD-1234": [
            "PROD-2000",
            "PROD-2003",
        ],
        "PROD-2005": [
            "PROD-2007",
        ],
    }, channel={
        "name": "Eight Bank Website",
    })

    # Handle response
    print(res)

Error Handling

EgainError 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 egain_api_python import Egain, errors
from egain_api_python.utils import parse_datetime
import os


with Egain(
    access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
) as egain:
    res = None
    try:

        res = egain.content.import_.create_import_job(data_source={
            "type": "AWS S3 bucket",
            "path": "s3://mybucket/myfolder/",
            "region": "us-east-1",
            "credentials": {},
        }, operation="import", schedule_time={
            "date_": parse_datetime("2024-03-01T10:00:00.000Z"),
        })

        # Handle response
        print(res)


    except errors.EgainError 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.WSErrorCommon):
            print(e.data.code)  # str
            print(e.data.developer_message)  # str
            print(e.data.details)  # Optional[List[models.WSErrorCommonDetail]]
            print(e.data.user_message)  # Optional[str]

Error Classes

Primary errors:

Less common errors (7)

Network errors:

Inherit from EgainError:

  • SchemasWSErrorCommon: Preconditions failed. Status code 412. Applicable to 2 of 79 methods.*
  • ServiceUnavailableError: ## Service is Unhealthy The Import Content service is experiencing critical issues and may not be able to process requests properly. Health Status Details: - Overall Status: Service is unhealthy and may not function correctly Response Information: - Status: Current health state (unhealthy) - Timestamp: When health check was performed - Version: Current API version - Issues: List of detected health problems. Status code 503. Applicable to 1 of 79 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.

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 egain_api_python import Egain
import os


with Egain(
    server_url="https://api.aidev.egain.cloud/knowledge/portalmgr/v4",
    access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
) as egain:

    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
        "PROD-1234": [
            "PROD-2000",
            "PROD-2003",
        ],
        "PROD-2005": [
            "PROD-2007",
        ],
    }, channel={
        "name": "Eight Bank Website",
    })

    # Handle response
    print(res)

Override Server URL Per-Operation

The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:

from egain_api_python import Egain
import os


with Egain(
    access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
) as egain:

    res = egain.aiservices.retrieve.retrieve_chunks(q="fair lending", portal_id="PROD-1000", filter_user_profile_id="PROD-3210", language="en-US", filter_tags={
        "PROD-1234": [
            "PROD-2000",
            "PROD-2003",
        ],
        "PROD-2005": [
            "PROD-2007",
        ],
    }, channel={
        "name": "Eight Bank Website",
    }, server_url="https://api.aidev.egain.cloud/core/aiservices/v4")

    # 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 egain_api_python import Egain
import httpx

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

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

from egain_api_python import Egain
from egain_api_python.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 = Egain(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The Egain 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 egain_api_python import Egain
import os
def main():

    with Egain(
        access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
    ) as egain:
        # Rest of application here...


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

    async with Egain(
        access_token=os.getenv("EGAIN_ACCESS_TOKEN", ""),
    ) as egain:
        # 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 egain_api_python import Egain
import logging

logging.basicConfig(level=logging.DEBUG)
s = Egain(debug_logger=logging.getLogger("egain_api_python"))

You can also enable a default debug logger by setting an environment variable EGAIN_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

eGain API client SDK for Python

Resources

Readme

License

MIT license

Contributing

Contributing
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases 6

python - v0.1.5 - 2025-10-09 06:09:16 Latest
Oct 9, 2025
+ 5 releases

Packages

No packages published

Languages