Newer Version Available

This content describes an older version of this product. View Latest

Check Library Status

Returns current library status derived from the SearchIndex runtime with per-stage detail. Use for polling after provisioning or re-provisioning. Suggested polling interval: 5–30 seconds.

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 Map of per-stage status details. 66.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

HTTP 404—Library not found.