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 Language Understanding API

Language Understanding

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 40 operations across 25 paths, and defines 73 schemas. It is described by OpenAPI 2.0, at version v2.

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

40 operations 25 paths 73 schemas 5 DELETE19 GET2 PATCH13 POST1 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 Language Understanding 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 40

Across 25 paths, the API surfaces 40 operations — 5 DELETE, 19 GET, 2 PATCH, 13 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Language Understanding 40

Language Understanding

GET
/api/v2/languageunderstanding/domains/{domainId}
Find an NLU Domain.
getLanguageunderstandingDomain 1 param → 200400401403404408409413
DELETE
/api/v2/languageunderstanding/domains/{domainId}
Delete an NLU Domain.
deleteLanguageunderstandingDomain 1 param → 204400401403404408409413
PATCH
/api/v2/languageunderstanding/domains/{domainId}
Update an NLU Domain.
patchLanguageunderstandingDomain 2 params → 200400401403404408409413
GET
/api/v2/languageunderstanding/domains
Get all NLU Domains.
getLanguageunderstandingDomains 2 params → 200400401403404408409413
POST
/api/v2/languageunderstanding/domains
Create an NLU Domain.
postLanguageunderstandingDomains 1 param → 200201400401403404408409
GET
/api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}
Find a Feedback
getLanguageunderstandingDomainFeedbackFeedbackId 3 params → 200400401403404408409413
DELETE
/api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId}
Delete the feedback on the NLU Domain Version.
deleteLanguageunderstandingDomainFeedbackFeedbackId 2 params → 204400401403404408409413
GET
/api/v2/languageunderstanding/domains/{domainId}/feedback
Get all feedback in the given NLU Domain Version.
getLanguageunderstandingDomainFeedback 13 params → 200400401403404408409413
POST
/api/v2/languageunderstanding/domains/{domainId}/feedback
Create feedback for the NLU Domain Version.
postLanguageunderstandingDomainFeedback 2 params → 200201400401403404408409
GET
/api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}
Get information about a draft.
getLanguageunderstandingMinerDraft 4 params → 200400401403404408409413
DELETE
/api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}
Delete a draft
deleteLanguageunderstandingMinerDraft 2 params → 204400401403404408409413
PATCH
/api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId}
Save information for the draft. Either topic draft or intent draft should be sent.
patchLanguageunderstandingMinerDraft 3 params → 200400401403404408409413
GET
/api/v2/languageunderstanding/miners/{minerId}/drafts
Retrieve the list of drafts created.
getLanguageunderstandingMinerDrafts 1 param → 200400401403404408409413
POST
/api/v2/languageunderstanding/miners/{minerId}/drafts
Create a new draft resource.
postLanguageunderstandingMinerDrafts 2 params → 200201400401403404408409
GET
/api/v2/languageunderstanding/ignorephrases/{languageCode}
Get list of all ignored phrases of the specified language code
getLanguageunderstandingIgnorephrase 6 params → 200400401403404408409413
POST
/api/v2/languageunderstanding/ignorephrases/{languageCode}
Add phrases to the ignored phrases list
postLanguageunderstandingIgnorephrase 2 params → 200201400401403404408409
POST
/api/v2/languageunderstanding/ignorephrases/{languageCode}/remove
Delete ignored phrases
postLanguageunderstandingIgnorephraseRemove 2 params → 204400401403404408409413
GET
/api/v2/languageunderstanding/ignoretopics/{languageCode}
Get list of all ignored topics of the specified language code
getLanguageunderstandingIgnoretopic 6 params → 200400401403404408409413
POST
/api/v2/languageunderstanding/ignoretopics/{languageCode}
Add topics to the ignored topics list
postLanguageunderstandingIgnoretopic 2 params → 200201400401403404408409
POST
/api/v2/languageunderstanding/ignoretopics/{languageCode}/remove
Delete ignored topics
postLanguageunderstandingIgnoretopicRemove 2 params → 204400401403404408409413
GET
/api/v2/languageunderstanding/miners/{minerId}/intents/{intentId}
Get information about a mined intent
getLanguageunderstandingMinerIntent 3 params → 200400401403404408409413
GET
/api/v2/languageunderstanding/miners/{minerId}/intents
Retrieve a list of mined intents.
getLanguageunderstandingMinerIntents 2 params → 200400401403404408409413
GET
/api/v2/languageunderstanding/miners/{minerId}
Get information about a miner.
getLanguageunderstandingMiner 1 param → 200400401403404408409413
DELETE
/api/v2/languageunderstanding/miners/{minerId}
Delete a miner.
deleteLanguageunderstandingMiner 1 param → 204400401403404408409413
POST
/api/v2/languageunderstanding/miners/{minerId}/execute
Start the mining process. Specify date range pair with mediaType, queueIds, participantType for mining data from Genesys Cloud. Specify only uploadKey for mining through an external file.
postLanguageunderstandingMinerExecute 2 params → 200202400401403404408409
GET
/api/v2/languageunderstanding/miners
Retrieve the list of miners created.
getLanguageunderstandingMiners 1 param → 200400401403404408409413
POST
/api/v2/languageunderstanding/miners
Create a unique miner.
postLanguageunderstandingMiners 1 param → 200201400401403404408409
GET
/api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}
Retrieves details of a particular topic.
getLanguageunderstandingMinerTopic 3 params → 200400401403404408409413
GET
/api/v2/languageunderstanding/miners/{minerId}/topics
Retrieve a list of mined topics.
getLanguageunderstandingMinerTopics 1 param → 200400401403404408409413
GET
/api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}/phrases/{phraseId}
Retrieves utterances related to a phrase in a topic.
getLanguageunderstandingMinerTopicPhrase 3 params → 200400401403404408409413
GET
/api/v2/languageunderstanding/settings
Get Organization Configuration
getLanguageunderstandingSettings → 200400401403404408409413
GET
/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/report
Retrieved quality report for the specified NLU Domain Version
getLanguageunderstandingDomainVersionReport 2 params → 200400401403404408409413
GET
/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}
Find an NLU Domain Version.
getLanguageunderstandingDomainVersion 3 params → 200400401403404408409413
PUT
/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}
Update an NLU Domain Version.
putLanguageunderstandingDomainVersion 3 params → 200400401403404408409413
DELETE
/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}
Delete an NLU Domain Version
deleteLanguageunderstandingDomainVersion 2 params → 204400401403404408409413
POST
/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/publish
Publish the draft NLU Domain Version.
postLanguageunderstandingDomainVersionPublish 2 params → 200201400401403404408409
POST
/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/train
Train the draft NLU Domain Version.
postLanguageunderstandingDomainVersionTrain 2 params → 200202400401403404408409
POST
/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/detect
Detect intent, entities, etc. in the submitted text using the specified NLU domain version.
postLanguageunderstandingDomainVersionDetect 3 params → 200400401403404408409413
GET
/api/v2/languageunderstanding/domains/{domainId}/versions
Get all NLU Domain Versions for a given Domain.
getLanguageunderstandingDomainVersions 4 params → 200400401403404408409413
POST
/api/v2/languageunderstanding/domains/{domainId}/versions
Create an NLU Domain Version.
postLanguageunderstandingDomainVersions 3 params → 200201400401403404408409

Schemas 73

The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are Miner (24 properties), NluDomainVersion (16 properties), ErrorBody (11 properties), IgnoredMinedPhraseListing (10 properties). Each schema is shown below with its type and property counts.

IntentFeedback
object
4 properties
NluDomain
object
9 properties 1 required
NluQualityReportSummary
object
1 property 1 required
NluConfusionMatrixColumn
object
2 properties 2 required
NluFeedbackResponse
object
7 properties
NluDomainVersion
object
16 properties 1 required
DetectedNamedEntityValue
object
3 properties
NamedEntityTypeItem
object
3 properties 1 required
IgnorePhrasesResponse
object
3 properties 3 required
IgnorePhrasesRequest
object
1 property 1 required
ContextEntity
object
1 property 1 required
DraftTopics
object
9 properties 2 required
NamedEntityTypeMechanismExample
object
2 properties 2 required
NluFeedbackListing
object
10 properties
RemoveEntity
object
1 property 1 required
MinerTopicPhrase
object
6 properties
NamedEntityTypeDefinition
object
3 properties 2 required
DetectedDialogAct
object
2 properties
NluUtteranceSegment
object
2 properties 1 required
AdditionalLanguagesSynonyms
object
1 property
NluDetectionOutput
object
2 properties
Draft
object
8 properties 1 required
Miner
object
24 properties 1 required
MinerTopic
object
9 properties
NluOrganization
object
2 properties
DraftTopicRequest
object
4 properties 3 required
SupportedEntityTypeStatus
object
1 property
MinedIntentsListing
object
4 properties
MinerIntent
object
6 properties
NluDomainVersionQualityReport
object
3 properties 3 required
IgnoredMinedTopicListing
object
10 properties
IgnoreTopicsRequest
object
1 property 1 required
NamedEntityDefinition
object
2 properties 2 required
NluDetectionRequest
object
2 properties 1 required
MinerErrorInfo
object
4 properties
IgnoreTopicsResponse
object
3 properties 3 required
NamedEntityAnnotation
object
1 property 1 required
DraftIntents
object
4 properties 3 required
IgnoredMinedPhraseListing
object
10 properties
NamedEntityTypeMechanism
object
8 properties 2 required
NluDomainVersionListing
object
10 properties
DraftRequest
object
2 properties
NluConfusionMatrixRow
object
2 properties 2 required
TopicPhrase
object
3 properties
NluUtterance
object
3 properties 1 required
NluFeedbackRequest
object
4 properties 3 required
Utterance
object
1 property
NluDomainVersionTrainingResponse
object
2 properties
DetectedIntent
object
3 properties
MinerTopicsListing
object
4 properties
Limit
object
3 properties
DetectedNamedEntity
object
4 properties
NluDomainVersionReference
object
4 properties
IntentReference
object
2 properties 1 required
NluDetectionInput
object
2 properties 1 required
AdditionalLanguagesIntent
object
2 properties
IgnoreTopic
object
3 properties 2 required
RemoveEntitiesRequest
object
1 property 1 required
MinerListing
object
4 properties
MinerExecuteRequest
object
6 properties
ContextIntent
object
1 property 1 required
IgnorePhrase
object
3 properties 2 required
DraftListing
object
4 properties
NluDomainListing
object
10 properties
IgnoredMinedEntity
object
6 properties 5 required
IntentDefinition
object
7 properties 2 required
NluDetectionContext
object
2 properties
SupportedLanguagesInfoDefinition
object
5 properties
ErrorBody
object
11 properties
NluDetectionResponse
object
3 properties
NluQualityReportSummaryMetric
object
2 properties 2 required
NamedEntityTypeBinding
object
2 properties 2 required
Detail
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-language-understanding-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
AE Profile APIs.io
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
#Language Understanding
← Back to G APIs
API Details
ID
genesys:genesys-language-understanding-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-language-understanding-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/genesys-language-understanding-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 Language Understanding 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.