{ "info": { "_postman_id": "3cb124b0-2185-44c6-84f5-7953e513b3c2", "name": "Coveo Activity Activities Machine learning associations 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:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "lastUpdatedBy": "35240", "uid": "35240-3cb124b0-2185-44c6-84f5-7953e513b3c2" }, "item": [ { "name": "rest", "item": [ { "name": "search", "item": [ { "name": "v2", "item": [ { "name": "admin", "item": [ { "name": "pipelines", "item": [ { "name": "{pipelineId}", "item": [ { "name": "ml", "item": [ { "name": "model", "item": [ { "name": "associations", "item": [ { "name": "{associationId}", "item": [ { "name": "position", "item": [ { "name": "Update ML Model Association Position", "id": "f0faf5c3-f60d-4e39-8eb6-634641af68c6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId/position?organizationId=&position=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId", "position" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "(Required) ", "key": "position", "value": "" } ], "variable": [ { "id": "fe16d16b-e382-49b5-9556-39aa70152235", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." }, { "id": "11795e02-95fe-443b-b68b-3f0f5e10f2b6", "key": "associationId", "value": "", "description": "(Required) " } ] }, "description": "Changes the position of an association in a pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "2532b486-2d09-42de-9648-7b384916c052", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId/position?organizationId=&position=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId", "position" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "(Required) ", "key": "position", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-2532b486-2d09-42de-9648-7b384916c052" }, { "id": "8bfa588c-2389-4092-be5a-1b37288cf877", "name": "No Content", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId/position?organizationId=&position=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId", "position" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "(Required) ", "key": "position", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-8bfa588c-2389-4092-be5a-1b37288cf877" }, { "id": "8e415bb8-945d-4630-b28a-1176b5f8da65", "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId/position?organizationId=&position=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId", "position" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "(Required) ", "key": "position", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-8e415bb8-945d-4630-b28a-1176b5f8da65" }, { "id": "fa07fee5-f64a-417f-8281-1b667463b62e", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId/position?organizationId=&position=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId", "position" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "(Required) ", "key": "position", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-fa07fee5-f64a-417f-8281-1b667463b62e" }, { "id": "04ba67c8-e458-4495-882c-529a4bddeaba", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId/position?organizationId=&position=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId", "position" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "(Required) ", "key": "position", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-04ba67c8-e458-4495-882c-529a4bddeaba" }, { "id": "e4d59210-2a11-49fe-b5fd-b068aca2d95f", "name": "Authentication Timeout", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId/position?organizationId=&position=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId", "position" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "(Required) ", "key": "position", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-e4d59210-2a11-49fe-b5fd-b068aca2d95f" }, { "id": "ad90e5db-1125-4f27-a190-4fb455cee6ca", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId/position?organizationId=&position=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId", "position" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "(Required) ", "key": "position", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-ad90e5db-1125-4f27-a190-4fb455cee6ca" } ], "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-f0faf5c3-f60d-4e39-8eb6-634641af68c6" } ], "id": "a5631cb3-227a-492d-9b0c-10a2c3a1a8bf", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-a5631cb3-227a-492d-9b0c-10a2c3a1a8bf" }, { "name": "Get a ML Model Association", "id": "122b3303-ff2e-46a2-b086-fbf9836e312d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "8d46cb9a-5045-4987-b945-db4921ec3b14", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." }, { "id": "226f8c60-cf8a-44bb-8df0-d8c901179510", "key": "associationId", "value": "", "description": "(Required) " } ] }, "description": "Gets a Coveo Machine Learning model association.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "58b92807-9eab-4092-aabb-f4698e33bf5d", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"position\": \"\",\n \"modelId\": \"\",\n \"modelStatus\": \"\",\n \"modelDisplayName\": \"\",\n \"modelEngine\": \"\",\n \"condition\": \"\",\n \"conditionDefinition\": \"\",\n \"rankingModifier\": \"\",\n \"maxRecommendations\": \"\",\n \"exclusive\": \"\",\n \"enableWordCompletion\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"\",\n \"intelligentTermDetectionPartialMatchKeywords\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"customQueryParameters\": {\n \"officia5\": -97955416.33949436,\n \"commodo_d82\": true,\n \"elit0\": \"ipsum nostrud sunt\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {},\n \"associatedGroup\": {},\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-58b92807-9eab-4092-aabb-f4698e33bf5d" }, { "id": "6a1e200a-f289-4cbe-81da-1ca9b55ba6f9", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-6a1e200a-f289-4cbe-81da-1ca9b55ba6f9" }, { "id": "18910fd3-1fcd-4111-9207-66f562e67822", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-18910fd3-1fcd-4111-9207-66f562e67822" }, { "id": "40b94b2c-1012-4a61-8e8a-12b3de7fb041", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-40b94b2c-1012-4a61-8e8a-12b3de7fb041" }, { "id": "6bad723f-fab2-4359-a178-f441089e4271", "name": "Authentication Timeout", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-6bad723f-fab2-4359-a178-f441089e4271" }, { "id": "7f438ac8-f040-4b01-8e3a-683acd2f75fc", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-7f438ac8-f040-4b01-8e3a-683acd2f75fc" } ], "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-122b3303-ff2e-46a2-b086-fbf9836e312d" }, { "name": "Update ML Model Association", "id": "2cadb4fc-52bf-4a2c-9b1d-e9d3ce6aaf27", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"laboris_33\": \"sint culpa\",\n \"culpa_0f\": 77749762\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "a876c9d3-5478-4cd7-8550-b21afeeb26ae", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." }, { "id": "fa002867-d05c-49fd-975f-587bb8028d5f", "key": "associationId", "value": "", "description": "(Required) " } ] }, "description": "Changes the configuration of an association in a pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "faeec3bd-e2b6-45fb-9b80-ad9105decfe7", "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"laboris_33\": \"sint culpa\",\n \"culpa_0f\": 77749762\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-faeec3bd-e2b6-45fb-9b80-ad9105decfe7" }, { "id": "550c9a69-9ee5-4765-89e0-7be2bb2113b0", "name": "No Content", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"laboris_33\": \"sint culpa\",\n \"culpa_0f\": 77749762\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-550c9a69-9ee5-4765-89e0-7be2bb2113b0" }, { "id": "b5c45c21-3e94-4372-9c19-1de7e94f3a59", "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"laboris_33\": \"sint culpa\",\n \"culpa_0f\": 77749762\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-b5c45c21-3e94-4372-9c19-1de7e94f3a59" }, { "id": "4d05328e-35e6-4f20-9e02-ba5450124e68", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"laboris_33\": \"sint culpa\",\n \"culpa_0f\": 77749762\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-4d05328e-35e6-4f20-9e02-ba5450124e68" }, { "id": "a8d0ea13-a480-454f-96a0-7300c1b3bd31", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"laboris_33\": \"sint culpa\",\n \"culpa_0f\": 77749762\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-a8d0ea13-a480-454f-96a0-7300c1b3bd31" }, { "id": "a0e3cfab-daf4-41ee-8e42-f96d532eaeff", "name": "Authentication Timeout", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"laboris_33\": \"sint culpa\",\n \"culpa_0f\": 77749762\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-a0e3cfab-daf4-41ee-8e42-f96d532eaeff" }, { "id": "87fc6dce-7526-46cc-97ef-244f27bb086b", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"laboris_33\": \"sint culpa\",\n \"culpa_0f\": 77749762\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-87fc6dce-7526-46cc-97ef-244f27bb086b" } ], "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-2cadb4fc-52bf-4a2c-9b1d-e9d3ce6aaf27" }, { "name": "Remove Query Pipeline ML Model Association", "id": "c533fa9d-05e3-4958-8a6d-014aae2a9efa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "94a1c6df-0a52-498f-8b99-579cea97a13b", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." }, { "id": "95fce9b9-b3a8-470d-b4d4-2d028039b9f7", "key": "associationId", "value": "", "description": "(Required) " } ] }, "description": "Removes a single existing association between a machine learning model and a query pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "8959b5dc-566d-4d2f-8cb2-102b51da95ac", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-8959b5dc-566d-4d2f-8cb2-102b51da95ac" }, { "id": "d6e5be49-9b70-46eb-92c5-544853027368", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-d6e5be49-9b70-46eb-92c5-544853027368" }, { "id": "1fd31484-5c8e-4acd-8d8b-861f52027f26", "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-1fd31484-5c8e-4acd-8d8b-861f52027f26" }, { "id": "7f2f222b-dd9c-42b4-b688-a2a0e61fdfc2", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-7f2f222b-dd9c-42b4-b688-a2a0e61fdfc2" }, { "id": "aa6b1ac3-1754-4a9b-8bd3-e111592a96af", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-aa6b1ac3-1754-4a9b-8bd3-e111592a96af" }, { "id": "5e854c60-e844-4900-8ef1-4fe0a4b8ce68", "name": "Authentication Timeout", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-5e854c60-e844-4900-8ef1-4fe0a4b8ce68" }, { "id": "549a32e3-d519-4e5f-833c-b6293111135c", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/:associationId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", ":associationId" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "associationId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-549a32e3-d519-4e5f-833c-b6293111135c" } ], "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-c533fa9d-05e3-4958-8a6d-014aae2a9efa" } ], "id": "31dcbeef-e1c9-4f3a-9f82-870639ba5837", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-31dcbeef-e1c9-4f3a-9f82-870639ba5837" }, { "name": "bulkGet", "item": [ { "name": "List Query Pipeline ML Model Associations", "id": "4dfdb8bd-145c-44df-9431-426628013dc6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/bulkGet?organizationId=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "id": "5053bdb6-c209-4734-bdde-18dbccdd8336", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Gets a page of Coveo Machine Learning model associations for a specific query pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "0fe605f3-e3c1-4da8-952a-7e3d074495df", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/bulkGet?organizationId=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"rules\": [\n {\n \"id\": \"\",\n \"position\": \"\",\n \"modelId\": \"\",\n \"modelStatus\": \"\",\n \"modelDisplayName\": \"\",\n \"modelEngine\": \"\",\n \"condition\": \"\",\n \"conditionDefinition\": \"\",\n \"rankingModifier\": \"\",\n \"maxRecommendations\": \"\",\n \"exclusive\": \"\",\n \"enableWordCompletion\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"\",\n \"intelligentTermDetectionPartialMatchKeywords\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"customQueryParameters\": {\n \"commodo_4ea\": true\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {},\n \"associatedGroup\": {},\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n {\n \"id\": \"\",\n \"position\": \"\",\n \"modelId\": \"\",\n \"modelStatus\": \"\",\n \"modelDisplayName\": \"\",\n \"modelEngine\": \"\",\n \"condition\": \"\",\n \"conditionDefinition\": \"\",\n \"rankingModifier\": \"\",\n \"maxRecommendations\": \"\",\n \"exclusive\": \"\",\n \"enableWordCompletion\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"\",\n \"intelligentTermDetectionPartialMatchKeywords\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"customQueryParameters\": {\n \"amet_0d\": \"quis\",\n \"dolore_4e\": -47473871\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {},\n \"associatedGroup\": {},\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n }\n ],\n \"totalEntries\": \"\",\n \"totalPages\": \"\"\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-0fe605f3-e3c1-4da8-952a-7e3d074495df" }, { "id": "8547459d-318a-48dd-9286-d581a39172c2", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/bulkGet?organizationId=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-8547459d-318a-48dd-9286-d581a39172c2" }, { "id": "055c7b43-d293-46a6-b844-eadeb13f8f07", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/bulkGet?organizationId=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-055c7b43-d293-46a6-b844-eadeb13f8f07" }, { "id": "70d66747-21b6-4122-a097-be13826c01dd", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/bulkGet?organizationId=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-70d66747-21b6-4122-a097-be13826c01dd" }, { "id": "57e611a8-7802-43fd-a1df-0f2a02983396", "name": "Authentication Timeout", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/bulkGet?organizationId=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "key": "pipelineId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-57e611a8-7802-43fd-a1df-0f2a02983396" }, { "id": "8e9a3735-bf31-413e-8a02-c747dada2924", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/bulkGet?organizationId=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "bulkGet" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-8e9a3735-bf31-413e-8a02-c747dada2924" } ], "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-4dfdb8bd-145c-44df-9431-426628013dc6" } ], "id": "213ee1e5-b7a8-48b8-892f-dd68969b1a0b", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-213ee1e5-b7a8-48b8-892f-dd68969b1a0b" }, { "name": "validate", "item": [ { "name": "batch", "item": [ { "name": "Validate a Batch of ML Model Association Operations.", "id": "c1273564-cedc-405b-bc19-678d9a554a85", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"ipsum73\": \"dolore cillum deserunt mollit\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"do_37a\": \"eu ad\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "94e47bbd-16f5-42d3-83cf-bfa764f0d3f9", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "\n Validate that a list of operations would be accepted by our API and executed.\n A maximum of 15 can be processed per request.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "1a2edd9e-603e-4bb6-b1e3-c3802d5dfcde", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"ipsum73\": \"dolore cillum deserunt mollit\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"do_37a\": \"eu ad\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"results\": [\n {\n \"operationType\": \"\",\n \"operationValid\": \"\",\n \"resourceId\": \"\",\n \"validationErrors\": {\n \"irurefb9\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"labore__f\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n }\n },\n {\n \"operationType\": \"\",\n \"operationValid\": \"\",\n \"resourceId\": \"\",\n \"validationErrors\": {\n \"ipsum7\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n }\n }\n ]\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-1a2edd9e-603e-4bb6-b1e3-c3802d5dfcde" }, { "id": "ec42454a-14e2-4a33-ab88-700fe4337d66", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"ipsum73\": \"dolore cillum deserunt mollit\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"do_37a\": \"eu ad\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-ec42454a-14e2-4a33-ab88-700fe4337d66" }, { "id": "6ca0b01c-f622-40a8-90c9-7ead4f572d99", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"ipsum73\": \"dolore cillum deserunt mollit\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"do_37a\": \"eu ad\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-6ca0b01c-f622-40a8-90c9-7ead4f572d99" }, { "id": "a659d2fb-a30b-4508-863e-1fc2b83e80aa", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"ipsum73\": \"dolore cillum deserunt mollit\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"do_37a\": \"eu ad\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-a659d2fb-a30b-4508-863e-1fc2b83e80aa" }, { "id": "3091ff2a-19c5-4f65-8b95-06eda5600d5a", "name": "Authentication Timeout", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"ipsum73\": \"dolore cillum deserunt mollit\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"do_37a\": \"eu ad\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-3091ff2a-19c5-4f65-8b95-06eda5600d5a" }, { "id": "d9c4fede-c09b-44d1-838c-e96bd3778afb", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"ipsum73\": \"dolore cillum deserunt mollit\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"do_37a\": \"eu ad\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-d9c4fede-c09b-44d1-838c-e96bd3778afb" }, { "id": "2f543a50-83b1-49a9-8e14-04fc179b7a0a", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"ipsum73\": \"dolore cillum deserunt mollit\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"do_37a\": \"eu ad\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-2f543a50-83b1-49a9-8e14-04fc179b7a0a" }, { "id": "bcf1f93f-defe-4039-a8df-a7c35e62e15f", "name": "Service Unavailable (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#5xx)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"ipsum73\": \"dolore cillum deserunt mollit\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"UPDATE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"do_37a\": \"eu ad\"\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "validate", "batch" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-bcf1f93f-defe-4039-a8df-a7c35e62e15f" } ], "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-c1273564-cedc-405b-bc19-678d9a554a85" } ], "id": "22b23aac-d415-4816-a9ed-f122af112d5c", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-22b23aac-d415-4816-a9ed-f122af112d5c" }, { "name": "Validate a Single ML Model Association Operation.", "id": "d1197198-55ac-4705-99f9-3d37a4119f60", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"non_43d\": false\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "8e359d54-94ed-4c3d-86d1-911e7c92a374", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Validate that a specific operation would be accepted by our API and executed.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "43b70ae5-05bf-4e95-9c56-4b03d03d5e70", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"non_43d\": false\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"operationType\": \"\",\n \"operationValid\": \"\",\n \"resourceId\": \"\",\n \"validationErrors\": {\n \"ullamco3d\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"Excepteur_4\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-43b70ae5-05bf-4e95-9c56-4b03d03d5e70" }, { "id": "24a6d08a-e060-4673-80db-64e972587575", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"non_43d\": false\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-24a6d08a-e060-4673-80db-64e972587575" }, { "id": "7b372b1e-d9fd-49af-bb69-04934ed2aa08", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"non_43d\": false\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-7b372b1e-d9fd-49af-bb69-04934ed2aa08" }, { "id": "f7136bc6-8978-4904-b84e-2821d71a6471", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"non_43d\": false\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-f7136bc6-8978-4904-b84e-2821d71a6471" }, { "id": "fe909d0a-90f5-4a9b-b306-1efbd94cd155", "name": "Authentication Timeout", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"non_43d\": false\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-fe909d0a-90f5-4a9b-b306-1efbd94cd155" }, { "id": "9a85ce91-9e70-47da-9633-dc23b91398cc", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"non_43d\": false\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-9a85ce91-9e70-47da-9633-dc23b91398cc" }, { "id": "fe858756-ddd5-436f-96b6-a03d1453070d", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"operation\": {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"non_43d\": false\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations", "validate" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-fe858756-ddd5-436f-96b6-a03d1453070d" } ], "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-d1197198-55ac-4705-99f9-3d37a4119f60" } ], "id": "0b6f665f-05f7-4ecf-8c5b-ad9377f0b2eb", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-0b6f665f-05f7-4ecf-8c5b-ad9377f0b2eb" }, { "name": "List Query Pipeline ML Model Associations", "id": "0bebe91b-8418-4a5f-ad26-c793d48fcbef", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations?organizationId=&page=0&perPage=20&filter=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "Filter associations by model display name or description (case-insensitive substring match).\n\nFor example, `filter=product` will match associations where the model display name or description contains \"product\".\n\nBy default, all associations are returned when no filter is specified.", "key": "filter", "value": "" } ], "variable": [ { "id": "4bdd0074-4372-4b8a-a3c6-bc6c3ebcbed7", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Gets a page of Coveo Machine Learning model associations for a specific query pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "ec782c0f-0ac7-4d42-b38e-d0ac1d88ea15", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations?organizationId=&page=0&perPage=20&filter=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "Filter associations by model display name or description (case-insensitive substring match).\n\nFor example, `filter=product` will match associations where the model display name or description contains \"product\".\n\nBy default, all associations are returned when no filter is specified.", "key": "filter", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"rules\": [\n {\n \"id\": \"\",\n \"position\": \"\",\n \"modelId\": \"\",\n \"modelStatus\": \"\",\n \"modelDisplayName\": \"\",\n \"modelEngine\": \"\",\n \"condition\": \"\",\n \"conditionDefinition\": \"\",\n \"rankingModifier\": \"\",\n \"maxRecommendations\": \"\",\n \"exclusive\": \"\",\n \"enableWordCompletion\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"\",\n \"intelligentTermDetectionPartialMatchKeywords\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"customQueryParameters\": {\n \"commodo_4ea\": true\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {},\n \"associatedGroup\": {},\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n },\n {\n \"id\": \"\",\n \"position\": \"\",\n \"modelId\": \"\",\n \"modelStatus\": \"\",\n \"modelDisplayName\": \"\",\n \"modelEngine\": \"\",\n \"condition\": \"\",\n \"conditionDefinition\": \"\",\n \"rankingModifier\": \"\",\n \"maxRecommendations\": \"\",\n \"exclusive\": \"\",\n \"enableWordCompletion\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"\",\n \"intelligentTermDetectionPartialMatchKeywords\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"customQueryParameters\": {\n \"amet_0d\": \"quis\",\n \"dolore_4e\": -47473871\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {},\n \"associatedGroup\": {},\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"description\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n }\n ],\n \"totalEntries\": \"\",\n \"totalPages\": \"\"\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-ec782c0f-0ac7-4d42-b38e-d0ac1d88ea15" }, { "id": "92099257-8165-42d2-8398-8a2802ec20bd", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations?organizationId=&page=0&perPage=20&filter=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "Filter associations by model display name or description (case-insensitive substring match).\n\nFor example, `filter=product` will match associations where the model display name or description contains \"product\".\n\nBy default, all associations are returned when no filter is specified.", "key": "filter", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-92099257-8165-42d2-8398-8a2802ec20bd" }, { "id": "19a03bb5-501f-469b-bad9-b0dfc6e7ecb7", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations?organizationId=&page=0&perPage=20&filter=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "Filter associations by model display name or description (case-insensitive substring match).\n\nFor example, `filter=product` will match associations where the model display name or description contains \"product\".\n\nBy default, all associations are returned when no filter is specified.", "key": "filter", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-19a03bb5-501f-469b-bad9-b0dfc6e7ecb7" }, { "id": "6f86c7d5-33ba-4979-accb-f404c48e6732", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations?organizationId=&page=0&perPage=20&filter=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "Filter associations by model display name or description (case-insensitive substring match).\n\nFor example, `filter=product` will match associations where the model display name or description contains \"product\".\n\nBy default, all associations are returned when no filter is specified.", "key": "filter", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-6f86c7d5-33ba-4979-accb-f404c48e6732" }, { "id": "6a25d3a2-0947-4b1c-8158-8df70c39dbef", "name": "Authentication Timeout", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations?organizationId=&page=0&perPage=20&filter=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "Filter associations by model display name or description (case-insensitive substring match).\n\nFor example, `filter=product` will match associations where the model display name or description contains \"product\".\n\nBy default, all associations are returned when no filter is specified.", "key": "filter", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-6a25d3a2-0947-4b1c-8158-8df70c39dbef" }, { "id": "8e3f3308-f354-4550-8c2b-df1d5401e037", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations?organizationId=&page=0&perPage=20&filter=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "Filter associations by model display name or description (case-insensitive substring match).\n\nFor example, `filter=product` will match associations where the model display name or description contains \"product\".\n\nBy default, all associations are returned when no filter is specified.", "key": "filter", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-8e3f3308-f354-4550-8c2b-df1d5401e037" } ], "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-0bebe91b-8418-4a5f-ad26-c793d48fcbef" }, { "name": "Associate an Existing Machine Learning Model with an Existing Pipeline.", "id": "f4afc3dd-72a7-44bf-80d3-2abedc7b2bf2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"enim7bc\": -6284460,\n \"qui_4\": true\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "id": "6aa69332-d18f-437b-a286-4b9e17099e86", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "db3bf53a-5c2b-448a-9a70-23c9f7d819bb", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"enim7bc\": -6284460,\n \"qui_4\": true\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-db3bf53a-5c2b-448a-9a70-23c9f7d819bb" }, { "id": "f7a0a618-04af-4428-96b9-74d78db41ff8", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"enim7bc\": -6284460,\n \"qui_4\": true\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-f7a0a618-04af-4428-96b9-74d78db41ff8" }, { "id": "14627646-1f80-4d71-a51f-954d92965e03", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"enim7bc\": -6284460,\n \"qui_4\": true\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-14627646-1f80-4d71-a51f-954d92965e03" }, { "id": "9b3808ec-e359-4f68-845c-68210ca219c1", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"enim7bc\": -6284460,\n \"qui_4\": true\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-9b3808ec-e359-4f68-845c-68210ca219c1" }, { "id": "141ea3d9-6ee1-4fb8-b903-c318c5af6a12", "name": "Authentication Timeout", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"enim7bc\": -6284460,\n \"qui_4\": true\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-141ea3d9-6ee1-4fb8-b903-c318c5af6a12" }, { "id": "cdb42cf4-e11f-4d71-bbb5-135dbb44d357", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"modelId\": \"\",\n \"rankingModifier\": \"\",\n \"matchBasicExpression\": \"\",\n \"matchAdvancedExpression\": \"\",\n \"intelligentTermDetection\": \"\",\n \"intelligentTermDetectionPartialMatchThreshold\": \"60%\",\n \"intelligentTermDetectionPartialMatchKeywords\": 1,\n \"condition\": \"\",\n \"maxRecommendations\": \"\",\n \"cacheMaximumAge\": \"\",\n \"enableWordCompletion\": \"\",\n \"description\": \"\",\n \"exclusive\": \"\",\n \"customQueryParameters\": {\n \"enim7bc\": -6284460,\n \"qui_4\": true\n },\n \"useAdvancedConfiguration\": \"\",\n \"dynamicNavigationExperience\": {\n \"automaticSelection\": {\n \"isEnabled\": true\n }\n },\n \"contentIdKeys\": [\n \"\",\n \"\"\n ],\n \"statementGroupId\": \"\",\n \"passageRetrieval\": {\n \"numberOfDocumentsToConsider\": 40\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/ml/model/associations?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "ml", "model", "associations" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-cdb42cf4-e11f-4d71-bbb5-135dbb44d357" } ], "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-f4afc3dd-72a7-44bf-80d3-2abedc7b2bf2" } ], "id": "f0b6d224-5b32-40d8-bc74-442820aa09ac", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-f0b6d224-5b32-40d8-bc74-442820aa09ac" } ], "id": "f1db2584-adb1-4c5c-9bc8-c9b204967a00", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-f1db2584-adb1-4c5c-9bc8-c9b204967a00" } ], "id": "40a14277-b9ce-4a1d-aa25-2122f0b98182", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-40a14277-b9ce-4a1d-aa25-2122f0b98182" } ], "id": "bd5c2a71-6a3c-414f-8534-e1326ac529b4", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-bd5c2a71-6a3c-414f-8534-e1326ac529b4" }, { "name": "ml", "item": [ { "name": "version", "item": [ { "name": "Returns the Version of ML Models Supported by the Organization in the Request.", "id": "b4beda68-2580-4eea-9e21-69c6af98d815", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/ml/version?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", "ml", "version" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] }, "description": "
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "b594a45c-8f5d-49cf-a950-9e7df22035a7", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/ml/version?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", "ml", "version" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-b594a45c-8f5d-49cf-a950-9e7df22035a7" }, { "id": "de9008f3-c4da-499c-870e-e510e26923ef", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/ml/version?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", "ml", "version" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-de9008f3-c4da-499c-870e-e510e26923ef" }, { "id": "28f36272-198c-42e9-a5f1-55616490c763", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/ml/version?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", "ml", "version" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-28f36272-198c-42e9-a5f1-55616490c763" }, { "id": "ad232af6-dadd-4dc9-b6e3-0ad7fcaf2f50", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/ml/version?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", "ml", "version" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-ad232af6-dadd-4dc9-b6e3-0ad7fcaf2f50" }, { "id": "457ebf70-d197-4dbe-a5b9-b089e40df1b0", "name": "Authentication Timeout", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/ml/version?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", "ml", "version" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-457ebf70-d197-4dbe-a5b9-b089e40df1b0" }, { "id": "4b1ab485-1c9e-45a3-858c-a1ed39cfc80f", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/ml/version?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", "ml", "version" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"consequat_8\": 10201719,\n \"veniam_33d\": -56955296.081401885,\n \"veniamf\": false,\n \"veniam08_\": -53994550\n}", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-4b1ab485-1c9e-45a3-858c-a1ed39cfc80f" } ], "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-b4beda68-2580-4eea-9e21-69c6af98d815" } ], "id": "71b5f8bf-4f65-473d-8f82-b40b00869d4e", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-71b5f8bf-4f65-473d-8f82-b40b00869d4e" } ], "id": "478ea73a-6011-48f8-ba51-d792ea2e3f92", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-478ea73a-6011-48f8-ba51-d792ea2e3f92" } ], "id": "d1ebccc4-ebaf-47b7-a9ba-b5269029e118", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-d1ebccc4-ebaf-47b7-a9ba-b5269029e118" } ], "id": "2438ed4a-e98d-42b7-b0fa-a30276ae5a7e", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-2438ed4a-e98d-42b7-b0fa-a30276ae5a7e" } ], "id": "bf5478b3-5db7-41f8-ab9e-4bdaaabfd825", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-bf5478b3-5db7-41f8-ab9e-4bdaaabfd825" } ], "id": "38104e81-a662-4ef3-9739-2fc19f3de1bb", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-38104e81-a662-4ef3-9739-2fc19f3de1bb" } ], "id": "8989f5ca-b7c2-466d-bc6e-eb8cd6479636", "createdAt": "2026-07-28T01:29:22.000Z", "updatedAt": "2026-07-28T01:29:22.000Z", "uid": "35240-8989f5ca-b7c2-466d-bc6e-eb8cd6479636" } ], "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" } ] }