{
  "info": {
    "_postman_id": "dd16705d-e878-4cf6-b172-49bf49fa6219",
    "name": "Coveo Activity Activities Smart Snippets 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:32:34.000Z",
    "updatedAt": "2026-07-28T01:32:34.000Z",
    "lastUpdatedBy": "35240",
    "uid": "35240-dd16705d-e878-4cf6-b172-49bf49fa6219"
  },
  "item": [
    {
      "name": "rest",
      "item": [
        {
          "name": "organizations",
          "item": [
            {
              "name": "{organizationId}",
              "item": [
                {
                  "name": "machinelearning",
                  "item": [
                    {
                      "name": "configuration",
                      "item": [
                        {
                          "name": "smartsnippets",
                          "item": [
                            {
                              "name": "preview",
                              "item": [
                                {
                                  "name": "Get Preview for Building an SS Model.",
                                  "id": "55e72023-c53f-4379-8b6d-6b3105905126",
                                  "protocolProfileBehavior": {
                                    "disableBodyPruning": true
                                  },
                                  "request": {
                                    "method": "POST",
                                    "header": [
                                      {
                                        "key": "Content-Type",
                                        "value": "application/json"
                                      },
                                      {
                                        "key": "Accept",
                                        "value": "*/*"
                                      }
                                    ],
                                    "body": {
                                      "mode": "raw",
                                      "raw": "{\n  \"sources\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"filterConditions\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"EQUALS\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"NOT_EQUALS\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"advancedQuery\": \"<string>\"\n}",
                                      "options": {
                                        "raw": {
                                          "headerFamily": "json",
                                          "language": "json"
                                        }
                                      }
                                    },
                                    "url": {
                                      "raw": "{{baseUrl}}/rest/organizations/:organizationId/machinelearning/configuration/smartsnippets/preview",
                                      "host": [
                                        "{{baseUrl}}"
                                      ],
                                      "path": [
                                        "rest",
                                        "organizations",
                                        ":organizationId",
                                        "machinelearning",
                                        "configuration",
                                        "smartsnippets",
                                        "preview"
                                      ],
                                      "variable": [
                                        {
                                          "id": "c51a8944-57ff-4427-bde6-082ec8c54a9f",
                                          "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 SS requirements are in the sources.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"ALLOW_CONTENT_PREVIEW\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n</details>"
                                  },
                                  "response": [
                                    {
                                      "id": "e08e24e9-55c6-4881-9e1c-c5f68d5db483",
                                      "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  \"sources\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"filterConditions\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"EQUALS\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"NOT_EQUALS\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"advancedQuery\": \"<string>\"\n}",
                                          "options": {
                                            "raw": {
                                              "headerFamily": "json",
                                              "language": "json"
                                            }
                                          }
                                        },
                                        "url": {
                                          "raw": "{{baseUrl}}/rest/organizations/:organizationId/machinelearning/configuration/smartsnippets/preview",
                                          "host": [
                                            "{{baseUrl}}"
                                          ],
                                          "path": [
                                            "rest",
                                            "organizations",
                                            ":organizationId",
                                            "machinelearning",
                                            "configuration",
                                            "smartsnippets",
                                            "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  \"documentRequirementStatus\": \"INSUFFICIENT_DOCUMENTS\"\n}",
                                      "createdAt": "2026-07-28T01:32:34.000Z",
                                      "updatedAt": "2026-07-28T01:32:34.000Z",
                                      "uid": "35240-e08e24e9-55c6-4881-9e1c-c5f68d5db483"
                                    }
                                  ],
                                  "createdAt": "2026-07-28T01:32:34.000Z",
                                  "updatedAt": "2026-07-28T01:32:34.000Z",
                                  "uid": "35240-55e72023-c53f-4379-8b6d-6b3105905126"
                                }
                              ],
                              "id": "64ef3fe4-7c45-4edf-b927-2b44563766ac",
                              "createdAt": "2026-07-28T01:32:34.000Z",
                              "updatedAt": "2026-07-28T01:32:34.000Z",
                              "uid": "35240-64ef3fe4-7c45-4edf-b927-2b44563766ac"
                            },
                            {
                              "name": "documenttypes",
                              "item": [
                                {
                                  "name": "Get SS Document Types",
                                  "id": "5a35460f-ff0c-418e-873a-f07aa9119e50",
                                  "protocolProfileBehavior": {
                                    "disableBodyPruning": true
                                  },
                                  "request": {
                                    "method": "POST",
                                    "header": [
                                      {
                                        "key": "Content-Type",
                                        "value": "application/json"
                                      },
                                      {
                                        "key": "Accept",
                                        "value": "*/*"
                                      }
                                    ],
                                    "body": {
                                      "mode": "raw",
                                      "raw": "{\n  \"sources\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"filterConditions\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"EQUALS\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"NOT_EQUALS\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"advancedQuery\": \"<string>\"\n}",
                                      "options": {
                                        "raw": {
                                          "headerFamily": "json",
                                          "language": "json"
                                        }
                                      }
                                    },
                                    "url": {
                                      "raw": "{{baseUrl}}/rest/organizations/:organizationId/machinelearning/configuration/smartsnippets/documenttypes",
                                      "host": [
                                        "{{baseUrl}}"
                                      ],
                                      "path": [
                                        "rest",
                                        "organizations",
                                        ":organizationId",
                                        "machinelearning",
                                        "configuration",
                                        "smartsnippets",
                                        "documenttypes"
                                      ],
                                      "variable": [
                                        {
                                          "id": "c1145ae7-891e-47fd-8a9e-98c141ed2be2",
                                          "key": "organizationId",
                                          "value": "<string>",
                                          "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
                                        }
                                      ]
                                    },
                                    "description": "Get the document types available for a Smart Snippets (SS) model to use.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"ALLOW_CONTENT_PREVIEW\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n</details>"
                                  },
                                  "response": [
                                    {
                                      "id": "e724c8a4-9e76-442e-b2d8-05c617183a13",
                                      "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  \"sources\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"filterConditions\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"EQUALS\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"NOT_EQUALS\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"advancedQuery\": \"<string>\"\n}",
                                          "options": {
                                            "raw": {
                                              "headerFamily": "json",
                                              "language": "json"
                                            }
                                          }
                                        },
                                        "url": {
                                          "raw": "{{baseUrl}}/rest/organizations/:organizationId/machinelearning/configuration/smartsnippets/documenttypes",
                                          "host": [
                                            "{{baseUrl}}"
                                          ],
                                          "path": [
                                            "rest",
                                            "organizations",
                                            ":organizationId",
                                            "machinelearning",
                                            "configuration",
                                            "smartsnippets",
                                            "documenttypes"
                                          ],
                                          "variable": [
                                            {
                                              "key": "organizationId"
                                            }
                                          ]
                                        }
                                      },
                                      "status": "OK",
                                      "code": 200,
                                      "_postman_previewlanguage": "text",
                                      "header": [
                                        {
                                          "key": "Content-Type",
                                          "value": "*/*"
                                        }
                                      ],
                                      "cookie": [],
                                      "responseTime": null,
                                      "body": "{\n  \"query\": \"<string>\",\n  \"documentTypes\": [\n    {\n      \"documentType\": \"<string>\"\n    },\n    {\n      \"documentType\": \"<string>\"\n    }\n  ]\n}",
                                      "createdAt": "2026-07-28T01:32:34.000Z",
                                      "updatedAt": "2026-07-28T01:32:34.000Z",
                                      "uid": "35240-e724c8a4-9e76-442e-b2d8-05c617183a13"
                                    }
                                  ],
                                  "createdAt": "2026-07-28T01:32:34.000Z",
                                  "updatedAt": "2026-07-28T01:32:34.000Z",
                                  "uid": "35240-5a35460f-ff0c-418e-873a-f07aa9119e50"
                                }
                              ],
                              "id": "599431c6-1958-4268-91c8-6d09db571b70",
                              "createdAt": "2026-07-28T01:32:34.000Z",
                              "updatedAt": "2026-07-28T01:32:34.000Z",
                              "uid": "35240-599431c6-1958-4268-91c8-6d09db571b70"
                            },
                            {
                              "name": "contentfields",
                              "item": [
                                {
                                  "name": "Get SS Content Fields",
                                  "id": "0e0341bc-88fe-42e9-a61a-28461e9e2e0c",
                                  "protocolProfileBehavior": {
                                    "disableBodyPruning": true
                                  },
                                  "request": {
                                    "method": "POST",
                                    "header": [
                                      {
                                        "key": "Content-Type",
                                        "value": "application/json"
                                      },
                                      {
                                        "key": "Accept",
                                        "value": "*/*"
                                      }
                                    ],
                                    "body": {
                                      "mode": "raw",
                                      "raw": "{\n  \"sources\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"filterConditions\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"EQUALS, NOT_EQUALS\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"EQUALS, NOT_EQUALS\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"advancedQuery\": \"<string>\",\n  \"documentType\": \"<string>\"\n}",
                                      "options": {
                                        "raw": {
                                          "headerFamily": "json",
                                          "language": "json"
                                        }
                                      }
                                    },
                                    "url": {
                                      "raw": "{{baseUrl}}/rest/organizations/:organizationId/machinelearning/configuration/smartsnippets/contentfields",
                                      "host": [
                                        "{{baseUrl}}"
                                      ],
                                      "path": [
                                        "rest",
                                        "organizations",
                                        ":organizationId",
                                        "machinelearning",
                                        "configuration",
                                        "smartsnippets",
                                        "contentfields"
                                      ],
                                      "variable": [
                                        {
                                          "id": "a97ed3a7-c0f1-4d73-bd25-7248ffab9175",
                                          "key": "organizationId",
                                          "value": "<string>",
                                          "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
                                        }
                                      ]
                                    },
                                    "description": "Get the content fields that a model can use for a given document type.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"ALLOW_CONTENT_PREVIEW\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n</details>"
                                  },
                                  "response": [
                                    {
                                      "id": "d0578ddb-bee9-4cab-9dde-802150558284",
                                      "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  \"sources\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"filterConditions\": [\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"EQUALS, NOT_EQUALS\",\n      \"value\": \"<string>\"\n    },\n    {\n      \"field\": \"<string>\",\n      \"operator\": \"EQUALS, NOT_EQUALS\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"advancedQuery\": \"<string>\",\n  \"documentType\": \"<string>\"\n}",
                                          "options": {
                                            "raw": {
                                              "headerFamily": "json",
                                              "language": "json"
                                            }
                                          }
                                        },
                                        "url": {
                                          "raw": "{{baseUrl}}/rest/organizations/:organizationId/machinelearning/configuration/smartsnippets/contentfields",
                                          "host": [
                                            "{{baseUrl}}"
                                          ],
                                          "path": [
                                            "rest",
                                            "organizations",
                                            ":organizationId",
                                            "machinelearning",
                                            "configuration",
                                            "smartsnippets",
                                            "contentfields"
                                          ],
                                          "variable": [
                                            {
                                              "key": "organizationId"
                                            }
                                          ]
                                        }
                                      },
                                      "status": "OK",
                                      "code": 200,
                                      "_postman_previewlanguage": "text",
                                      "header": [
                                        {
                                          "key": "Content-Type",
                                          "value": "*/*"
                                        }
                                      ],
                                      "cookie": [],
                                      "responseTime": null,
                                      "body": "{\n  \"query\": \"<string>\",\n  \"fields\": [\n    {\n      \"name\": \"<string>\"\n    },\n    {\n      \"name\": \"<string>\"\n    }\n  ]\n}",
                                      "createdAt": "2026-07-28T01:32:34.000Z",
                                      "updatedAt": "2026-07-28T01:32:34.000Z",
                                      "uid": "35240-d0578ddb-bee9-4cab-9dde-802150558284"
                                    }
                                  ],
                                  "createdAt": "2026-07-28T01:32:34.000Z",
                                  "updatedAt": "2026-07-28T01:32:34.000Z",
                                  "uid": "35240-0e0341bc-88fe-42e9-a61a-28461e9e2e0c"
                                }
                              ],
                              "id": "f84c49e7-73b2-40f1-be3a-282566167eaf",
                              "createdAt": "2026-07-28T01:32:34.000Z",
                              "updatedAt": "2026-07-28T01:32:34.000Z",
                              "uid": "35240-f84c49e7-73b2-40f1-be3a-282566167eaf"
                            }
                          ],
                          "id": "e16bbd06-0431-4a93-800a-4e9ebe224ff8",
                          "createdAt": "2026-07-28T01:32:34.000Z",
                          "updatedAt": "2026-07-28T01:32:34.000Z",
                          "uid": "35240-e16bbd06-0431-4a93-800a-4e9ebe224ff8"
                        }
                      ],
                      "id": "254774f9-7ed5-4970-ba33-701588a68729",
                      "createdAt": "2026-07-28T01:32:34.000Z",
                      "updatedAt": "2026-07-28T01:32:34.000Z",
                      "uid": "35240-254774f9-7ed5-4970-ba33-701588a68729"
                    }
                  ],
                  "id": "8346efcf-97db-4b49-8518-bd769c97e2f7",
                  "createdAt": "2026-07-28T01:32:34.000Z",
                  "updatedAt": "2026-07-28T01:32:34.000Z",
                  "uid": "35240-8346efcf-97db-4b49-8518-bd769c97e2f7"
                }
              ],
              "id": "01792cd8-ca28-4d19-a1c7-f35ee5b537ca",
              "createdAt": "2026-07-28T01:32:34.000Z",
              "updatedAt": "2026-07-28T01:32:34.000Z",
              "uid": "35240-01792cd8-ca28-4d19-a1c7-f35ee5b537ca"
            }
          ],
          "id": "73f85134-e34e-4859-8c77-76b7bcf6717a",
          "createdAt": "2026-07-28T01:32:34.000Z",
          "updatedAt": "2026-07-28T01:32:34.000Z",
          "uid": "35240-73f85134-e34e-4859-8c77-76b7bcf6717a"
        }
      ],
      "id": "b01dbfd1-67e0-4882-aeed-8193b016392a",
      "createdAt": "2026-07-28T01:32:34.000Z",
      "updatedAt": "2026-07-28T01:32:34.000Z",
      "uid": "35240-b01dbfd1-67e0-4882-aeed-8193b016392a"
    }
  ],
  "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"
    }
  ]
}