Index Library Resources

Starts asynchronous indexing of Data Cloud resources (DLO, DMO, SearchIndex, Retriever).

Resource

1/einstein/data-libraries/libraryId/indexing

The libraryId is the 18 character library ID that has a prefix of 1JD.

Poll /einstein/data-libraries/{libraryId}/status for progress.

You can provision SFDRIVE libraries only with this endpoint. RETRIEVER libraries don’t need indexing. Attempting to provision a KNOWLEDGE or RETRIEVER library returns 400.

Note

HTTP Methods

POST

Request body

Required (body must be present). ProvisionInputRepresentation

Property	Type	Description	Available Version
`uploadedFiles`	array	`UploadedFileInfoInputRepresentation` entries. Required for SFDRIVE to confirm uploads.	`66.0`

SFDRIVE: uploadedFiles must list uploaded files (paths and sizes).
The library must be upload-ready before calling this endpoint. Poll /einstein/data-libraries/{libraryId}/upload-readiness first.
Calling /einstein/data-libraries/{libraryId}/indexing before readiness returns 400 with "Library isn’t upload-ready yet."

Response body

HTTP 200—ProvisionOutputRepresentation (polymorphic)

Property	Type	Description	Available Version
`libraryId`	string	Library ID.	`66.0`
`sourceType`	string	Discriminator: `SFDRIVE` or `KNOWLEDGE`.	`66.0`
`status`	string	Indexing status (`LibraryStatusEnum`). `READY`, `IN_PROGRESS`, `FAILED`, `UNKNOWN`, `INCOMPLETE`, or `NO_SOURCES`.	`66.0`
`message`	string	Human-readable message.	`66.0`
`filesAccepted`	integer	Present only for `FileProvisionOutputRepresentation` (`sourceType=SFDRIVE`).	`66.0`

HTTP 400—Invalid request (for example, SFDRIVE without uploaded files).

HTTP 404—Library not found.

Connect REST API Developer Guide

Index Library Resources

Resource

HTTP Methods