{ "info": { "_postman_id": "2f58db4e-5c4f-4f10-85e2-4e3307d41346", "name": "Coveo Activity Activities Advanced Model Configurations 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:26:38.000Z", "updatedAt": "2026-07-28T01:26:38.000Z", "lastUpdatedBy": "35240", "uid": "35240-2f58db4e-5c4f-4f10-85e2-4e3307d41346" }, "item": [ { "name": "rest", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "machinelearning", "item": [ { "name": "models", "item": [ { "name": "{modelId}", "item": [ { "name": "configs", "item": [ { "name": "{configurationType}", "item": [ { "name": "Download the Specified Configuration File for the Model", "id": "3f946f93-19b7-4479-bccc-7451b34fd9af", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/machinelearning/models/:modelId/configs/:configurationType?languageCode=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "machinelearning", "models", ":modelId", "configs", ":configurationType" ], "query": [ { "description": "The language of the configuration file to retrieve. It must be an ISO 639-1 code, or the string 'commons'", "key": "languageCode", "value": "" } ], "variable": [ { "id": "0d1be724-f80b-48c5-a9ae-673d29a6a31e", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization" }, { "id": "46e56752-55cb-4b9a-9d8c-89cf3cf87ac0", "key": "modelId", "value": "", "description": "(Required) The unique identifier of the target model" }, { "id": "7a8f5b57-ee9d-4b73-a5a7-c2bd6d8fe7e8", "key": "configurationType", "value": "ID_MAPPING", "description": "(Required) The type of advanced configuration file." } ] }, "description": "
Privilege required\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "19521415-dbbe-405f-ad58-7cb73bd6085d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/machinelearning/models/:modelId/configs/:configurationType?languageCode=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "machinelearning", "models", ":modelId", "configs", ":configurationType" ], "query": [ { "description": "The language of the configuration file to retrieve. It must be an ISO 639-1 code, or the string 'commons'", "key": "languageCode", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "modelId" }, { "key": "configurationType" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:26:39.000Z", "updatedAt": "2026-07-28T01:26:39.000Z", "uid": "35240-19521415-dbbe-405f-ad58-7cb73bd6085d" } ], "createdAt": "2026-07-28T01:26:39.000Z", "updatedAt": "2026-07-28T01:26:39.000Z", "uid": "35240-3f946f93-19b7-4479-bccc-7451b34fd9af" }, { "name": "upload", "id": "1e77c309-576e-4f6f-8218-c56c23f9bcf6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The configuration file to be uploaded.", "key": "configFile", "type": "file", "value": null } ] }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/machinelearning/models/:modelId/configs/:configurationType?languageCode=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "machinelearning", "models", ":modelId", "configs", ":configurationType" ], "query": [ { "description": "The language of the configuration file to retrieve. It must be an ISO 639-1 code, or the string 'commons'", "key": "languageCode", "value": "" } ], "variable": [ { "id": "0f48ed17-bfd7-47b8-8236-53b375e69a94", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization" }, { "id": "2b3e3d2b-1175-4e49-9d5a-b20b1280848b", "key": "modelId", "value": "", "description": "(Required) The unique identifier of the target model" }, { "id": "e5336e95-1c6c-4be7-a878-a6901b4b27a3", "key": "configurationType", "value": "ID_MAPPING", "description": "(Required) The type of advanced configuration file." } ] }, "description": "Upload configuration file for the model. Maximum file size allowed: 10 MB.

Privilege required\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "c9003cab-c762-4467-ae46-6809afbb53d5", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The configuration file to be uploaded.", "key": "configFile", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/machinelearning/models/:modelId/configs/:configurationType?languageCode=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "machinelearning", "models", ":modelId", "configs", ":configurationType" ], "query": [ { "description": "The language of the configuration file to retrieve. It must be an ISO 639-1 code, or the string 'commons'", "key": "languageCode", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "modelId" }, { "key": "configurationType" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"modelId\": {\n \"modelId\": \"\"\n },\n \"filePath\": {}\n}", "createdAt": "2026-07-28T01:26:39.000Z", "updatedAt": "2026-07-28T01:26:39.000Z", "uid": "35240-c9003cab-c762-4467-ae46-6809afbb53d5" } ], "createdAt": "2026-07-28T01:26:39.000Z", "updatedAt": "2026-07-28T01:26:39.000Z", "uid": "35240-1e77c309-576e-4f6f-8218-c56c23f9bcf6" }, { "name": "Delete Configuration File for the Model.", "id": "275e19ee-280a-463a-a64c-d1cacb50e242", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/machinelearning/models/:modelId/configs/:configurationType?languageCode=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "machinelearning", "models", ":modelId", "configs", ":configurationType" ], "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 ISO 639-1 code, or the string 'commons'", "key": "languageCode", "value": "" } ], "variable": [ { "id": "f885520a-e799-4244-8f46-61381d6087b1", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization" }, { "id": "675317f7-d5c9-4863-bf59-5d767fac3b9a", "key": "modelId", "value": "", "description": "(Required) The unique identifier of the target model" }, { "id": "47b869de-6f5f-4a1a-8d1f-d0a11dd134e6", "key": "configurationType", "value": "ID_MAPPING", "description": "(Required) The type of advanced configuration file." } ] }, "description": "
Privilege required\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "d745f219-3c4f-4a9a-9f86-f87e0096cd86", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/machinelearning/models/:modelId/configs/:configurationType?languageCode=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "machinelearning", "models", ":modelId", "configs", ":configurationType" ], "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 ISO 639-1 code, or the string 'commons'", "key": "languageCode", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "modelId" }, { "key": "configurationType" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:26:39.000Z", "updatedAt": "2026-07-28T01:26:39.000Z", "uid": "35240-d745f219-3c4f-4a9a-9f86-f87e0096cd86" } ], "createdAt": "2026-07-28T01:26:39.000Z", "updatedAt": "2026-07-28T01:26:39.000Z", "uid": "35240-275e19ee-280a-463a-a64c-d1cacb50e242" } ], "id": "6896d423-c28d-4354-afdf-f49d5e478523", "createdAt": "2026-07-28T01:26:39.000Z", "updatedAt": "2026-07-28T01:26:39.000Z", "uid": "35240-6896d423-c28d-4354-afdf-f49d5e478523" }, { "name": "status", "item": [ { "name": "List Advanced Registration Configuration Files for the Model", "id": "13d3908f-ae6f-42e4-ad40-fefc93eb0418", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/machinelearning/models/:modelId/configs/status", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "machinelearning", "models", ":modelId", "configs", "status" ], "variable": [ { "id": "c29ee69c-fb13-49d5-912d-e8b1dc506d9c", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target Coveo Cloud organization" }, { "id": "001a5780-4b3b-44a9-bc04-fd49aaf5d46d", "key": "modelId", "value": "", "description": "(Required) The unique identifier of the target model" } ] }, "description": "
Privilege required\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"MODELS\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "005a15ff-7a08-4a4a-b48c-92d4e499ba25", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/machinelearning/models/:modelId/configs/status", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "machinelearning", "models", ":modelId", "configs", "status" ], "variable": [ { "key": "organizationId" }, { "key": "modelId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"advancedRegistrationConfigFiles\": {\n \"amet8\": [\n {\n \"languageCode\": \"\",\n \"modifiedDate\": \"\",\n \"fileSizeInKb\": \"\",\n \"fileDisplayName\": \"\",\n \"md5Hash\": \"\"\n },\n {\n \"languageCode\": \"\",\n \"modifiedDate\": \"\",\n \"fileSizeInKb\": \"\",\n \"fileDisplayName\": \"\",\n \"md5Hash\": \"\"\n }\n ],\n \"sitd\": [\n {\n \"languageCode\": \"\",\n \"modifiedDate\": \"\",\n \"fileSizeInKb\": \"\",\n \"fileDisplayName\": \"\",\n \"md5Hash\": \"\"\n },\n {\n \"languageCode\": \"\",\n \"modifiedDate\": \"\",\n \"fileSizeInKb\": \"\",\n \"fileDisplayName\": \"\",\n \"md5Hash\": \"\"\n }\n ]\n },\n \"modelId\": {\n \"modelId\": \"\"\n },\n \"orgId\": {}\n}", "createdAt": "2026-07-28T01:26:39.000Z", "updatedAt": "2026-07-28T01:26:39.000Z", "uid": "35240-005a15ff-7a08-4a4a-b48c-92d4e499ba25" } ], "createdAt": "2026-07-28T01:26:39.000Z", "updatedAt": "2026-07-28T01:26:39.000Z", "uid": "35240-13d3908f-ae6f-42e4-ad40-fefc93eb0418" } ], "id": "ac8a5b24-0ea5-4938-ac5f-55c1602e5aec", "createdAt": "2026-07-28T01:26:39.000Z", "updatedAt": "2026-07-28T01:26:39.000Z", "uid": "35240-ac8a5b24-0ea5-4938-ac5f-55c1602e5aec" } ], "id": "b956e662-13f5-4621-b8c2-e1d709ac7c76", "createdAt": "2026-07-28T01:26:39.000Z", "updatedAt": "2026-07-28T01:26:39.000Z", "uid": "35240-b956e662-13f5-4621-b8c2-e1d709ac7c76" } ], "id": "897d3cf9-ff1f-4993-afc9-2b6adcb94f5b", "createdAt": "2026-07-28T01:26:39.000Z", "updatedAt": "2026-07-28T01:26:39.000Z", "uid": "35240-897d3cf9-ff1f-4993-afc9-2b6adcb94f5b" } ], "id": "5cb0c3c8-6a77-4950-a9ee-5f86464fe6e5", "createdAt": "2026-07-28T01:26:39.000Z", "updatedAt": "2026-07-28T01:26:39.000Z", "uid": "35240-5cb0c3c8-6a77-4950-a9ee-5f86464fe6e5" } ], "id": "89ba935f-2f04-495b-a60e-a0fd230007cf", "createdAt": "2026-07-28T01:26:39.000Z", "updatedAt": "2026-07-28T01:26:39.000Z", "uid": "35240-89ba935f-2f04-495b-a60e-a0fd230007cf" } ], "id": "492383f1-0cfd-4387-8e84-323e908e4d72", "createdAt": "2026-07-28T01:26:39.000Z", "updatedAt": "2026-07-28T01:26:39.000Z", "uid": "35240-492383f1-0cfd-4387-8e84-323e908e4d72" } ], "id": "fc3f7d3f-a6f8-4d4c-a5d2-407168c89188", "createdAt": "2026-07-28T01:26:39.000Z", "updatedAt": "2026-07-28T01:26:39.000Z", "uid": "35240-fc3f7d3f-a6f8-4d4c-a5d2-407168c89188" } ], "id": "43fa6816-da2f-416d-a22c-aacd04af6580", "createdAt": "2026-07-28T01:26:39.000Z", "updatedAt": "2026-07-28T01:26:39.000Z", "uid": "35240-43fa6816-da2f-416d-a22c-aacd04af6580" } ], "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" } ] }