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

Genesys Agent Copilot API

Manage agent copilot configuration.

Genesys Agent Copilot 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 Copilot. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 3 operations across 2 paths, and defines 24 schemas. It is described by OpenAPI 2.0, at version v2.

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

3 operations 2 paths 24 schemas 2 GET1 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
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Genesys Agent Copilot 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 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Agent Copilot 3

Manage agent copilot configuration.

GET
/api/v2/assistants/{assistantId}/copilot
Get copilot configuration of an assistant.
getAssistantCopilot 1 param → 200400401403404408409413
PUT
/api/v2/assistants/{assistantId}/copilot
Update agent copilot configuration
putAssistantCopilot 2 params → 200400401403404408409413
GET
/api/v2/assistants/copilot/featuresupport
Get information about the support of features for all the languages or only for a certain language.
getAssistantsCopilotFeaturesupport 1 param → 200400401403404408409413

Schemas 24

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

CopilotFallbackAction
object
2 properties 1 required
RuleEngineConfig
object
2 properties 1 required
LanguageSupportInfoRecord
object
2 properties
CopilotNluDomainVersion
object
2 properties 1 required
Fallback
object
2 properties
AutoSearchConfig
object
1 property
KnowledgeAnswerConfig
object
1 property 1 required
CopilotCondition
object
2 properties 2 required
ErrorBody
object
11 properties
WrapupCodePredictionConfig
object
1 property 1 required
NluConfig
object
2 properties 2 required
CopilotNluDomain
object
4 properties 2 required
Copilot
object
13 properties 2 required
LanguageSupportResponse
object
1 property
CopilotAction
object
2 properties 1 required
FeatureSupport
object
3 properties
SummarySettingEntity
object
2 properties
AnswerGenerationConfig
object
1 property 1 required
Limit
object
3 properties
SummaryGenerationConfig
object
2 properties 1 required
RuleConfig
object
3 properties 2 required
ManualSearchConfig
object
2 properties
CopilotRule
object
2 properties 2 required
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
Genesys Agent UI API
Genesys AI Studio API
Genesys Alerting API
Genesys Analytics API
Genesys Architect API
Genesys Assistant Copilot Variations API
Genesys Audit API
Genesys Authorization API
Genesys Background Assistant API
Genesys Billing API
Genesys Business Rules API
Where this information came from

This is an independent, third-party profile of Genesys Agent Copilot 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.