> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Glean

> How to set up the Glean connector, plus the actions that are available.

![Glean](https://stackone-logos.com/api/glean/filled/svg)

Previewv0.2.0[See changelog](https://docs.stackone.com/connectors/glean/changelog.md)

[87 actions](#actions) · 3 auth methods

Knowledge Management
AI

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/glean/guides/connector-profile/api-key.md)
>
> Uses a Glean-issued API token created in the Admin Console under Platform then Client API Token Settings, with the scope...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/glean/guides/connector-profile/oauth-2-0.md)
>
> Use this if everyone connecting works at your company. An admin sets the Instance Name once on the connector profile, an...

> [card] [OAuth 2.0 (Multiple Companies) · Connector Profile](https://docs.stackone.com/connectors/glean/guides/connector-profile/oauth-2-0-multiple-companies.md)
>
> Use this if you connect accounts from different companies, such as your customers. Each account enters its own Instance...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/glean/guides/link-account/api-key.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/glean/guides/link-account/oauth-2-0.md)

> [card] [OAuth 2.0 (Multiple Companies) · Link Account](https://docs.stackone.com/connectors/glean/guides/link-account/oauth-2-0-multiple-companies.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

OAuth 2.0 (Multiple Companies)

No auth methods found

Scopes

Select all
|
Clear

activity

admin

agents

announcements

answers

auth\_token\_creator

chat

collections

content\_hiding

data\_governance

docpermissions

documents

entities

feed

feedback

insights

people

pins

search

shortcuts

skills

summarize

tools

verification

No scopes found

87 actions

ActionDescriptionRequired scopes

Report Activity`glean_report_activity`

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

`activity`

Report Feedback`glean_report_feedback`

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

`feedback`

List Agents`glean_list_agents`

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

`agents`

Get Agent`glean_get_agent`

Retrieve the details of a single agent by ID.

`agents`

Get Agent Schemas`glean_get_agent_schemas`

Retrieve the input and output JSON schemas of an agent.

`agents`

Run Agent`glean_run_agent`

Run an agent and wait for the complete response.

`agents`

Create Announcement`glean_create_announcement`

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

`announcements`

Update Announcement`glean_update_announcement`

Update an existing announcement.

`announcements`

Delete Announcement`glean_delete_announcement`

Delete an announcement.

`announcements`

Get Answer`glean_get_answer`

Read a single curated Answer.

`answers`

Create Answer`glean_create_answer`

Create a curated Answer holding a question and its answer.

`answers`

Update Answer`glean_update_answer`

Update an existing curated Answer.

`answers`

Delete Answer`glean_delete_answer`

Delete a curated Answer.

`answers`

Check Datasource Authorization`glean_check_datasource_auth`

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

`auth_token_creator`

Create Authentication Token`glean_create_auth_token`

Create a Web SDK authentication token for the current user.

`auth_token_creator`

Chat`glean_chat`

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

`chat`

Get Chat`glean_get_chat`

Retrieve a saved Chat and its full conversation history.

`chat`

List Chats`glean_list_chats`

List the saved Chats belonging to the calling user.

`chat`

Get Chat Application`glean_get_chat_application`

Retrieve the details of a custom Chat application.

`chat`

Get Chat Files`glean_get_chat_files`

Retrieve metadata for files a user uploaded for Chat.

`chat`

Delete Chats`glean_delete_chats`

Delete the given saved Chats and everything they contain.

`chat`

Delete All Chats`glean_delete_all_chats`

Delete every saved Chat owned by the calling user.

`chat`

Delete Chat Files`glean_delete_chat_files`

Delete files a user uploaded for Chat.

`chat`

List Collections`glean_list_collections`

List every Collection visible to the caller.

`collections`

Get Collection`glean_get_collection`

Retrieve a single Collection by ID.

`collections`

Create Collection`glean_create_collection`

Create an empty Collection.

`collections`

Update Collection`glean_update_collection`

Update the properties of an existing Collection.

`collections`

Delete Collection`glean_delete_collection`

Delete one or more Collections by ID.

`collections`

Add Collection Items`glean_add_collection_items`

Add items to a Collection.

`collections`

Update Collection Item`glean_update_collection_item`

Update a single item inside a Collection.

`collections`

Delete Collection Item`glean_delete_collection_item`

Remove a single item from a Collection.

`collections`

Get Datasource Instance Configuration`glean_get_datasource_instance_configuration`

Read the publicly exposed configuration values of a datasource instance.

`admin`

Update Datasource Instance Configuration`glean_update_datasource_instance_configuration`

Update the publicly exposed configuration values of a datasource instance.

`admin`

Get Datasource Credential Status`glean_get_datasource_credential_status`

Read the credential health of a datasource instance.

`admin`

Rotate Datasource Credentials`glean_rotate_datasource_credentials`

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

`admin`

Get Document Permissions`glean_get_document_permissions`

Read the emails of everyone with access to a document.

`docpermissions`

Get Documents`glean_get_documents`

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

`documents`

List Documents By Facets`glean_list_documents_by_facets`

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

`documents`

List Entities`glean_list_entities`

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

`entities`

Get People`glean_get_people`

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

`people`

List Data Loss Prevention Policies`glean_list_policies`

List the data loss prevention policies configured on the instance.

`data_governance`

Get Data Loss Prevention Policy`glean_get_policy`

Retrieve a single data loss prevention policy.

`data_governance`

Create Data Loss Prevention Policy`glean_create_policy`

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

`data_governance`

Update Data Loss Prevention Policy`glean_update_policy`

Update an existing data loss prevention policy.

`data_governance`

Create One Time Report`glean_create_report`

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

`data_governance`

Get Report Status`glean_get_report_status`

Check whether a data loss prevention report has finished running.

`data_governance`

Get Document Visibility Overrides`glean_get_document_visibility`

Check whether documents are hidden from Glean results.

`content_hiding`

Set Document Visibility Overrides`glean_set_document_visibility`

Hide or unhide documents in Glean.

`content_hiding`

List Findings Exports`glean_list_findings_exports`

List the data loss prevention findings export jobs.

`data_governance`

Create Findings Export`glean_create_findings_export`

Start an export of data loss prevention findings.

`data_governance`

Delete Findings Export`glean_delete_findings_export`

Delete a data loss prevention findings export.

`data_governance`

Get Insights`glean_get_insights`

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

`insights`

List Messages`glean_list_messages`

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

List Pins`glean_list_pins`

List every pinned result in the instance.

`pins`

Get Pin`glean_get_pin`

Retrieve a single pin by ID.

`pins`

Create Pin`glean_create_pin`

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

`pins`

Update Pin`glean_update_pin`

Update the queries or audience of an existing pin.

`pins`

Delete Pin`glean_delete_pin`

Unpin a previously pinned result.

`pins`

Search`glean_search`

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

`search`

Autocomplete`glean_autocomplete`

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

`search`

Get Feed`glean_get_feed`

Retrieve the personalized Glean feed for the calling user.

`feed`

Get Recommendations`glean_get_recommendations`

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

`search`

List Shortcuts`glean_list_shortcuts`

List the shortcuts the authenticated user owns or can edit.

`shortcuts`

Get Shortcut`glean_get_shortcut`

Retrieve a single shortcut by ID or by alias.

`shortcuts`

Create Shortcut`glean_create_shortcut`

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

`shortcuts`

Update Shortcut`glean_update_shortcut`

Update an existing go link.

`shortcuts`

Delete Shortcut`glean_delete_shortcut`

Delete a go link.

`shortcuts`

List Skills`glean_list_skills`

List the skills available to the authenticated user.

`skills`

Get Skill`glean_get_skill`

Retrieve the metadata of a single skill by ID.

`skills`

List Skill Versions`glean_list_skill_versions`

List the versions of a skill.

`skills`

Get Skill Version`glean_get_skill_version`

Retrieve the metadata of one version of a skill.

`skills`

Preview Skill Source`glean_preview_skill_source`

Inspect a GitHub URL for skills without persisting anything.

`skills`

Import Skills`glean_import_skills`

Import one or more skills from resolved GitHub source URLs.

`skills`

Update Skill`glean_update_skill`

Update the mutable metadata of a skill.

`skills`

Sync Skill`glean_sync_skill`

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

`skills`

Delete Skill`glean_delete_skill`

Delete a skill and all of its versions.

`skills`

Summarize`glean_summarize`

Generate an AI summary of one or more indexed documents.

`summarize`

List Tools`glean_list_tools`

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

`tools`

Call Tool`glean_call_tool`

Execute a tool with the supplied parameters.

`tools`

Get Action Pack Auth Status`glean_get_action_pack_auth_status`

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

`tools`

Authorize Action Pack`glean_authorize_action_pack`

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

`tools`

Get Tool Server Auth Status`glean_get_tool_server_auth_status`

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

`tools`

Authorize Tool Server`glean_authorize_tool_server`

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

`tools`

Get Tool Server Tools`glean_get_tool_server_tools`

Retrieve tool definitions by name from a tool server.

`tools`

List Verifications`glean_list_verifications`

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

`verification`

Verify Document`glean_verify_document`

Set the verification state of a document.

`verification`

Add Verification Reminder`glean_add_verification_reminder`

Create a verification reminder for a document.

`verification`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.