{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Advanced Model Configurations 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": "Advanced Model Configurations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Download the Specified Configuration File for the Model",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/models/:modelId/configs/:configurationType",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud organization"
              },
              {
                "name": "modelId",
                "value": "My_Model_ID",
                "type": "path",
                "description": "The unique identifier of the target model"
              },
              {
                "name": "configurationType",
                "value": "BLOCKLISTS",
                "type": "path",
                "description": "The type of advanced configuration file."
              },
              {
                "name": "languageCode",
                "value": "en",
                "type": "query",
                "description": "The language of the configuration file to retrieve. It must be an <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO 639-1 code</a>, or the string 'commons'"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "upload",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/models/:modelId/configs/:configurationType",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud organization"
              },
              {
                "name": "modelId",
                "value": "My_Model_ID",
                "type": "path",
                "description": "The unique identifier of the target model"
              },
              {
                "name": "configurationType",
                "value": "BLOCKLISTS",
                "type": "path",
                "description": "The type of advanced configuration file."
              },
              {
                "name": "languageCode",
                "value": "en",
                "type": "query",
                "description": "The language of the configuration file to retrieve. It must be an <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO 639-1 code</a>, or the string 'commons'"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "configFile",
                  "type": "text",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Upload configuration file for the model. Maximum file size allowed: 10 MB.<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Delete Configuration File for the Model.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/models/:modelId/configs/:configurationType",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud organization"
              },
              {
                "name": "modelId",
                "value": "My_Model_ID",
                "type": "path",
                "description": "The unique identifier of the target model"
              },
              {
                "name": "configurationType",
                "value": "BLOCKLISTS",
                "type": "path",
                "description": "The type of advanced configuration file."
              },
              {
                "name": "languageCode",
                "value": "en",
                "type": "query",
                "description": "The language of the configuration file to retrieve. Only required when the specified modelConfigFileType is language-specific (e.g., STOPWORDS), and ignored otherwise. If specified, must be an <a href=\"https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes\">ISO 639-1 code</a>, or the string 'commons'"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "List Advanced Registration Configuration Files for the Model",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/machinelearning/models/:modelId/configs/status",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Coveo Cloud organization"
              },
              {
                "name": "modelId",
                "value": "My_Model_ID",
                "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>"
        }
      ]
    }
  ],
  "bundled": true
}