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 AI Studio API

Manage AI Studio configuration

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

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

This API exposes 21 operations across 15 paths, and defines 42 schemas. It is described by OpenAPI 3.2.0, at version v2.

Requests are made against a single base URL, https://api.mypurecloud.com.

21 operations 15 paths 42 schemas 2 DELETE8 GET2 PATCH8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.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 AI Studio 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 21

Across 15 paths, the API surfaces 21 operations — 2 DELETE, 8 GET, 2 PATCH, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

AI Studio 21

Manage AI Studio configuration

POST
/api/v2/conversations/summaries/preview
Trigger summary preview event generation
postConversationsSummariesPreview body → 204400401403404408409413
GET
/api/v2/conversations/summaries/settings
Get all summary settings
getConversationsSummariesSettings 6 params → 200400401403404408409413
POST
/api/v2/conversations/summaries/settings
Create a summary setting
postConversationsSummariesSettings body → 200400401403404408409413
GET
/api/v2/conversations/summaries/settings/{summarySettingId}
Receive a summary setting
getConversationsSummariesSetting 1 param → 200400401403404408409413
PUT
/api/v2/conversations/summaries/settings/{summarySettingId}
Update a summary setting
putConversationsSummariesSetting 1 param body → 200400401403404408409413
DELETE
/api/v2/conversations/summaries/settings/{summarySettingId}
Delete a summary setting
deleteConversationsSummariesSetting 1 param → 204400401403404408409413
GET
/api/v2/guides/{guideId}
Get guide
getGuide 1 param → 200400401403404408409413
PATCH
/api/v2/guides/{guideId}
Update a guide
patchGuide 1 param body → 200400401403404408409413
DELETE
/api/v2/guides/{guideId}/jobs
Start the deletion of a guide
deleteGuideJobs 1 param → 200202400401403404408409
GET
/api/v2/guides/{guideId}/jobs/{jobId}
Get the specified guide deletion job
getGuideJob 2 params → 200400401403404408409413
POST
/api/v2/guides/{guideId}/sessions/{guideSessionId}/turns
Add a turn to a guide session
postGuideSessionTurns 2 params body → 200400401403404408409413
GET
/api/v2/guides/{guideId}/versions/{versionId}
Get a guide version
getGuideVersion 2 params → 200400401403404408409413
PATCH
/api/v2/guides/{guideId}/versions/{versionId}
Update a guide version
patchGuideVersion 2 params body → 200400401403404408409413
POST
/api/v2/guides/{guideId}/versions/{versionId}/jobs
Start the publishing of a guide version
postGuideVersionJobs 2 params body → 200202400401403404408409
GET
/api/v2/guides/{guideId}/versions/{versionId}/jobs/{jobId}
Get the status of the publishing job for this guide version
getGuideVersionJob 3 params → 200400401403404408409413
POST
/api/v2/guides/{guideId}/versions
Create a guide version
postGuideVersions 1 param body → 200400401403404408409413
POST
/api/v2/guides/jobs
Start a guide content generation job
postGuidesJobs body → 200202400401403404408409
GET
/api/v2/guides/jobs/{jobId}
Get the status of the guide content generation job
getGuidesJob 1 param → 200400401403404408409413
GET
/api/v2/guides
Get all guides
getGuides 7 params → 200400401403404408409413
POST
/api/v2/guides
Create a guide
postGuides body → 200400401403404408409413
POST
/api/v2/guides/uploads
Generate presigned URL for uploading a file content to generate guide
postGuidesUploads body → 200400401403404408409413

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are SummarySetting (18 properties), ErrorBody (11 properties), GuideEntityListing (10 properties), GuideVersion (10 properties). Each schema is shown below with its type and property counts.

GuideVersionPublish
object
1 property
DataAction
object
4 properties 2 required
VariableValidation
object
AddressableEntityRef
object
2 properties
GuideSessionTurnInvocationData
object
3 properties 3 required
GuideVersionPublishJob
object
6 properties
UpdateGuide
object
Request body for updating a guide
1 property
SummarySettingEntityListing
object
10 properties
GuideSessionTurnResponseData
object
1 property
CreateGuide
object
2 properties 2 required
GuideVersionRef
object
2 properties
GuideSessionTurnResponse
object
Response for a guide session turn
6 properties
GuideSessionTurnRequest
object
Request for a guide session turn
5 properties 3 required
GuideSessionInputEvent
object
5 properties 2 required
GuideSessionVariable
object
2 properties
GuideVersionPublishJobRequest
object
Request body for publishing a guide version
1 property 1 required
GuideContentGenerationJob
object
6 properties
GuideJob
object
5 properties
Detail
object
4 properties
Variable
object
7 properties 3 required
ListValues
object
GuideSessionTurnInvocationResponse
object
4 properties 2 required
SummarySettingPII
object
1 property 1 required
UploadUrlResponse
object
3 properties
GeneratedGuideContent
object
3 properties
Guide
object
9 properties
UpdateGuideVersion
object
Request body for updating a guide version
4 properties
ErrorBody
object
11 properties
SummarySetting
object
18 properties 2 required
Limit
object
3 properties
KnowledgeSettings
object
3 properties
SummarySettingWithTranscript
object
3 properties 3 required
GuideVersion
object
10 properties
GenerateGuideContentRequest
object
Request body for generating the content of a guide
2 properties
UploadUrlRequest
object
5 properties
SummarySettingCustomEntity
object
2 properties
SummarySettingParticipantLabels
object
2 properties
AuthoringKnowledgeSettings
object
4 properties
GuideSessionTurnInvocationParameters
object
3 properties
CreateGuideVersion
object
4 properties 1 required
GuideEntityListing
object
10 properties
GuideVersionResources
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-ai-studio-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
Genesys Agent Copilot API
Genesys Agent UI 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 AI Studio 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.