/* hack until mintlify supports deprecations */

a[href*="/actions/api/setup"],
a[href*="/indexing/api/troubleshooting/get-user-count"],
a[href*="/indexing/api/troubleshooting/get-document-count"],
a[href*="/indexing/api/troubleshooting/get-document-upload-and-indexing-status"],
a[href*="/indexing/api/people/bulk-index-employees-1"],
a[href*="/client/api/answers/create-answer-board"],
a[href*="/client/api/answers/delete-answer-board"],
a[href*="/client/api/answers/update-answer-board"],
a[href*="/client/api/answers/read-answer-board"] {
    text-decoration: line-through;
}

/* Banner for WIP */
#sidebar {
    top: 0;
    transition: top 0.3s ease-in-out;
}
#navbar-transition-willow {
    margin-top: 0;
    transition: margin-top 0.3s ease-in-out;
}
#banner {
    height: 0;
    transition: height 0.3s ease-in-out;
}

#sidebar:is(.slow *) {
    top: 2.5rem;
}
#navbar-transition-willow:is(.slow *) {
    margin-top: 2.5rem;
}
#banner:is(.slow *) {
    height: 2.5rem;
}


@font-face {
    font-family: 'Polysans Neutral';
    src: url('https://cdn.prod.website-files.com/6127a84dfe068e153ef20572/66b4a66d22e2c49832621144_PolySans-Neutral.woff2') format('woff2');
    font-weight: 400;
    font-style: normal;
    font-display: swap;
}

@font-face {
    font-family: 'Polysans Slim';
    src: url('https://cdn.prod.website-files.com/6127a84dfe068e153ef20572/66b4a66da54786325597bf31_PolySans-Slim.woff2') format('woff2');
    font-weight: 300;
    font-style: normal;
    font-display: swap;
}

@font-face {
    font-family: 'Polysans Neutral Mono';
    src: url('https://cdn.prod.website-files.com/6127a84dfe068e153ef20572/66b5e8b95fd9e34f78a1c7de_PolySans-NeutralMono.woff2') format('woff2');
    font-weight: 400;
    font-style: normal;
    font-display: swap;
}

@font-face {
    font-family: 'Polysans Median';
    src: url('https://cdn.prod.website-files.com/6127a84dfe068e153ef20572/66b5e8b9a5fb33f679d14c62_PolySans-Median.woff2') format('woff2');
    font-weight: 400;
    font-style: normal;
    font-display: swap;
}

:root {
    --bright-green: #d8fd49;
    --light-green: #c3ff9e;
    --primary-ultramarine: #343ced;
    --blue-500: #343ced;
    --blue-600: #131bd4;
    --white: #fff;
    --black: #333;
}

/* increase content area max-width */
@media (min-width: 1536px) {
    body :is(.\32xl\:max-w-2xl) {
        max-width: 65rem;
    }
}

/*********************************
 * Base Styles
 *********************************/

/* smooth anchor hover transition */
a {
    transition: color 0.3s ease-in-out;
}

/* space out tight tracking */
.tracking-tight {
    letter-spacing: .025em;
}


.button {
    background-color: var(--blue-500);
    color: var(--white);
    text-align: center;
    border: 1px solid #0000;
    border-radius: 4rem;
    justify-content: center;
    align-items: center;
    padding: .625rem 2rem;
    font-family: Polysans Neutral,sans-serif;
    font-size: 1.25rem;
    font-weight: 400;
    line-height: 1.4;
    text-decoration: none;
    transition: all .25s ease-in-out;
    display: flex;
    overflow: hidden
}

.button:hover {
    background-color: var(--blue-600);
    color: var(--white);
    opacity: 0.9;
}

.button.is-green:hover {
    background-color: var(--light-green)
}

.button.is-green:focus {
    outline-color: var(--white-2);
    border-style: solid;
    outline-width: 1px
}

.button.is-green, .button.is-green:is(.dark *) {
    background-color: var(--bright-green);
    color: var(--black);
}

/*********************************
* Header
*********************************/

/* hides header links added from docs.json */
@media (max-width: 1060px) {
    #navbar-transition-willow div:nth-child(2) {
        display: none;
    }
}

/* hides CTA button and dark/light mode toggle */
@media (max-width: 1250px) {
    #topbar-cta-button,
    #navbar-transition-willow div:nth-child(3) {
        display: none;
    }
}

/* increase logo height */
img.h-7, img.h-6 {
    height: 2.1rem;
}

/* change cta button color */
#topbar-cta-button {
    border-radius: 4rem;
    padding-left: 1rem;
    padding-right: 1rem;
    background-color: rgb(var(--primary-dark));
}

#topbar-cta-button:hover {
    opacity: 0.9;
}

#topbar-cta-button div {
    color: white;
}

/*********************************
* Footer
*********************************/

/* increase footer width */
#footer .max-w-\[984px\] {
    max-width: 90%;
}

/* brings social icons closer to logo in footer */
#footer .justify-between.md\:gap-y-24 {
    justify-content: start;
    gap: 2rem;
}

/* change footer logo to official light logo */
#footer a img.dark\:hidden {
    content:url("https://mintlify.s3.us-west-1.amazonaws.com/glean-dd126214/brand/glean-logo-light.svg");
}

/* change footer logo to official dark logo */
#footer a img.dark\:block {
    content:url("https://mintlify.s3.us-west-1.amazonaws.com/glean-dd126214/brand/glean-logo-dark.svg");
}

/* remove footer links on mobile */
@media screen and (max-width: 768px) {
    #footer .min-h-\[76px\] {
        min-height: 0;
    }
    #footer .min-h-\[76px\] > :nth-child(2) {
        display: none;
    }
}

@media screen and (min-width: 768px) {
    #footer a img {
        height: 3rem;
    }
}


/*************************************************************************
 * Mintlify Deprecated Endpoint Warning
 *
 * Mintlify doesn't adjust the UI for deprecated endpoints.
 * This script adds a warning callout to deprecated endpoints.
 *************************************************************************/

const deprecatedWarningText = "This endpoint is deprecated and may be removed at anytime.";
const deprecatedPaths = [
    "/actions/api/setup",
    "/indexing/api/troubleshooting/get-user-count",
    "/indexing/api/troubleshooting/get-document-count",
    "/indexing/api/troubleshooting/get-document-upload-and-indexing-status",
    "/indexing/api/people/bulk-index-employees-1",
    "/client/api/answers/create-answer-board",
    "/client/api/answers/delete-answer-board",
    "/client/api/answers/update-answer-board",
    "/client/api/answers/read-answer-board"
];

// Add deprecated warning
function addDeprecatedWarning() {
    const canonicalLink = document.querySelector('head link[rel="canonical"]');

    if (canonicalLink) {
        const url = new URL(canonicalLink.href);
        if (deprecatedPaths.some(path => url.pathname.includes(path))) {
            document.body.classList.add("deprecated");

            const header = document.querySelector('header');
            if (header) {
                const warningDiv = document.createElement('div');
                warningDiv.className = "callout my-4 px-5 py-4 overflow-hidden rounded-2xl flex gap-3 border border-amber-500/20 bg-amber-500/10 dark:border-amber-500/30 dark:bg-amber-500/10";
                warningDiv.setAttribute("data-callout-type", "warning");
                warningDiv.innerHTML = `<div class="mt-0.5 w-4"><svg class="flex-none w-5 h-5 text-amber-400 dark:text-amber-300/80" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2" aria-label="Warning"><path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg></div><div class="text-sm prose min-w-0 w-full text-amber-900 dark:text-amber-200">${deprecatedWarningText}</div>`;
                header.insertAdjacentElement('afterend', warningDiv);
            }
        }
    }
}

// Listen for route changes and update the document title
window.next.router.events.on('routeChangeComplete', addDeprecatedWarning);
addDeprecatedWarning();

/*************************************************************************
 * Mintlify Local Link Overrides
 *
 * Mintlify assumes all pages that use "url" metadata are external links.
 * This script prevents local links from opening in new tabs.
 *************************************************************************/

document.addEventListener('click', (event) => {
    const target = event.target.closest('a');
    if (!target) return;

    const href = target.getAttribute('href');
    if (!href) return;

    // Check if the link is a local link and has a target attribute
    if (href.startsWith('/') && target.target === '_blank') {
        target.removeAttribute('target');
    }

    // Check if href ends with /[type]/openapi and redirect to the appropriate OAS URL
    const openapiMatch = href.match(/\/([^\/]+)\/openapi$/);
    if (openapiMatch) {
        const type = openapiMatch[1];
        target.setAttribute('href', `/oas/${type}`);
        target.setAttribute('target', '_blank');
    }
}, true);

/*************************************************************************
 * Mintlify Slow Banner Overrides
 *
 * Some OpenAPI endpoints are slow and may take a long time to respond.
 * This script adds a banner to slow endpoints while Mintlify works on a fix.
 *************************************************************************/
document.addEventListener('click', (event) => {
    const target = event.target.closest('a');
    if (!target) return;

    const href = target.getAttribute('href');
    if (!href) return;

    if (href.startsWith('/client/api')) {
        document.body.classList.add('slow');
    } else {
        document.body.classList.remove('slow');
    }
});

Document Model

🚧 This section is loading a little slowly. We're working on a fix now!

Glean Developer Portal

Welcome

Glean Developer Platform

Change Log

Glean SDKs

Build powerful AI agents with Glean's enterprise knowledge

Agent Integrations

Open Source

A collection of community projects that integrate with Glean

Community Projects

Discussions

Report a Bug

Request a Feature

Overview

Rendering Search Results

People, Teams and Identity

OpenAPI Spec

Setup Datasource

Indexing Documents

Managing Tokens

Token Rotation

Permissions

Custom Properties

Test Datasource

Activity

Bulk Indexing

Bulk Upload Model

Supported MIME Types

Datasource Config

Datasource Status

Datasource Document

Datasource User

Document Access

Document Count

Making Requests

Authentication

Chat API

Simple Chatbot

Agentic AI With NVIDIA NIM

Build an Agentic AI With NVIDIA NIM and Glean

Filtering Results

Datasource Filters

Faceted Filtering

Integrate AI-powered search and chat functionalities into your intranet portal using Glean's Web SDK components

Understanding browser third-party cookie policies and their impact on Glean functionality

Third-Party Cookie Management

SDK Reference

Implement AI-powered chat functionality that leverages your company's content and user relationships

Glean Chat

Build a custom search interface by combining Glean's Autocomplete and Search Results components

Autocomplete

Add a powerful search modal dialog to your application with minimal code integration

Modal Search

Integrate contextual search, chat, and recommendations in a convenient sidebar interface

Sidebar Search

Display contextual recommendations and search functionality based on the current page content

Recommendations

Integrate Glean Search into your React application

React

Step-by-step guide for integrating Glean search functionality into Zendesk Guide using the Copenhagen template

Zendesk

Instructions for replacing LumApps' native search functionality with Glean's modal search interface

LumApps

Guide for implementing Glean's modal search functionality within Brightspot sites

Brightspot

Learn how actions can automate tasks and enhance Glean Chat functionality

Configure and implement authentication for Glean Actions to ensure secure integrations

Learn how to create, configure and deploy Actions in Glean to enable automated workflows and integrations

Creating Actions

Frequently asked questions about implementing and using Actions on Glean's platform

Learn how to create an execution action that allows Glean Assistant to update Google Documents programmatically

Google Docs Update Action

Create a retrieval action that enables Glean Assistant to fetch and display Google Calendar events

Google Calendar Events Retrieval Action

Learn how to implement a redirect action that enables Glean Assistant to create pre-populated Zendesk tickets efficiently

Zendesk Ticket Creation

Implement an execution action that enables Glean Assistant to create Jira issues programmatically with proper user attribution

Jira Issue Creation

Implement a redirect action that enables Glean Assistant to create Jira issues through the native Jira interface

Field	Description
`datasource`	Represents the document datasource
`id`	Unique identifier for the document
`body`	Content which will be used to populate the document body and its mime type
`allowedUsers`	List of users who will be able to view this document
`viewURL`	Document view url
`allowAnonymousAccess`	If set to true, anyone who is signed into Glean can view search results for the document
`allowAllDatasourceUsersAccess`	If set to true, all users of the datasource (as uploaded using the Identity APIs) can view this document
`customProperties`	List of name - value pairs used to populate additional facets

Get Started

Guides

Authentication

Datasources

Documents

Debugging

API Reference

Document Model