{
  "info": {
    "_postman_id": "4e85a816-8197-4152-8285-2c70c8d9ba28",
    "name": "Coveo Activity Activities Relevance Generative Answering Configuration API",
    "description": "API for Coveo Platform\n\nContact Support:\n Name: Coveo",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "createdAt": "2026-07-28T01:30:46.000Z",
    "updatedAt": "2026-07-28T01:30:46.000Z",
    "lastUpdatedBy": "35240",
    "uid": "35240-4e85a816-8197-4152-8285-2c70c8d9ba28"
  },
  "item": [
    {
      "name": "rest",
      "item": [
        {
          "name": "organizations",
          "item": [
            {
              "name": "{organizationId}",
              "item": [
                {
                  "name": "machinelearning",
                  "item": [
                    {
                      "name": "configuration",
                      "item": [
                        {
                          "name": "rga",
                          "item": [
                            {
                              "name": "preview",
                              "item": [
                                {
                                  "name": "Get Preview for Building an RGA Model",
                                  "id": "d943d533-9a8f-4239-9f3b-032cd0a42fc8",
                                  "protocolProfileBehavior": {
                                    "disableBodyPruning": true
                                  },
                                  "request": {
                                    "method": "POST",
                                    "header": [
                                      {
                                        "key": "Content-Type",
                                        "value": "application/json"
                                      },
                                      {
                                        "key": "Accept",
                                        "value": "*/*"
                                      }
                                    ],
                                    "body": {
                                      "mode": "raw",
                                      "raw": "{\n  \"advancedQuery\": \"<string>\",\n  \"sources\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"filterConditions\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"NOT_EQUALS\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"EQUALS\",\n      \"value\": \"<string>\"\n    }\n  ]\n}",
                                      "options": {
                                        "raw": {
                                          "headerFamily": "json",
                                          "language": "json"
                                        }
                                      }
                                    },
                                    "url": {
                                      "raw": "{{baseUrl}}/rest/organizations/:organizationId/machinelearning/configuration/rga/preview",
                                      "host": [
                                        "{{baseUrl}}"
                                      ],
                                      "path": [
                                        "rest",
                                        "organizations",
                                        ":organizationId",
                                        "machinelearning",
                                        "configuration",
                                        "rga",
                                        "preview"
                                      ],
                                      "variable": [
                                        {
                                          "id": "1ba674cd-5763-491f-a84d-82ada8f0d58e",
                                          "key": "organizationId",
                                          "value": "<string>",
                                          "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
                                        }
                                      ]
                                    },
                                    "description": "Show how many documents matching various RGA requirements are in the selection.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"ALLOW_CONTENT_PREVIEW\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n</details>"
                                  },
                                  "response": [
                                    {
                                      "id": "d05ba478-b982-429c-81be-2c567314f35f",
                                      "name": "OK",
                                      "originalRequest": {
                                        "method": "POST",
                                        "header": [
                                          {
                                            "key": "Content-Type",
                                            "value": "application/json"
                                          },
                                          {
                                            "key": "Accept",
                                            "value": "*/*"
                                          },
                                          {
                                            "description": "Added as a part of security scheme: oauth2",
                                            "key": "Authorization",
                                            "value": "<token>"
                                          }
                                        ],
                                        "body": {
                                          "mode": "raw",
                                          "raw": "{\n  \"advancedQuery\": \"<string>\",\n  \"sources\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"filterConditions\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"NOT_EQUALS\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"EQUALS\",\n      \"value\": \"<string>\"\n    }\n  ]\n}",
                                          "options": {
                                            "raw": {
                                              "headerFamily": "json",
                                              "language": "json"
                                            }
                                          }
                                        },
                                        "url": {
                                          "raw": "{{baseUrl}}/rest/organizations/:organizationId/machinelearning/configuration/rga/preview",
                                          "host": [
                                            "{{baseUrl}}"
                                          ],
                                          "path": [
                                            "rest",
                                            "organizations",
                                            ":organizationId",
                                            "machinelearning",
                                            "configuration",
                                            "rga",
                                            "preview"
                                          ],
                                          "variable": [
                                            {
                                              "key": "organizationId"
                                            }
                                          ]
                                        }
                                      },
                                      "status": "OK",
                                      "code": 200,
                                      "_postman_previewlanguage": "text",
                                      "header": [
                                        {
                                          "key": "Content-Type",
                                          "value": "*/*"
                                        }
                                      ],
                                      "cookie": [],
                                      "responseTime": null,
                                      "body": "{\n  \"query\": \"<string>\",\n  \"numberOfDocumentsInSources\": \"<long>\",\n  \"numberOfValidDocuments\": \"<long>\",\n  \"numberOfDocumentsInSourcesMatchingFilters\": \"<long>\",\n  \"numberOfDocumentsInSourcesMatchingFiltersWithPermanentId\": \"<long>\",\n  \"documentLimit\": \"<long>\",\n  \"documentRequirementStatus\": \"OK\"\n}",
                                      "createdAt": "2026-07-28T01:30:47.000Z",
                                      "updatedAt": "2026-07-28T01:30:47.000Z",
                                      "uid": "35240-d05ba478-b982-429c-81be-2c567314f35f"
                                    }
                                  ],
                                  "createdAt": "2026-07-28T01:30:47.000Z",
                                  "updatedAt": "2026-07-28T01:30:47.000Z",
                                  "uid": "35240-d943d533-9a8f-4239-9f3b-032cd0a42fc8"
                                }
                              ],
                              "id": "514f9c2c-4578-4b6f-87c2-73a095931146",
                              "createdAt": "2026-07-28T01:30:47.000Z",
                              "updatedAt": "2026-07-28T01:30:47.000Z",
                              "uid": "35240-514f9c2c-4578-4b6f-87c2-73a095931146"
                            }
                          ],
                          "id": "72f454fb-580a-4d38-b792-eba0e169fe31",
                          "createdAt": "2026-07-28T01:30:47.000Z",
                          "updatedAt": "2026-07-28T01:30:47.000Z",
                          "uid": "35240-72f454fb-580a-4d38-b792-eba0e169fe31"
                        }
                      ],
                      "id": "7bda6a7c-4525-485d-a187-a02a38c50593",
                      "createdAt": "2026-07-28T01:30:47.000Z",
                      "updatedAt": "2026-07-28T01:30:47.000Z",
                      "uid": "35240-7bda6a7c-4525-485d-a187-a02a38c50593"
                    }
                  ],
                  "id": "5997e5c9-f53a-4815-9c66-0ae80de61f2b",
                  "createdAt": "2026-07-28T01:30:47.000Z",
                  "updatedAt": "2026-07-28T01:30:47.000Z",
                  "uid": "35240-5997e5c9-f53a-4815-9c66-0ae80de61f2b"
                }
              ],
              "id": "c6a3033b-b3dd-498c-8fd2-4a93b8f51ee6",
              "createdAt": "2026-07-28T01:30:47.000Z",
              "updatedAt": "2026-07-28T01:30:47.000Z",
              "uid": "35240-c6a3033b-b3dd-498c-8fd2-4a93b8f51ee6"
            }
          ],
          "id": "4ae399ab-43d0-4668-8cb8-271fcdb11610",
          "createdAt": "2026-07-28T01:30:47.000Z",
          "updatedAt": "2026-07-28T01:30:47.000Z",
          "uid": "35240-4ae399ab-43d0-4668-8cb8-271fcdb11610"
        }
      ],
      "id": "aae308f4-665d-449c-9415-0de3d7f21306",
      "createdAt": "2026-07-28T01:30:47.000Z",
      "updatedAt": "2026-07-28T01:30:47.000Z",
      "uid": "35240-aae308f4-665d-449c-9415-0de3d7f21306"
    }
  ],
  "auth": {
    "type": "oauth2",
    "oauth2": [
      {
        "key": "scope",
        "value": "full",
        "type": "string"
      },
      {
        "key": "accessTokenUrl",
        "value": "https://platform.cloud.coveo.com/oauth/token",
        "type": "string"
      },
      {
        "key": "authUrl",
        "value": "https://platform.cloud.coveo.com/oauth/authorize",
        "type": "string"
      },
      {
        "key": "grant_type",
        "value": "authorization_code",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://platform.cloud.coveo.com"
    }
  ]
}