{ "info": { "_postman_id": "1906a50f-2bc5-49da-8bd6-2f0f591b34b2", "name": "Coveo Activity Activities Agent Orchestration API API", "description": "API for Coveo Platform\n\nContact Support:\n Name: Coveo", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:26:40.000Z", "updatedAt": "2026-07-28T01:26:40.000Z", "lastUpdatedBy": "35240", "uid": "35240-1906a50f-2bc5-49da-8bd6-2f0f591b34b2" }, "item": [ { "name": "api", "item": [ { "name": "preview", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "agents", "item": [ { "name": "{agentId}", "item": [ { "name": "follow-up", "item": [ { "name": "Generates an Answer to the Follow-Up Question for the Given Configuration", "id": "72855cc9-9f92-4758-a1bd-43069a62e973", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/event-stream" } ], "body": { "mode": "raw", "raw": "{\n \"conversationId\": \"\",\n \"conversationToken\": \"\",\n \"q\": \"\",\n \"analytics\": {\n \"capture\": \"\",\n \"trackingId\": \"o2PGX\",\n \"clientId\": \"\",\n \"documentLocation\": \"\",\n \"documentReferrer\": \"\",\n \"pageId\": \"\",\n \"userIp\": \"\",\n \"clientRequestId\": \"\",\n \"clientTimestamp\": \"5122-43-11T00:06:19.316Z\",\n \"userAgent\": \"\",\n \"actionCause\": \"\",\n \"originContext\": \"\",\n \"customData\": {\n \"consequat_4\": {}\n },\n \"configId\": \"a2a3b63b-d454-f8a7-d8c5-fd4f15f5b298\",\n \"source\": [\n \"j>-)}~tL;\\\\@|tTd\",\n \"*FMw)@Hke\",\n \"[T@bunG(S!\\\"\",\n \"X@Pn\",\n \"(Miv=BLcRa@Q\",\n \"?Wt!z?@a\",\n \"/n]=.jpV@`|?3\",\n \"pRXzNK@_s]52oDk\",\n \"!tggl@j0>%JaDG][\"\n ],\n \"commerce\": {\n \"country\": \"MJ\",\n \"currency\": \"YKY\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/preview/organizations/:organizationId/agents/:agentId/follow-up", "host": [ "{{baseUrl}}" ], "path": [ "api", "preview", "organizations", ":organizationId", "agents", ":agentId", "follow-up" ], "variable": [ { "id": "3b949e55-3cc7-43dd-894e-a2fbbb00342a", "key": "organizationId", "value": "", "description": "(Required) The organization id" }, { "id": "d0a6ece8-3edb-4030-a140-89ae277e48c8", "key": "agentId", "value": "", "description": "(Required) The agent id" } ] } }, "response": [ { "id": "78efa113-5b3e-45a3-bb03-3e6d72193997", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/event-stream" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"conversationId\": \"\",\n \"conversationToken\": \"\",\n \"q\": \"\",\n \"analytics\": {\n \"capture\": \"\",\n \"trackingId\": \"o2PGX\",\n \"clientId\": \"\",\n \"documentLocation\": \"\",\n \"documentReferrer\": \"\",\n \"pageId\": \"\",\n \"userIp\": \"\",\n \"clientRequestId\": \"\",\n \"clientTimestamp\": \"5122-43-11T00:06:19.316Z\",\n \"userAgent\": \"\",\n \"actionCause\": \"\",\n \"originContext\": \"\",\n \"customData\": {\n \"consequat_4\": {}\n },\n \"configId\": \"a2a3b63b-d454-f8a7-d8c5-fd4f15f5b298\",\n \"source\": [\n \"j>-)}~tL;\\\\@|tTd\",\n \"*FMw)@Hke\",\n \"[T@bunG(S!\\\"\",\n \"X@Pn\",\n \"(Miv=BLcRa@Q\",\n \"?Wt!z?@a\",\n \"/n]=.jpV@`|?3\",\n \"pRXzNK@_s]52oDk\",\n \"!tggl@j0>%JaDG][\"\n ],\n \"commerce\": {\n \"country\": \"MJ\",\n \"currency\": \"YKY\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/preview/organizations/:organizationId/agents/:agentId/follow-up", "host": [ "{{baseUrl}}" ], "path": [ "api", "preview", "organizations", ":organizationId", "agents", ":agentId", "follow-up" ], "variable": [ { "key": "organizationId" }, { "key": "agentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/event-stream" } ], "cookie": [], "responseTime": null, "body": "{\n \"timeout\": \"\"\n}", "createdAt": "2026-07-28T01:26:41.000Z", "updatedAt": "2026-07-28T01:26:41.000Z", "uid": "35240-78efa113-5b3e-45a3-bb03-3e6d72193997" } ], "createdAt": "2026-07-28T01:26:41.000Z", "updatedAt": "2026-07-28T01:26:41.000Z", "uid": "35240-72855cc9-9f92-4758-a1bd-43069a62e973" } ], "id": "a8f468f2-e9b5-4591-83f5-dc63d3b21304", "createdAt": "2026-07-28T01:26:41.000Z", "updatedAt": "2026-07-28T01:26:41.000Z", "uid": "35240-a8f468f2-e9b5-4591-83f5-dc63d3b21304" }, { "name": "answer", "item": [ { "name": "Generates an Answer for the Given Configuration", "id": "02518b41-e8f1-4047-8203-e6b409055e17", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/event-stream" } ], "body": { "mode": "raw", "raw": "{\n \"q\": \"\",\n \"searchHub\": \"\",\n \"pipeline\": \"\",\n \"facets\": [\n {\n \"field\": \"neqsjbZN\",\n \"facetId\": \"ReM5TgK1F\",\n \"type\": \"specific\",\n \"filterFacetCount\": \"\",\n \"injectionDepth\": \"\",\n \"isFieldExpanded\": \"\",\n \"preventAutoSelect\": \"\",\n \"resultsMustMatch\": \"atLeastOneValue\",\n \"currentValues\": [\n {\n \"state\": \"selected\",\n \"previousState\": \"idle\",\n \"preventAutoSelect\": \"\",\n \"value\": \"\"\n },\n {\n \"state\": \"excluded\",\n \"previousState\": \"idle\",\n \"preventAutoSelect\": \"\",\n \"value\": \"\"\n }\n ],\n \"numberOfValues\": \"\",\n \"freezeCurrentValues\": \"\",\n \"sortCriteria\": \"alphanumericNatural\",\n \"customSort\": [\n \"\",\n \"\"\n ]\n },\n {\n \"field\": \"rPsT3NMYz\",\n \"facetId\": \"5\",\n \"type\": \"specific\",\n \"filterFacetCount\": \"\",\n \"injectionDepth\": \"\",\n \"isFieldExpanded\": \"\",\n \"preventAutoSelect\": \"\",\n \"resultsMustMatch\": \"allValues\",\n \"currentValues\": [\n {\n \"state\": \"selected\",\n \"previousState\": \"selected\",\n \"preventAutoSelect\": \"\",\n \"value\": \"\"\n },\n {\n \"state\": \"idle\",\n \"previousState\": \"excluded\",\n \"preventAutoSelect\": \"\",\n \"value\": \"\"\n }\n ],\n \"numberOfValues\": \"\",\n \"freezeCurrentValues\": \"\",\n \"sortCriteria\": \"alphanumericNatural\",\n \"customSort\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"locale\": \"\",\n \"citationsFieldToInclude\": [\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\"\n ],\n \"recordDebugSession\": false,\n \"context\": {},\n \"aq\": \"\",\n \"cq\": \"\",\n \"referrer\": \"\",\n \"tab\": \"\",\n \"analytics\": {\n \"capture\": \"\",\n \"trackingId\": \"Eo-r\",\n \"clientId\": \"\",\n \"documentLocation\": \"\",\n \"documentReferrer\": \"eUR6cZCyjh:n.)\",\n \"pageId\": \"\",\n \"userIp\": \"\",\n \"clientRequestId\": \"\",\n \"clientTimestamp\": \"4078-29-38T46:27:04.242Z\",\n \"userAgent\": \"\",\n \"actionCause\": \"\",\n \"originContext\": \"\",\n \"customData\": {\n \"aliquip_2_\": {},\n \"deserunt_73a\": {}\n },\n \"configId\": \"6661767a-7cf5-3681-e33f-d54e35172de2\",\n \"source\": [\n \"5-D@`\",\n \">t.x4o/LuF@:<0*$\",\n \"fc@\\\"9H{6guc\\\\D\",\n \"q{_&&GCaa@ 4YSm\",\n \"zN>JI+%svP@WdHx0c@\",\n \"vbZ=R5m2t@\",\n \"Qmn/@[J\"\n ],\n \"commerce\": {\n \"country\": \"VE\",\n \"currency\": \"MZQ\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/preview/organizations/:organizationId/agents/:agentId/answer", "host": [ "{{baseUrl}}" ], "path": [ "api", "preview", "organizations", ":organizationId", "agents", ":agentId", "answer" ], "variable": [ { "id": "36246bc2-dcdf-46cc-ae2c-2235e884230c", "key": "organizationId", "value": "", "description": "(Required) The organization id" }, { "id": "6787408a-23cb-4a77-b207-86dbe8e2605d", "key": "agentId", "value": "", "description": "(Required) The agent id" } ] } }, "response": [ { "id": "ff8fa99b-b465-43c3-ba31-d2fd1e35676e", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/event-stream" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"q\": \"\",\n \"searchHub\": \"\",\n \"pipeline\": \"\",\n \"facets\": [\n {\n \"field\": \"neqsjbZN\",\n \"facetId\": \"ReM5TgK1F\",\n \"type\": \"specific\",\n \"filterFacetCount\": \"\",\n \"injectionDepth\": \"\",\n \"isFieldExpanded\": \"\",\n \"preventAutoSelect\": \"\",\n \"resultsMustMatch\": \"atLeastOneValue\",\n \"currentValues\": [\n {\n \"state\": \"selected\",\n \"previousState\": \"idle\",\n \"preventAutoSelect\": \"\",\n \"value\": \"\"\n },\n {\n \"state\": \"excluded\",\n \"previousState\": \"idle\",\n \"preventAutoSelect\": \"\",\n \"value\": \"\"\n }\n ],\n \"numberOfValues\": \"\",\n \"freezeCurrentValues\": \"\",\n \"sortCriteria\": \"alphanumericNatural\",\n \"customSort\": [\n \"\",\n \"\"\n ]\n },\n {\n \"field\": \"rPsT3NMYz\",\n \"facetId\": \"5\",\n \"type\": \"specific\",\n \"filterFacetCount\": \"\",\n \"injectionDepth\": \"\",\n \"isFieldExpanded\": \"\",\n \"preventAutoSelect\": \"\",\n \"resultsMustMatch\": \"allValues\",\n \"currentValues\": [\n {\n \"state\": \"selected\",\n \"previousState\": \"selected\",\n \"preventAutoSelect\": \"\",\n \"value\": \"\"\n },\n {\n \"state\": \"idle\",\n \"previousState\": \"excluded\",\n \"preventAutoSelect\": \"\",\n \"value\": \"\"\n }\n ],\n \"numberOfValues\": \"\",\n \"freezeCurrentValues\": \"\",\n \"sortCriteria\": \"alphanumericNatural\",\n \"customSort\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"locale\": \"\",\n \"citationsFieldToInclude\": [\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\"\n ],\n \"recordDebugSession\": false,\n \"context\": {},\n \"aq\": \"\",\n \"cq\": \"\",\n \"referrer\": \"\",\n \"tab\": \"\",\n \"analytics\": {\n \"capture\": \"\",\n \"trackingId\": \"Eo-r\",\n \"clientId\": \"\",\n \"documentLocation\": \"\",\n \"documentReferrer\": \"eUR6cZCyjh:n.)\",\n \"pageId\": \"\",\n \"userIp\": \"\",\n \"clientRequestId\": \"\",\n \"clientTimestamp\": \"4078-29-38T46:27:04.242Z\",\n \"userAgent\": \"\",\n \"actionCause\": \"\",\n \"originContext\": \"\",\n \"customData\": {\n \"aliquip_2_\": {},\n \"deserunt_73a\": {}\n },\n \"configId\": \"6661767a-7cf5-3681-e33f-d54e35172de2\",\n \"source\": [\n \"5-D@`\",\n \">t.x4o/LuF@:<0*$\",\n \"fc@\\\"9H{6guc\\\\D\",\n \"q{_&&GCaa@ 4YSm\",\n \"zN>JI+%svP@WdHx0c@\",\n \"vbZ=R5m2t@\",\n \"Qmn/@[J\"\n ],\n \"commerce\": {\n \"country\": \"VE\",\n \"currency\": \"MZQ\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/preview/organizations/:organizationId/agents/:agentId/answer", "host": [ "{{baseUrl}}" ], "path": [ "api", "preview", "organizations", ":organizationId", "agents", ":agentId", "answer" ], "variable": [ { "key": "organizationId" }, { "key": "agentId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/event-stream" } ], "cookie": [], "responseTime": null, "body": "{\n \"timeout\": \"\"\n}", "createdAt": "2026-07-28T01:26:41.000Z", "updatedAt": "2026-07-28T01:26:41.000Z", "uid": "35240-ff8fa99b-b465-43c3-ba31-d2fd1e35676e" } ], "createdAt": "2026-07-28T01:26:41.000Z", "updatedAt": "2026-07-28T01:26:41.000Z", "uid": "35240-02518b41-e8f1-4047-8203-e6b409055e17" } ], "id": "ab3eaf60-63cb-4830-ade3-4be4369190d8", "createdAt": "2026-07-28T01:26:41.000Z", "updatedAt": "2026-07-28T01:26:41.000Z", "uid": "35240-ab3eaf60-63cb-4830-ade3-4be4369190d8" } ], "id": "84b23d36-2787-477a-aa8d-24bc71cdfb1d", "createdAt": "2026-07-28T01:26:41.000Z", "updatedAt": "2026-07-28T01:26:41.000Z", "uid": "35240-84b23d36-2787-477a-aa8d-24bc71cdfb1d" } ], "id": "9d4d1511-1b7d-475e-8109-befbcce256fa", "createdAt": "2026-07-28T01:26:41.000Z", "updatedAt": "2026-07-28T01:26:41.000Z", "uid": "35240-9d4d1511-1b7d-475e-8109-befbcce256fa" } ], "id": "a0f0a7c9-7bc4-4596-b609-51a4e5298ef1", "createdAt": "2026-07-28T01:26:41.000Z", "updatedAt": "2026-07-28T01:26:41.000Z", "uid": "35240-a0f0a7c9-7bc4-4596-b609-51a4e5298ef1" } ], "id": "4ee632bc-c567-4c7b-8b08-d632f4299cb2", "createdAt": "2026-07-28T01:26:41.000Z", "updatedAt": "2026-07-28T01:26:41.000Z", "uid": "35240-4ee632bc-c567-4c7b-8b08-d632f4299cb2" } ], "id": "23b42623-a67c-4cfa-a4a1-0732b056bff9", "createdAt": "2026-07-28T01:26:41.000Z", "updatedAt": "2026-07-28T01:26:41.000Z", "uid": "35240-23b42623-a67c-4cfa-a4a1-0732b056bff9" } ], "id": "8f11a100-9052-4359-9e51-8f76c3add687", "createdAt": "2026-07-28T01:26:41.000Z", "updatedAt": "2026-07-28T01:26:41.000Z", "uid": "35240-8f11a100-9052-4359-9e51-8f76c3add687" } ], "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" } ] }