{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Agent Configuration API API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "authorization_code",
      "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
      "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Agent Configuration API",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Agents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/api/preview/organizations/:organizationId/agents",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The zero-based index of the results page to retrieve"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of items to return per page"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"AGENT_CONFIGURATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Create an Agent",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/api/preview/organizations/:organizationId/agents",
            "headers": [
              {
                "name": "X-Skip-Provisioning",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"AGENT_CONFIGURATION\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get an Agent by agentId",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/api/preview/organizations/:organizationId/agents/:agentId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "agentId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"AGENT_CONFIGURATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update an Agent",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://platform.cloud.coveo.com/api/preview/organizations/:organizationId/agents/:agentId",
            "headers": [
              {
                "name": "X-Skip-Provisioning",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "agentId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"AGENT_CONFIGURATION\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Delete an Agent",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/api/preview/organizations/:organizationId/agents/:agentId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "agentId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "<details><summary>Privilege required</summary>\n```\n{\"owner\":\"COVEO_ML\",\"targetDomain\":\"AGENT_CONFIGURATION\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n</details>"
        }
      ]
    }
  ],
  "bundled": true
}