Documents

Get document by URL

Changed on

Retrieve one permission-visible indexed document by URL. The url is the lookup key that Platform search returns. Many URLs can resolve to one document. The response is a single document, not a list. The returned url is the permalink and may differ from the submitted URL. Gmail and Outlook search results and chat citations carry caller-specific IDs that get document by ID cannot resolve, so retrieve them by URL here. A Gmail or Outlook URL that Platform search returned can still return 404, as it can with legacy getdocuments. Retrieving search results is best-effort parity with legacy getdocuments. Federated results and go-link shortcut documents are not retrievable in this release.

get/api/documents

Request

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

Query parameters

urlstring uri required

URL of the document to retrieve.

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