Action

Description

Required scopes

Report Activity

Report user activity on indexed documents such as views, edits and comments.

Report Feedback

Report an interaction with a Glean result such as a click, view or manual rating.

List Agents

List the agents available in the Glean instance, optionally filtered by name.

Get Agent

Retrieve the details of a single agent by ID.

Get Agent Schemas

Retrieve the input and output JSON schemas of an agent.

Run Agent

Run an agent and wait for the complete response.

Create Announcement

Create an announcement shown to a targeted set of users for a fixed period.

Update Announcement

Update an existing announcement.

Delete Announcement

Delete an announcement.

Get Answer

Read a single curated Answer.

Create Answer

Create a curated Answer holding a question and its answer.

Update Answer

Update an existing curated Answer.

Delete Answer

Delete a curated Answer.

Check Datasource Authorization

List the datasource instances still awaiting per-user OAuth authorization.

Create Authentication Token

Create a Web SDK authentication token for the current user.

Chat

Hold a conversation with Glean AI and wait for the complete answer.

Get Chat

Retrieve a saved Chat and its full conversation history.

List Chats

List the saved Chats belonging to the calling user.

Get Chat Application

Retrieve the details of a custom Chat application.

Get Chat Files

Retrieve metadata for files a user uploaded for Chat.

Delete Chats

Delete the given saved Chats and everything they contain.

Delete All Chats

Delete every saved Chat owned by the calling user.

Delete Chat Files

Delete files a user uploaded for Chat.

List Collections

List every Collection visible to the caller.

Get Collection

Retrieve a single Collection by ID.

Create Collection

Create an empty Collection.

Update Collection

Update the properties of an existing Collection.

Delete Collection

Delete one or more Collections by ID.

Add Collection Items

Add items to a Collection.

Update Collection Item

Update a single item inside a Collection.

Delete Collection Item

Remove a single item from a Collection.

Get Datasource Instance Configuration

Read the publicly exposed configuration values of a datasource instance.

Update Datasource Instance Configuration

Update the publicly exposed configuration values of a datasource instance.

Get Datasource Credential Status

Read the credential health of a datasource instance.

Rotate Datasource Credentials

Replace the credentials a datasource instance uses to reach its upstream system.

Get Document Permissions

Read the emails of everyone with access to a document.

Get Documents

Read documents and their metadata for a list of document IDs or URLs.

List Documents By Facets

Read documents and their metadata matching a set of facet conditions.

List Entities

List people, teams or custom entities matching the given filters and sort order.

Get People

Read people details for the given person IDs or email addresses.

List Data Loss Prevention Policies

List the data loss prevention policies configured on the instance.

Get Data Loss Prevention Policy

Retrieve a single data loss prevention policy.

Create Data Loss Prevention Policy

Create a data loss prevention policy and start scanning against it.

Update Data Loss Prevention Policy

Update an existing data loss prevention policy.

Create One Time Report

Create a one-time data loss prevention report and run it immediately.

Get Report Status

Check whether a data loss prevention report has finished running.

Get Document Visibility Overrides

Check whether documents are hidden from Glean results.

Set Document Visibility Overrides

Hide or unhide documents in Glean.

List Findings Exports

List the data loss prevention findings export jobs.

Create Findings Export

Start an export of data loss prevention findings.

Delete Findings Export

Delete a data loss prevention findings export.

Get Insights

Retrieve the aggregate usage insights shown in the Glean Insights dashboards.

List Messages

Retrieve messages from an indexed messaging datasource such as Slack or Microsoft Teams.

List Pins

List every pinned result in the instance.

Get Pin

Retrieve a single pin by ID.

Create Pin

Pin a document as a result for a set of search queries.

Update Pin

Update the queries or audience of an existing pin.

Delete Pin

Unpin a previously pinned result.

Retrieve results from the Glean index for a query and its filters.

Autocomplete

Retrieve query suggestions, operators and documents for a partially typed query.

Get Feed

Retrieve the personalized Glean feed for the calling user.

Get Recommendations

Retrieve documents recommended for a given URL or Glean document ID.

List Shortcuts

List the shortcuts the authenticated user owns or can edit.

Get Shortcut

Retrieve a single shortcut by ID or by alias.

Create Shortcut

Create a go link pointing an alias at a destination URL.

Update Shortcut

Update an existing go link.

Delete Shortcut

Delete a go link.

List Skills

List the skills available to the authenticated user.

Get Skill

Retrieve the metadata of a single skill by ID.

List Skill Versions

List the versions of a skill.

Get Skill Version

Retrieve the metadata of one version of a skill.

Preview Skill Source

Inspect a GitHub URL for skills without persisting anything.

Import Skills

Import one or more skills from resolved GitHub source URLs.

Update Skill

Update the mutable metadata of a skill.

Sync Skill

Refresh a GitHub-imported skill from its stored source URL.

Delete Skill

Delete a skill and all of its versions.

Summarize

Generate an AI summary of one or more indexed documents.

List Tools

List the tools available to the caller, optionally filtered by tool name.

Call Tool

Execute a tool with the supplied parameters.

Get Action Pack Auth Status

Check whether the caller is authenticated against the tool behind an action pack.

Authorize Action Pack

Start the third-party OAuth flow for an action pack.

Get Tool Server Auth Status

Check the caller's authentication status for a tool server.

Authorize Tool Server

Start the third-party OAuth flow for a tool server.

Get Tool Server Tools

Retrieve tool definitions by name from a tool server.

List Verifications

List the verification state of the documents the calling user owns.

Verify Document

Set the verification state of a document.

Add Verification Reminder

Create a verification reminder for a document.