Documents

Get document by ID

Changed on

Retrieve one permission-visible indexed document by its Glean store ID. Gmail and Outlook search results and chat citations can carry caller-specific IDs that this operation cannot resolve. Try get document by URL for those documents. URL lookup does not resolve every Gmail or Outlook result.

get/api/documents/{document_id}

Request

  • Base URL: https://instance-name-be.glean.com
  • URL: https://instance-name-be.glean.com/api/documents/{document_id}
  • Auth: HTTP bearer

Path parameters

document_idstring required

Indexed Glean store ID. For a Gmail or Outlook citation with a caller-specific ID, try get document by URL instead.

Query parameters

includePlatformDocumentInclude[]

Optional field groups to add to each found document. Each value only adds fields; it does not change which documents are returned.

Response

Successful response.

request_idstring required

Platform-generated request ID for support correlation.

Changes