{
  "opencollection": "1.0.0",
  "info": {
    "name": "PureCloud Platform Agent Assistants API",
    "version": "v2"
  },
  "items": [
    {
      "info": {
        "name": "Agent Assistants",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the list of supported languages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/assistants/agentchecklists/languages"
          },
          "docs": "Get the list of supported languages"
        },
        {
          "info": {
            "name": "Get an agent checklist",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/assistants/agentchecklists/:agentChecklistId",
            "params": [
              {
                "name": "agentChecklistId",
                "value": "",
                "type": "path",
                "description": "Agent Checklist ID"
              }
            ]
          },
          "docs": "Get an agent checklist"
        },
        {
          "info": {
            "name": "Update an agent checklist",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/assistants/agentchecklists/:agentChecklistId",
            "params": [
              {
                "name": "agentChecklistId",
                "value": "",
                "type": "path",
                "description": "Agent Checklist ID"
              }
            ]
          },
          "docs": "Update an agent checklist"
        },
        {
          "info": {
            "name": "Delete an agent checklist",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/assistants/agentchecklists/:agentChecklistId",
            "params": [
              {
                "name": "agentChecklistId",
                "value": "",
                "type": "path",
                "description": "Agent Checklist ID"
              }
            ]
          },
          "docs": "Delete an agent checklist"
        },
        {
          "info": {
            "name": "Get the list of agent checklists",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/assistants/agentchecklists",
            "params": [
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the start of the set of entities that has been returned."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the end of the set of entities that has been returned."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "The page size for the listing. The max that will be returned is 100."
              },
              {
                "name": "namePrefix",
                "value": "",
                "type": "query",
                "description": "The agent checklist name prefix filter applied to the listing."
              },
              {
                "name": "language",
                "value": "",
                "type": "query",
                "description": "The agent checklist language filter applied to the listing."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order for the listing"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by for the listing."
              },
              {
                "name": "agentChecklistIds",
                "value": "",
                "type": "query",
                "description": "Agent checklist IDs (repeat param or comma-separated). Do not use with other optional filters."
              }
            ]
          },
          "docs": "Get the list of agent checklists"
        },
        {
          "info": {
            "name": "Create an agent checklist",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/assistants/agentchecklists"
          },
          "docs": "Create an agent checklist"
        },
        {
          "info": {
            "name": "Get queue Information for an assistant.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/assistants/:assistantId/queues/:queueId",
            "params": [
              {
                "name": "assistantId",
                "value": "",
                "type": "path",
                "description": "Assistant ID"
              },
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "Queue ID"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Which fields, if any, to expand."
              }
            ]
          },
          "docs": "Get queue Information for an assistant."
        },
        {
          "info": {
            "name": "Create a queue assistant association.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/v2/assistants/:assistantId/queues/:queueId",
            "params": [
              {
                "name": "assistantId",
                "value": "",
                "type": "path",
                "description": "Assistant ID"
              },
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "Queue ID"
              }
            ]
          },
          "docs": "Create a queue assistant association."
        },
        {
          "info": {
            "name": "Disassociate a queue from an assistant.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/assistants/:assistantId/queues/:queueId",
            "params": [
              {
                "name": "assistantId",
                "value": "",
                "type": "path",
                "description": "Assistant ID"
              },
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "Queue ID"
              }
            ]
          },
          "docs": "Disassociate a queue from an assistant."
        },
        {
          "info": {
            "name": "Get job details.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/assistants/:assistantId/queues/:queueId/users/jobs/:jobId",
            "params": [
              {
                "name": "assistantId",
                "value": "",
                "type": "path",
                "description": "Assistant ID"
              },
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "Queue ID"
              },
              {
                "name": "jobId",
                "value": "",
                "type": "path",
                "description": "Job ID"
              }
            ]
          },
          "docs": "Get job details."
        },
        {
          "info": {
            "name": "Start a new job to assistant-queue.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/assistants/:assistantId/queues/:queueId/users/jobs",
            "params": [
              {
                "name": "assistantId",
                "value": "",
                "type": "path",
                "description": "Assistant ID"
              },
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "Queue ID"
              }
            ]
          },
          "docs": "Start a new job to assistant-queue."
        },
        {
          "info": {
            "name": "Bulk add users to assistant-queue (requires manual assignment mode).",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/assistants/:assistantId/queues/:queueId/users/bulk/add",
            "params": [
              {
                "name": "assistantId",
                "value": "",
                "type": "path",
                "description": "Assistant ID"
              },
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "Queue ID"
              }
            ]
          },
          "docs": "Bulk add users to assistant-queue (requires manual assignment mode)."
        },
        {
          "info": {
            "name": "Bulk remove users from assistant-queue (requires manual assignment mode).",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/assistants/:assistantId/queues/:queueId/users/bulk/remove",
            "params": [
              {
                "name": "assistantId",
                "value": "",
                "type": "path",
                "description": "Assistant ID"
              },
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "Queue ID"
              }
            ]
          },
          "docs": "Bulk remove users from assistant-queue (requires manual assignment mode)."
        },
        {
          "info": {
            "name": "Query for users in the assistant-queue (requires manual assignment mode).",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/assistants/:assistantId/queues/:queueId/users/query",
            "params": [
              {
                "name": "assistantId",
                "value": "",
                "type": "path",
                "description": "Assistant ID"
              },
              {
                "name": "queueId",
                "value": "",
                "type": "path",
                "description": "Queue ID"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Which fields, if any, to expand with."
              }
            ]
          },
          "docs": "Query for users in the assistant-queue (requires manual assignment mode)."
        },
        {
          "info": {
            "name": "Get all the queues associated with an assistant.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/assistants/:assistantId/queues",
            "params": [
              {
                "name": "assistantId",
                "value": "",
                "type": "path",
                "description": "Assistant ID"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the start of the set of entities that has been returned."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the end of the set of entities that has been returned."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of entities to return. Maximum of 200."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Which fields, if any, to expand."
              }
            ]
          },
          "docs": "Get all the queues associated with an assistant."
        },
        {
          "info": {
            "name": "Update Queues for an Assistant.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/assistants/:assistantId/queues",
            "params": [
              {
                "name": "assistantId",
                "value": "",
                "type": "path",
                "description": "Assistant ID"
              }
            ]
          },
          "docs": "Update Queues for an Assistant."
        },
        {
          "info": {
            "name": "Disassociate the queues from an assistant for the given assistant ID and queue IDs.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/assistants/:assistantId/queues",
            "params": [
              {
                "name": "assistantId",
                "value": "",
                "type": "path",
                "description": "Assistant ID"
              },
              {
                "name": "queueIds",
                "value": "",
                "type": "query",
                "description": "Comma-separated identifiers of the queues that need to be deleted."
              }
            ]
          },
          "docs": "Disassociate the queues from an assistant for the given assistant ID and queue IDs."
        },
        {
          "info": {
            "name": "Get an assistant.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/assistants/:assistantId",
            "params": [
              {
                "name": "assistantId",
                "value": "",
                "type": "path",
                "description": "Assistant ID"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Which fields, if any, to expand."
              },
              {
                "name": "languageVariation",
                "value": "",
                "type": "query",
                "description": "Language variation"
              },
              {
                "name": "fallbackToPrimaryAssistant",
                "value": "",
                "type": "query",
                "description": "Fall back to primary assistant if specified variation is not found"
              }
            ]
          },
          "docs": "Get an assistant."
        },
        {
          "info": {
            "name": "Update an assistant.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/v2/assistants/:assistantId",
            "params": [
              {
                "name": "assistantId",
                "value": "",
                "type": "path",
                "description": "Assistant ID"
              }
            ]
          },
          "docs": "Update an assistant."
        },
        {
          "info": {
            "name": "Delete an assistant.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/v2/assistants/:assistantId",
            "params": [
              {
                "name": "assistantId",
                "value": "",
                "type": "path",
                "description": "Assistant ID"
              }
            ]
          },
          "docs": "Delete an assistant."
        },
        {
          "info": {
            "name": "Get all assistants.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/assistants",
            "params": [
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the start of the set of entities that has been returned."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the end of the set of entities that has been returned."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of entities to return. Maximum of 200. Deprecated in favour of pageSize"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of entities to return. Maximum of 200."
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Return the assistant by the given name."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Which fields, if any, to expand"
              }
            ]
          },
          "docs": "Get all assistants."
        },
        {
          "info": {
            "name": "Create an Assistant.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/v2/assistants"
          },
          "docs": "Create an Assistant."
        },
        {
          "info": {
            "name": "Get all queues assigned to any assistant.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v2/assistants/queues",
            "params": [
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the start of the set of entities that has been returned."
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "The cursor that points to the end of the set of entities that has been returned."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of entities to return. Maximum of 200."
              },
              {
                "name": "queueIds",
                "value": "",
                "type": "query",
                "description": "Comma-separated identifiers of the queues that need to be retrieved."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Which fields, if any, to expand."
              }
            ]
          },
          "docs": "Get all queues assigned to any assistant."
        }
      ]
    }
  ],
  "bundled": true
}