Indexing API
- Documents
- Permissions
- Troubleshooting
- Datasources
- Authentication
- People
- Shortcuts
Client API
- Activity
- Announcements
- Answers
- Authentication
- Calendar
- Chat
- POSTDetect and answer questions
- POSTChat
- POSTDeletes all saved Chats owned by a user
- POSTDeletes saved Chats
- POSTRetrieves a Chat
- POSTRetrieves all saved Chats
- POSTGets the metadata for a custom Chat application
- POSTUpload files for Chat.
- POSTGet files uploaded by a user for Chat.
- POSTDelete files uploaded by a user for chat.
- POST
- Agents
- Collections
- Displayable Lists
- Documents
- Images
- Insights
- Messages
- Pins
- Search
- Entities
- Shortcuts
- Summarize
- Tools
- User
- Verification
Actions API
- Authentication
- Setup
Retrieves all saved Chats
Retrieves all the saved Chats between Glean Assistant and the user. The returned Chats contain only metadata and no conversational content.
curl --request POST \
--url https://{domain}-be.glean.com/rest/api/v1/listchats \
--header 'Authorization: Bearer <token>'{
"chatResults": [
{
"chat": {
"id": "<string>",
"createTime": 123,
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updateTime": 123,
"name": "<string>",
"applicationId": "<string>",
"applicationName": "<string>",
"icon": {
"color": "#343CED",
"key": "person_icon",
"iconType": "GLYPH",
"name": "user"
}
},
"trackingToken": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).
Auth type being used to access the endpoint (should be non-empty only for global tokens).
Query Parameters
The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
Response
Metadata of a Chat a user had with Glean Assistant. This contains no actual conversational content.
The opaque id of the Chat.
Server Unix timestamp of the creation time (in seconds since epoch UTC).
The user who created this Chat.
The display name.
An opaque identifier that can be used to request metadata for a Person.
A list of documents related to this person.
How this document relates to the including entity.
ATTACHMENT, CANONICAL, CASE, CONTACT, CONVERSATION_MESSAGES, EXPERT, FROM, HIGHLIGHT, OPPORTUNITY, RECENT, SOURCE, TICKET, TRANSCRIPT, WITH Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers)
{
"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
A truncated list of documents with this relation. TO BE DEPRECATED.
A truncated list of documents associated with this relation. To be used in favor of documents because it contains a trackingToken.
FULL_TIME, CONTRACTOR, NON_EMPLOYEE, FORMER_EMPLOYEE "FULL_TIME"
The first name of the person
The last name of the person
Job title.
Typically the highest level organizational unit; generally applies to bigger companies with multiple distinct businesses.
An organizational unit where everyone has a similar task, e.g. Engineering.
Info about the employee's team(s).
Use id if you index teams via Glean, and use name and externalLink if you want to use your own team pages
The number of people in this person's department.
The user's primary email address
Additional email addresses of this user beyond the primary, if any.
User facing string representing the person's location.
Detailed location with information about country, state, city etc.
Link to a customer's internal profile page. This is set to '#' when no link is desired.
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
The chain of reporting in the company as far up as it goes. The last entry is this person's direct manager.
Phone number as a number string.
The timezone of the person. E.g. "Pacific Daylight Time".
The offset of the person's timezone in seconds from UTC.
The URL of the person's avatar. Public, glean-authenticated and Base64 encoded data URLs are all valid (but not third-party-authenticated URLs).
The original photo URL of the person's avatar before any edits they made are applied
The URL of the person's banner photo.
The date when the employee started.
If a former employee, the last date of employment.
Short biography or mission statement of the employee.
She/her, He/his or other pronoun.
The total recursive size of the people reporting to this person, or 1
The total number of people who directly report to this person, or 0
The preferred name of the person, or a nickname.
List of social network profiles.
List of profiles this user has in different datasources / tools that they use.
List of people and distances to those people from this person. Optionally with metadata.
Information regarding the invite status of a person.
Whether the user has signed into Glean at least once.
The last time the user has used the Glean extension in ISO 8601 format.
Describes the permissions levels that a user has for permissioned features. When the client sends this, Permissions.read and Permissions.write are the additional permissions granted to a user on top of what they have via their roles. When the server sends this, Permissions.read and Permissions.write are the complete (merged) set of permissions the user has, and Permissions.roles is just for display purposes.
User customizable fields for additional people information.
The logging id of the person used in scrubbed logs, tracking GA metrics.
Percentage of the company that started strictly after this person. Between [0,100).
Intervals of busy time for this person, along with the type of event they're busy with.
A generic, light-weight calendar event.
flag settings to indicate user profile settings for certain items
The badges that a user has earned over their lifetime.
Displays a user's accomplishment or milestone
Whether this person is a "root" node in their organization's hierarchy.
{
"department": "Movies",
"email": "george@example.com",
"location": "Hollywood, CA",
"phone": 6505551234,
"photoUrl": "https://example.com/george.jpg",
"startDate": "2000-01-23",
"title": "Actor"
}
{
"name": "George Clooney",
"obfuscatedId": "abc123"
}
Server Unix timestamp of the update time (in seconds since epoch UTC).
The name of the Chat.
The ID of the AI App that this Chat is associated to.
The display name of the AI App that this Chat is associated to.
Defines how to render an icon
COLLECTION, CUSTOM, DATASOURCE, DATASOURCE_INSTANCE, FAVICON, FILE_TYPE, GENERATED_BACKGROUND, GLYPH, MIME_TYPE, NO_ICON, PERSON, REACTIONS, URL Whether the icon should be masked based on current theme.
The name of the icon if applicable, e.g. the glyph name for IconType.GLYPH icons.
The URL to an image to be displayed if applicable, e.g. the URL for iconType.URL icons.
{
"color": "#343CED",
"key": "person_icon",
"iconType": "GLYPH",
"name": "user"
}
An opaque token that represents this particular Chat. To be used for /feedback reporting.
curl --request POST \
--url https://{domain}-be.glean.com/rest/api/v1/listchats \
--header 'Authorization: Bearer <token>'{
"chatResults": [
{
"chat": {
"id": "<string>",
"createTime": 123,
"createdBy": {
"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updateTime": 123,
"name": "<string>",
"applicationId": "<string>",
"applicationName": "<string>",
"icon": {
"color": "#343CED",
"key": "person_icon",
"iconType": "GLYPH",
"name": "user"
}
},
"trackingToken": "<string>"
}
]
}