{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Machine Learning Models API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "authorization_code",
      "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
      "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Machine Learning Models",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View a Model",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/models/:modelId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud organization"
              },
              {
                "name": "modelId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target model"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update the Configuration of a Model",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/models/:modelId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud organization"
              },
              {
                "name": "modelId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target model"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Delete a Model",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/models/:modelId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud organization"
              },
              {
                "name": "modelId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target model"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Create a New Model",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/model",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud organization"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "List All Models",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/models",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud organization"
              },
              {
                "name": "engines",
                "value": "",
                "type": "query",
                "description": "A list of engine ids"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "getModelDetailsById",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/models/:modelId/details",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud organization"
              },
              {
                "name": "modelId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target model"
              }
            ]
          },
          "docs": "Get detailed information about a specific model<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get Detailed Information About All Models",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/models/details",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud organization"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Delete a Model",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/engines/:engineId/models/:modelName",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud organization"
              },
              {
                "name": "engineId",
                "value": "",
                "type": "path",
                "description": "The id of the engine"
              },
              {
                "name": "modelName",
                "value": "",
                "type": "path",
                "description": "The model name"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        }
      ]
    }
  ],
  "bundled": true
}