Indexing API
- Documents
- Permissions
- Troubleshooting
- Datasources
- Authentication
- People
- Shortcuts
Client API
- Activity
- Announcements
- Answers
- Authentication
- Calendar
- Chat
- Collections
- Displayable Lists
- Documents
- Images
- Insights
- Messages
- Pins
- Search
- Entities
- Shortcuts
- Summarize
- Tools
- User
- Verification
Actions API
- Authentication
- Setup
Documents
Index document
Documents
Index document
Adds a document to the index or updates an existing document.
POST
/
indexdocument
curl --request POST \
--url https://{domain}-be.glean.com/api/index/v1/indexdocument \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"version": 123,
"document": {
"title": "<string>",
"filename": "<string>",
"container": "<string>",
"containerDatasourceId": "<string>",
"containerObjectType": "<string>",
"datasource": "<string>",
"objectType": "<string>",
"viewURL": "<string>",
"id": "<string>",
"summary": {
"mimeType": "<string>",
"textContent": "<string>",
"binaryContent": "<string>"
},
"body": {
"mimeType": "<string>",
"textContent": "<string>",
"binaryContent": "<string>"
},
"author": {
"email": "<string>",
"datasourceUserId": "<string>",
"name": "<string>"
},
"owner": {
"email": "<string>",
"datasourceUserId": "<string>",
"name": "<string>"
},
"permissions": {
"allowedUsers": [
{
"email": "<string>",
"datasourceUserId": "<string>",
"name": "<string>"
}
],
"allowedGroups": [
"<string>"
],
"allowedGroupIntersections": [
{
"requiredGroups": [
"<string>"
]
}
],
"allowAnonymousAccess": true,
"allowAllDatasourceUsersAccess": true
},
"createdAt": 123,
"updatedAt": 123,
"updatedBy": {
"email": "<string>",
"datasourceUserId": "<string>",
"name": "<string>"
},
"tags": [
"<string>"
],
"interactions": {
"numViews": 123,
"numLikes": 123,
"numComments": 123
},
"status": "<string>",
"additionalUrls": [
"<string>"
],
"comments": [
{
"id": "<string>",
"author": {
"email": "<string>",
"datasourceUserId": "<string>",
"name": "<string>"
},
"content": {
"mimeType": "<string>",
"textContent": "<string>",
"binaryContent": "<string>"
},
"createdAt": 123,
"updatedAt": 123,
"updatedBy": {
"email": "<string>",
"datasourceUserId": "<string>",
"name": "<string>"
}
}
],
"customProperties": [
{
"name": "<string>",
"value": "<any>"
}
]
}
}'Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Describes the request body of the /indexdocument API call
Document being added/updated
Document title, in plain text, if present. If not present, the title would be attempted to be extracted from the content.
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 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 _
The type of the document (Case, KnowledgeArticle for Salesforce for example). It cannot have spaces or _
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).'
The datasource specific id for the document. This field is case insensitive and should not be more than 200 characters in length.
Describes text content or base64 encoded binary content
The permissions that define who can view this document in the search results. Please refer to this for more details.
List of users who can view the document
Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id.
List of groups that 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 ...
describes a list of groups that are all required in a permissions constraint
If true, then any Glean user can view the document
If true, then any user who has an account in the datasource can view the document.
The creation time, in epoch seconds.
The last update time, in epoch seconds.
Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id.
Labels associated with the document.
Additional variations of the URL that this document points to.
Comments associated with the document.
Describes a comment on a document
The document specific id for the comment. This field is case insensitive and should not be more than 200 characters in length.
The content of the comment.
text content. Only one of textContent or binary content can be specified
base64 encoded binary content. Only one of textContent or binary content can be specified
The creation time, in epoch seconds.
The last updated time, in epoch seconds.
Additional metadata properties of the document. These can surface as facets and operators.
Describes the custom properties of the object.
Version number for document for optimistic concurrency control. If absent or 0 then no version checks are done.
Response
200
_mintlify/placeholder
OK
Was this page helpful?
curl --request POST \
--url https://{domain}-be.glean.com/api/index/v1/indexdocument \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"version": 123,
"document": {
"title": "<string>",
"filename": "<string>",
"container": "<string>",
"containerDatasourceId": "<string>",
"containerObjectType": "<string>",
"datasource": "<string>",
"objectType": "<string>",
"viewURL": "<string>",
"id": "<string>",
"summary": {
"mimeType": "<string>",
"textContent": "<string>",
"binaryContent": "<string>"
},
"body": {
"mimeType": "<string>",
"textContent": "<string>",
"binaryContent": "<string>"
},
"author": {
"email": "<string>",
"datasourceUserId": "<string>",
"name": "<string>"
},
"owner": {
"email": "<string>",
"datasourceUserId": "<string>",
"name": "<string>"
},
"permissions": {
"allowedUsers": [
{
"email": "<string>",
"datasourceUserId": "<string>",
"name": "<string>"
}
],
"allowedGroups": [
"<string>"
],
"allowedGroupIntersections": [
{
"requiredGroups": [
"<string>"
]
}
],
"allowAnonymousAccess": true,
"allowAllDatasourceUsersAccess": true
},
"createdAt": 123,
"updatedAt": 123,
"updatedBy": {
"email": "<string>",
"datasourceUserId": "<string>",
"name": "<string>"
},
"tags": [
"<string>"
],
"interactions": {
"numViews": 123,
"numLikes": 123,
"numComments": 123
},
"status": "<string>",
"additionalUrls": [
"<string>"
],
"comments": [
{
"id": "<string>",
"author": {
"email": "<string>",
"datasourceUserId": "<string>",
"name": "<string>"
},
"content": {
"mimeType": "<string>",
"textContent": "<string>",
"binaryContent": "<string>"
},
"createdAt": 123,
"updatedAt": 123,
"updatedBy": {
"email": "<string>",
"datasourceUserId": "<string>",
"name": "<string>"
}
}
],
"customProperties": [
{
"name": "<string>",
"value": "<any>"
}
]
}
}'