curl --request POST \
  --url https://{domain}-be.glean.com/api/index/v1/bulkindexdocuments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "uploadId": "<string>",
  "isFirstPage": true,
  "isLastPage": true,
  "forceRestartUpload": true,
  "datasource": "<string>",
  "documents": [
    {
      "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>"
        }
      ]
    }
  ],
  "disableStaleDocumentDeletionCheck": true
}'

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Describes the request body of the /bulkindexdocuments API call

​
uploadId
string
required

Unique id that must be used for this bulk upload instance

​
datasource
string
required

Datasource of the documents

​
documents
object[]
required

Batch of documents for the datasource

Indexable document structure

​
isFirstPage
boolean

true if this is the first page of the upload. Defaults to false

​
isLastPage
boolean

true if this is the last page of the upload. Defaults to false

​
forceRestartUpload
boolean

Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true

​
disableStaleDocumentDeletionCheck
boolean

True if older documents need to be force deleted after the upload completes. Defaults to older documents being deleted asynchronously. This must only be set when isLastPage = true

Response

200

OK

Was this page helpful?

Suggest editsRaise issue