How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Genesys

Genesys Agent Assistants API

Manage virtual agent assistants.

Documentation Provider Profile APIs.io OpenAPI GitHub

Genesys Agent Assistants API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Agent Assistants. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 23 operations across 13 paths, and defines 48 schemas. It is described by OpenAPI 2.0, at version v2.

Requests are made against the base URL https://api.mypurecloud.com.

23 operations 13 paths 48 schemas 4 DELETE9 GET2 PATCH6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v2
Base URL
https://api.mypurecloud.com
Authentication
OAuth 2.0, API Key
Contact
PureCloud Developer Evangelists
License
UNLICENSED
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Genesys Agent Assistants API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (PureCloud OAuth) using the implicit flow, exposing 1 scope. An API key is passed in the header as Authorization (Guest Chat JWT).

Paths & Operations 23

Across 13 paths, the API surfaces 23 operations — 4 DELETE, 9 GET, 2 PATCH, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Agent Assistants 23

Manage virtual agent assistants.

GET
/api/v2/assistants/agentchecklists/languages
Get the list of supported languages
getAssistantsAgentchecklistsLanguages → 200400401403404408409413
GET
/api/v2/assistants/agentchecklists/{agentChecklistId}
Get an agent checklist
getAssistantsAgentchecklist 1 param → 200400401403404408409413
PUT
/api/v2/assistants/agentchecklists/{agentChecklistId}
Update an agent checklist
putAssistantsAgentchecklist 2 params → 200202400401403404408409
DELETE
/api/v2/assistants/agentchecklists/{agentChecklistId}
Delete an agent checklist
deleteAssistantsAgentchecklist 1 param → 204400401403404408409413
GET
/api/v2/assistants/agentchecklists
Get the list of agent checklists
getAssistantsAgentchecklists 8 params → 200400401403404408409413
POST
/api/v2/assistants/agentchecklists
Create an agent checklist
postAssistantsAgentchecklists 1 param → 200202400401403404408409
GET
/api/v2/assistants/{assistantId}/queues/{queueId}
Get queue Information for an assistant.
getAssistantQueue 3 params → 200400401403404408409413
PUT
/api/v2/assistants/{assistantId}/queues/{queueId}
Create a queue assistant association.
putAssistantQueue 3 params → 200201400401403404408409
DELETE
/api/v2/assistants/{assistantId}/queues/{queueId}
Disassociate a queue from an assistant.
deleteAssistantQueue 2 params → 204400401403404408409413
GET
/api/v2/assistants/{assistantId}/queues/{queueId}/users/jobs/{jobId}
Get job details.
getAssistantQueueUsersJob 3 params → 200400401403404408409413
POST
/api/v2/assistants/{assistantId}/queues/{queueId}/users/jobs
Start a new job to assistant-queue.
postAssistantQueueUsersJobs 3 params → 200202400401403404408409
POST
/api/v2/assistants/{assistantId}/queues/{queueId}/users/bulk/add
Bulk add users to assistant-queue (requires manual assignment mode).
postAssistantQueueUsersBulkAdd 3 params → 204200400401403404408409
POST
/api/v2/assistants/{assistantId}/queues/{queueId}/users/bulk/remove
Bulk remove users from assistant-queue (requires manual assignment mode).
postAssistantQueueUsersBulkRemove 3 params → 204200400401403404408409
POST
/api/v2/assistants/{assistantId}/queues/{queueId}/users/query
Query for users in the assistant-queue (requires manual assignment mode).
postAssistantQueueUsersQuery 4 params → 200400401403404408409413
GET
/api/v2/assistants/{assistantId}/queues
Get all the queues associated with an assistant.
getAssistantQueues 5 params → 200400401403404408409413
DELETE
/api/v2/assistants/{assistantId}/queues
Disassociate the queues from an assistant for the given assistant ID and queue IDs.
deleteAssistantQueues 2 params → 204400401403404408409413
PATCH
/api/v2/assistants/{assistantId}/queues
Update Queues for an Assistant.
patchAssistantQueues 2 params → 200400401403404408409413
GET
/api/v2/assistants/{assistantId}
Get an assistant.
getAssistant 4 params → 200400401403404408409413
DELETE
/api/v2/assistants/{assistantId}
Delete an assistant.
deleteAssistant 1 param → 204400401403404408409413
PATCH
/api/v2/assistants/{assistantId}
Update an assistant.
patchAssistant 2 params → 200400401403404408409413
GET
/api/v2/assistants
Get all assistants.
getAssistants 6 params → 200400401403404408409413
POST
/api/v2/assistants
Create an Assistant.
postAssistants 1 param → 200400401403404408409413
GET
/api/v2/assistants/queues
Get all queues assigned to any assistant.
getAssistantsQueues 5 params → 200400401403404408409413

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are Copilot (13 properties), Assistant (13 properties), ErrorBody (11 properties), AgentChecklist (9 properties). Each schema is shown below with its type and property counts.

CopilotFallbackAction
object
2 properties 1 required
AddressableEntityRef
object
2 properties
RuleEngineConfig
object
2 properties 1 required
GoogleDialogflowConfig
object
2 properties 1 required
CopilotNluDomainVersion
object
2 properties 1 required
Fallback
object
2 properties
UserReference
object
2 properties
AgentChecklistListing
object
4 properties
AutoSearchConfig
object
1 property
AssistantQueueUser
object
1 property 1 required
KnowledgeAnswerConfig
object
1 property 1 required
KnowledgeSuggestionConfig
object
4 properties 1 required
CopilotCondition
object
2 properties 2 required
KnowledgeBaseReference
object
4 properties 1 required
ErrorBody
object
11 properties
WrapupCodePredictionConfig
object
1 property 1 required
AgentChecklistItem
object
7 properties 1 required
NluConfig
object
2 properties 2 required
CopilotNluDomain
object
4 properties 2 required
Copilot
object
13 properties 2 required
AssistantQueueUsersBulkRemoveRequest
object
1 property 1 required
BulkResponse
object
3 properties
AssistantQueueListing
object
4 properties
AssistantQueueUsersJobsResponse
object
4 properties
CopilotAction
object
2 properties 1 required
AgentChecklist
object
9 properties 3 required
AssistantListing
object
4 properties
SummarySettingEntity
object
2 properties
ConversationProfile
object
2 properties 2 required
AssistantQueueUsersQueryRequest
object
1 property 1 required
AnswerGenerationConfig
object
1 property 1 required
BulkResult
object
2 properties
Limit
object
3 properties
Assistant
object
13 properties 2 required
SummaryGenerationConfig
object
2 properties 1 required
AssistantQueueUsersJobErrorInfo
object
2 properties
AssistantQueue
object
6 properties 2 required
RuleConfig
object
3 properties 2 required
ManualSearchConfig
object
2 properties
CopilotRule
object
2 properties 2 required
AssistantQueueUsersQueryResponse
object
2 properties
TranscriptionConfig
object
1 property 1 required
KnowledgeBaseWithDialectReference
object
3 properties 2 required
AssistantQueueUsersBulkAddRequest
object
1 property 1 required
BulkError
object
2 properties
AssistantQueueUsersJobsRequest
object
1 property 1 required
EntityListing
object
1 property
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-agent-assistants-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Copilot API
AE Profile APIs.io
Genesys Agent UI API
AE Profile APIs.io
Genesys AI Studio API
AE Profile APIs.io
Genesys Alerting API
AE Profile APIs.io
Genesys Analytics API
AE Profile APIs.io
Genesys Architect API
AE Profile APIs.io
Genesys Assistant Copilot Variations API
AE Profile APIs.io
Genesys Audit API
AE Profile APIs.io
Genesys Authorization API
AE Profile APIs.io
Genesys Background Assistant API
AE Profile APIs.io
Genesys Billing API
AE Profile APIs.io
Genesys Business Rules API
AE Profile APIs.io
#Agent Assistants
← Back to G APIs
API Details
ID
genesys:genesys-agent-assistants-api
Base URL
https://api.mypurecloud.com
Docs
https://developer.genesys.cloud/platform/api/
Provider
Genesys
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=genesys-agent-assistants-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/genesys-agent-assistants-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Genesys Agent Assistants API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.