Glean Python API Client

The Glean Python SDK provides convenient access to the Glean REST API from any Python 3.8+ application. It includes type hints for all request parameters and response fields, and supports both synchronous and asynchronous usage via httpx.

Summary

Glean API: # Introduction In addition to the data sources that Glean has built-in support for, Glean also provides a REST API that enables customers to put arbitrary content in the search index. This is useful, for example, for doing permissions-aware search over content in internal tools that reside on-prem as well as for searching over applications that Glean does not currently support first class. In addition these APIs allow the customer to push organization data (people info, organization structure etc) into Glean.

Usage guidelines

This API is evolving fast. Glean will provide advance notice of any planned backwards incompatible changes along with a 6-month sunset period for anything that requires developers to adopt the new versions.

Table of Contents

• Glean Python API Client
• Usage guidelines
  • SDK Installation
  • IDE Support
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Resource Management
  • Debugging
• Development
  • Maturity
  • 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 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 api-client-glean

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 api-client-glean

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

from glean import Glean

sdk = Glean(
  # 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 glean import Glean, models
from glean.utils import parse_datetime
import os


with Glean(
    bearer_auth=os.getenv("GLEAN_BEARER_AUTH", ""),
) as g_client:

    g_client.client.activity.report(events=[
        {
            "action": models.ActivityEventAction.HISTORICAL_VIEW,
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/",
        },
        {
            "action": models.ActivityEventAction.SEARCH,
            "params": {
                "query": "query",
            },
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/search?q=query",
        },
        {
            "action": models.ActivityEventAction.VIEW,
            "params": {
                "duration": 20,
                "referrer": "https://example.com/document",
            },
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/",
        },
    ])

    # Use the SDK ...

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

# Asynchronous Example
import asyncio
from glean import Glean, models
from glean.utils import parse_datetime
import os

async def main():

    async with Glean(
        bearer_auth=os.getenv("GLEAN_BEARER_AUTH", ""),
    ) as g_client:

        await g_client.client.activity.report_async(events=[
            {
                "action": models.ActivityEventAction.HISTORICAL_VIEW,
                "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
                "url": "https://example.com/",
            },
            {
                "action": models.ActivityEventAction.SEARCH,
                "params": {
                    "query": "query",
                },
                "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
                "url": "https://example.com/search?q=query",
            },
            {
                "action": models.ActivityEventAction.VIEW,
                "params": {
                    "duration": 20,
                    "referrer": "https://example.com/document",
                },
                "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
                "url": "https://example.com/",
            },
        ])

        # Use the SDK ...

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
bearer_auth	http	HTTP Bearer	GLEAN_BEARER_AUTH

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

from glean import Glean, models
from glean.utils import parse_datetime
import os


with Glean(
    bearer_auth=os.getenv("GLEAN_BEARER_AUTH", ""),
) as g_client:

    g_client.client.activity.report(events=[
        {
            "action": models.ActivityEventAction.HISTORICAL_VIEW,
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/",
        },
        {
            "action": models.ActivityEventAction.SEARCH,
            "params": {
                "query": "query",
            },
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/search?q=query",
        },
        {
            "action": models.ActivityEventAction.VIEW,
            "params": {
                "duration": 20,
                "referrer": "https://example.com/document",
            },
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/",
        },
    ])

    # Use the SDK ...

Available Resources and Operations

Available methods

agents

• runagent - Runs an Agent.
• listagents - Lists all agents.
• getagentinputs - Gets the inputs to an agent.

client

client.activities

• report_activity - Report client activity

client.activity

• report - Report document activity

client.announcements

• create - Create Announcement
• delete - Delete Announcement
• update - Update Announcement

client.answers

• create - Create Answer
• delete - Delete Answer
• edit - Update Answer
• get - Read Answer
• list - List Answers

client.authentication

• create_token - Create authentication token

client.chat

• start - Chat
• delete_all - Deletes all saved Chats owned by a user
• delete - Deletes saved Chats
• get - Retrieves a Chat
• list - Retrieves all saved Chats
• get_application - Gets the metadata for a custom Chat application
• upload_files - Upload files for Chat.
• get_files - Get files uploaded by a user for Chat.
• delete_files - Delete files uploaded by a user for chat.

client.collections

• add_items - Add Collection item
• create - Create Collection
• delete - Delete Collection
• delete_item - Delete Collection item
• update - Update Collection
• edit_item - Update Collection item
• get - Read Collection
• list - List Collections

client.documents

• get_permissions - Read document permissions
• get - Read documents
• get_by_facets - Read documents by facets

client.entities

• list - List entities
• read_people - Read people

client.insights

• get - Read insights

client.messages

• get - Read messages

client.pins

• edit - Update pin
• get - Read pin
• list - List pins
• create - Create pin
• remove - Delete pin

client.search

• admin - Search the index (admin)
• autocomplete - Autocomplete
• get_feed - Feed of documents and events
• recommendations - Recommend documents
• execute - Search

client.shortcuts

• create - Create shortcut
• delete - Delete shortcut
• get - Read shortcut
• list - List shortcuts
• update - Update shortcut
• upload - Upload shortcuts

client.summarize

• generate - Summarize documents

client.verification

• add_reminder - Create verification
• list - List verifications
• verify - Update verification

indexing

indexing.authentication

• rotate_token - Rotate token

indexing.datasources

• add - Add or update datasource
• get_config - Get datasource config

indexing.documents

• add_or_update - Index document
• index - Index documents
• bulk_index - Bulk index documents
• process_all - Schedules the processing of uploaded documents
• delete - Delete document

indexing.people

• index - Index employee
• bulk_index_employees - Bulk index employees
• bulk_index - Bulk index employees ⚠️ Deprecated
• process_all_employees_and_teams - Schedules the processing of uploaded employees and teams
• delete - Delete employee
• index_team - Index team
• delete_team - Delete team
• bulk_index_teams - Bulk index teams

indexing.permissions

• update_permissions - Update document permissions
• index_user - Index user
• bulk_index_users - Bulk index users
• index_group - Index group
• bulk_index_groups - Bulk index groups
• index_membership - Index membership
• bulk_index_memberships - Bulk index memberships for a group
• process_memberships - Schedules the processing of group memberships
• delete_user - Delete user
• delete_group - Delete group
• delete_membership - Delete membership
• authorize_beta_users - Beta users

indexing.shortcuts

• bulk_index - Bulk index external shortcuts

indexing.troubleshooting

• get_datasource_status - Beta: Get datasource status

• post_document_debug - Beta: Get document information

• post_documents_debug - Beta: Get information of a batch of documents

• debug_user - Beta: Get user information

• check_access - Check document access

• get_status - Get document upload and indexing status ⚠️ Deprecated

• get_document_count - Get document count ⚠️ Deprecated

• get_user_count - Get user count ⚠️ Deprecated

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 glean import Glean, models
from glean.utils import BackoffStrategy, RetryConfig, parse_datetime
import os


with Glean(
    bearer_auth=os.getenv("GLEAN_BEARER_AUTH", ""),
) as g_client:

    g_client.client.activity.report(events=[
        {
            "action": models.ActivityEventAction.HISTORICAL_VIEW,
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/",
        },
        {
            "action": models.ActivityEventAction.SEARCH,
            "params": {
                "query": "query",
            },
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/search?q=query",
        },
        {
            "action": models.ActivityEventAction.VIEW,
            "params": {
                "duration": 20,
                "referrer": "https://example.com/document",
            },
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/",
        },
    ],
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Use the SDK ...

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 glean import Glean, models
from glean.utils import BackoffStrategy, RetryConfig, parse_datetime
import os


with Glean(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    bearer_auth=os.getenv("GLEAN_BEARER_AUTH", ""),
) as g_client:

    g_client.client.activity.report(events=[
        {
            "action": models.ActivityEventAction.HISTORICAL_VIEW,
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/",
        },
        {
            "action": models.ActivityEventAction.SEARCH,
            "params": {
                "query": "query",
            },
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/search?q=query",
        },
        {
            "action": models.ActivityEventAction.VIEW,
            "params": {
                "duration": 20,
                "referrer": "https://example.com/document",
            },
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/",
        },
    ])

    # Use the SDK ...

Error Handling

All operations return a response object or raise an exception:

Status Code	Description	Error Type	Content Type
400	Invalid Request	errors.GleanError	*/*
401	Not Authorized	errors.GleanError	*/*
403	Permission Denied	errors.GleanDataError	application/json
408	Request Timeout	errors.GleanError	*/*
422	Invalid Query	errors.GleanDataError	application/json
429	Too Many Requests	errors.GleanError	*/*
4XX	Other Client Errors	errors.GleanError	*/*
5XX	Internal Server Errors	errors.GleanError	*/*

Example

from glean import Glean, errors
import os


with Glean(
    bearer_auth=os.getenv("GLEAN_BEARER_AUTH", ""),
    server_url=os.getenv("GLEAN_SERVER_URL", "https://customer-be.glean.com")
) as glean:
    try:
        res = glean.chat.ask()
        print(res)
    # If the server returned structured data
    except errors.GleanDataError as e:
        print(e.data)
        print(e.data.errorMessage)
    except errors.GleanError as e:
        print(e.message)
        print(e.status_code)
        print(e.raw_response)
        print(e.body)

By default, an API error will raise a errors.GleanError exception, which has the following properties:

Property	Type	Description
error.status_code	int	The HTTP status code
error.message	str	The error message
error.raw_response	httpx.Response	The raw HTTP response
error.body	str	The response content

Server Selection

Server Variables

The default server https://{domain}-be.glean.com contains variables and is set to https://domain-be.glean.com by default. To override default values, the following parameters are available when initializing the SDK client instance:

Variable	Parameter	Default	Description
domain	domain: str	"domain"	Email domain (without extension) that determines the deployment backend.

Example

from glean import Glean, models
from glean.utils import parse_datetime
import os


with Glean(
    domain="scared-pearl.biz"
    bearer_auth=os.getenv("GLEAN_BEARER_AUTH", ""),
) as g_client:

    g_client.client.activity.report(events=[
        {
            "action": models.ActivityEventAction.HISTORICAL_VIEW,
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/",
        },
        {
            "action": models.ActivityEventAction.SEARCH,
            "params": {
                "query": "query",
            },
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/search?q=query",
        },
        {
            "action": models.ActivityEventAction.VIEW,
            "params": {
                "duration": 20,
                "referrer": "https://example.com/document",
            },
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/",
        },
    ])

    # Use the SDK ...

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 glean import Glean, models
from glean.utils import parse_datetime
import os


with Glean(
    server_url="https://domain-be.glean.com",
    bearer_auth=os.getenv("GLEAN_BEARER_AUTH", ""),
) as g_client:

    g_client.client.activity.report(events=[
        {
            "action": models.ActivityEventAction.HISTORICAL_VIEW,
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/",
        },
        {
            "action": models.ActivityEventAction.SEARCH,
            "params": {
                "query": "query",
            },
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/search?q=query",
        },
        {
            "action": models.ActivityEventAction.VIEW,
            "params": {
                "duration": 20,
                "referrer": "https://example.com/document",
            },
            "timestamp": parse_datetime("2000-01-23T04:56:07.000Z"),
            "url": "https://example.com/",
        },
    ])

    # Use the SDK ...

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 glean import Glean
import httpx

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

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

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

Resource Management

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

    with Glean(
        bearer_auth=os.getenv("GLEAN_BEARER_AUTH", ""),
    ) as g_client:
        # Rest of application here...


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

    async with Glean(
        bearer_auth=os.getenv("GLEAN_BEARER_AUTH", ""),
    ) as g_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 glean import Glean
import logging

logging.basicConfig(level=logging.DEBUG)
s = Glean(debug_logger=logging.getLogger("glean"))

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