Sign in

ebd602e4aea4

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-1091438458.0 KB
Search

Recommend documents

Retrieve recommended documents for the given URL or Glean Document ID.

post/rest/api/v1/recommendations

Query parameters

localestring

The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Request body

timestampstring date-time

The ISO 8601 timestamp associated with the client request.

trackingTokenstring

A previously received trackingToken for a search associated with the same query. Useful for more requests and requests for other tabs.

pageSizeinteger

Hint to the server about how many results to send back. Server may return less or more. Structured results and clustered results don't count towards pageSize.

maxSnippetSizeinteger

Hint to the server about how many characters long a snippet may be. Server may return less or more.

Example request

{
  "sourceDocument": {
    "metadata": {
      "container": "container",
      "parentId": "JIRA_EN-1337",
      "createTime": "2000-01-23T04:56:07.000Z",
      "datasource": "datasource",
      "author": {
        "name": "name"
      },
      "documentId": "documentId",
      "updateTime": "2000-01-23T04:56:07.000Z",
      "mimeType": "mimeType",
      "objectType": "Feature Request",
      "components": [
        "Backend",
        "Networking"
      ],
      "status": "Done",
      "customData": {
        "someCustomField": {
          "stringValue": "someCustomValue"
        }
      }
    }
  },
  "pageSize": 100,
  "maxSnippetSize": 400,
  "requestOptions": {
    "facetFilterSets": [
      {
        "filters": [
          {
            "fieldName": "type",
            "values": [
              {
                "value": "Spreadsheet",
                "relationType": "EQUALS"
              },
              {
                "value": "Presentation",
                "relationType": "EQUALS"
              }
            ]
          }
        ]
      }
    ],
    "context": {
      "metadata": {
        "container": "container",
        "parentId": "JIRA_EN-1337",
        "createTime": "2000-01-23T04:56:07.000Z",
        "datasource": "datasource",
        "author": {
          "name": "name"
        },
        "documentId": "documentId",
        "updateTime": "2000-01-23T04:56:07.000Z",
        "mimeType": "mimeType",
        "objectType": "Feature Request",
        "components": [
          "Backend",
          "Networking"
        ],
        "status": "Done",
        "customData": {
          "someCustomField": {
            "stringValue": "someCustomValue"
          }
        }
      }
    }
  }
}

Response

OK

trackingTokenstring

A token that should be passed for additional requests related to this request (such as more results requests).

requestIDstring

A platform-generated request ID to correlate backend logs.

backendTimeMillisinteger

Time in milliseconds the backend took to respond to the request.