Check Library Status

Resource

1/einstein/data-libraries/libraryId/status

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

HTTP Methods

GET

Request body

None.

Response body

HTTP 200—LibraryStatusOutputRepresentation

Property	Type	Description	Available Version
indexingStatus	object	ProvisionStatusOutputRepresentation.	66.0

ProvisionStatusOutputRepresentation has these fields.

Property	Type	Description	Available Version
libraryId	string	Library ID.	66.0
status	string	Overall status (LibraryStatusEnum): READY, IN_PROGRESS, FAILED, UNKNOWN, INCOMPLETE, or NO_SOURCES.	66.0
currentStage	string	Current stage (GroundingSourceStageEnum). Values are DATA_STREAM, FILE_MIGRATION, DATA_LAKE_OBJECT, DATA_MODEL_OBJECT, SEARCH_INDEX, RETRIEVER.	66.0
stages	object	Deprecated. Use stageDetails instead. Map of per-stage status details.	66.0
stageDetails	array	Ordered array of StageDetail objects (execution order).	67.0
lastUpdatedAt	integer (int64)	Last update time (Unix epoch milliseconds).	66.0

Here’s more information on the status values.

Status	Description	When It Appears
READY	Library is fully indexed and available for RAG queries	SearchIndex reports READY (all chunking and embedding is complete)
IN_PROGRESS	Provisioning or indexing is underway	During Data 360 resource creation or SearchIndex processing
FAILED	Provisioning or indexing failed	Any stage fails or SearchIndex reports failure
INCOMPLETE	Partial indexing—some files processed, some failed	SearchIndex reports INCOMPLETE
UNKNOWN	Status not yet available	Before provisioning starts or the retriever doesn’t exist yet
NO_SOURCES	Library has no grounding source configured	Library created without a groundingSource

Each StageDetail has these fields.

Property	Type	Description	Available Version
name	string	Stage name (for example, DATA_LAKE_OBJECT, SEARCH_INDEX).	67.0
status	string	SUCCESS, IN_PROGRESS, FAILED, or SCHEDULED.	67.0
completedAt	integer (int64)	Completion timestamp (Unix epoch milliseconds). Present only when status is SUCCESS.	67.0
startedAt	integer (int64)	Start timestamp (Unix epoch milliseconds). Present only when status is IN_PROGRESS.	67.0
error	string	Error message. Present only when status is FAILED.	67.0

HTTP 404—Library not found.