/* hack until mintlify supports deprecations */

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


@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: 0.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: 0.625rem 2rem;
  font-family:
    Polysans Neutral,
    sans-serif;
  font-size: 1.25rem;
  font-weight: 400;
  line-height: 1.4;
  text-decoration: none;
  transition: all 0.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 = [
  '/api-reference/actions/setup',
  '/api-reference/indexing/troubleshooting/get-user-count',
  '/api-reference/indexing/troubleshooting/get-document-count',
  '/api-reference/indexing/troubleshooting/get-document-upload-and-indexing-status',
  '/api-reference/indexing/people/bulk-index-employees-1',
  '/api-reference/client/answers/create-answer-board',
  '/api-reference/client/answers/delete-answer-board',
  '/api-reference/client/answers/update-answer-board',
  '/api-reference/client/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');
      const existingWarning = document.querySelector(
        '[data-callout-type="warning"]',
      );

      if (header && !existingWarning) {
        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 Beta Endpoint Callout
 *
 * Mintlify doesn't have any support for marking an endpoint as "beta".
 * This script adds a callout to beta endpoints.
 *************************************************************************/

const betaWarningText =
  'This endpoint is in Beta. Expect changes and instability.';
const betaPaths = [
  '/client/api/agents/retrieve-an-agent',
  '/client/api/agents/list-an-agents-schemas',
  '/client/api/agents/search-agents',
  '/client/api/agents/create-an-agent-run-and-stream-the-response',
  '/client/api/agents/create-an-agent-run-and-wait-for-the-response',
];

// Add callout warning for beta endpoints.
function addBetaWarning() {
  const canonicalLink = document.querySelector('head link[rel="canonical"]');

  if (canonicalLink) {
    const url = new URL(canonicalLink.href);

    if (betaPaths.some((path) => url.pathname.includes(path))) {
      const header = document.querySelector('header');
      const existingWarning = document.querySelector(
        '[data-callout-type="warning"]',
      );

      if (header && !existingWarning) {
        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">${betaWarningText}</div>`;
        header.insertAdjacentElement('afterend', warningDiv);
      }
    }
  }
}

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


Adds or updates multiple documents in the index. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#choosing-indexdocuments-vs-bulkindexdocuments) documentation for an explanation of when to use this endpoint.

Index documents

The document specific id for the comment. This field is case insensitive and should not be more than 200 characters in length.

Describes text content or base64 encoded binary content

base64 encoded binary content. Only one of textContent or binary content can be specified

text content. Only one of textContent or binary content can be specified

Describes the custom properties of the object.

Must either be a string or an array of strings. An integer, boolean, etc. is not valid. When OpenAPI Generator supports `oneOf`, we can semantically enforce this.

Additional variations of the URL that this document points to.

The container name for the content (Folder for example for file content).

This represents the datasource sepcific id of the container.

This represents the object type of the container. It cannot have spaces or _

Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/docs/facets_and_operators_for_custom_datasources/).

Source filename, in plain text, for the document. May be used as a fallback title for the document, if the title is not provided and cannot be extracted from the content. Populate this if there is no explicit title for the document and the content is sourced from a file.

The datasource specific id for the document. This field is case insensitive and should not be more than 200 characters in length.

The type of the document (Case, KnowledgeArticle for Salesforce for example). It cannot have spaces or _

The current owner of the document, if not the author.

The permissions that define who can view this document in the search results. Please refer to [this](https://developers.glean.com/docs/indexing_api_permissions/) for more details.

Document title, in plain text, if present. If not present, the title would be attempted to be extracted from the content.

The permalink for viewing the document. **Note: viewURL is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false).**'


describes the interactions on the document

describes the access control details of the document

If true, then any user who has an account in the datasource can view the document.

If true, then any Glean user can view the document

List of allowed group intersections. This describes a permissions constraint of the form ((GroupA AND GroupB AND GroupC) OR (GroupX AND GroupY) OR ...

List of groups that can view the document

describes a list of groups that are all required in a permissions constraint

Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id.

some datasources refer to the user by the datasource user id in the document

Describes the request body of the /indexdocuments API call

APIToken

The instance name (typically the email domain without the TLD) that determines the deployment backend.

Glean Developer Portal

Welcome

Glean Developer Platform

Change Log

Rate Limits

Overview

Rendering Search Results

People, Teams and Identity

Setup Datasource

Indexing Documents

Managing Tokens

Token Rotation

Custom Properties

Test Datasource

Activity

Permissions

Bulk Indexing

Bulk Upload Model

Document Model

Supported MIME Types

Datasource Config

Datasource Status

Datasource Document

Datasource User

Document Access

Document Count

OpenAPI Spec

Making Requests

Chat API

Simple Chatbot

Agentic AI With NVIDIA NIM

Build an Agentic AI With NVIDIA NIM and Glean

Filtering Results

Datasource Filters

Faceted Filtering

Governance APIs

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

Authentication

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

Get Started

Indexing

Client

Web SDK

Actions

Tools

Feedback

Index documents

Authorizations

Body

Response