Skip to content

Commit 74aa1dc

Browse files
author
PureCloud Jenkins
committed
doc publish
1 parent b2a1329 commit 74aa1dc

86 files changed

Lines changed: 1475 additions & 202 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.lastupdated

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2025-11-27T04:47:27
1+
2025-12-12T14:23:50

docs/AIStudioApi.md

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ All URIs are relative to *https://api.mypurecloud.com*
2020
[**patchGuideVersion**](AIStudioApi#patchGuideVersion) | **PATCH** /api/v2/guides/{guideId}/versions/{versionId} | Update a guide version.
2121
[**postConversationsSummariesPreview**](AIStudioApi#postConversationsSummariesPreview) | **POST** /api/v2/conversations/summaries/preview | Trigger summary preview event generation.
2222
[**postConversationsSummariesSettings**](AIStudioApi#postConversationsSummariesSettings) | **POST** /api/v2/conversations/summaries/settings | Create a summary setting.
23+
[**postGuideSessionTurns**](AIStudioApi#postGuideSessionTurns) | **POST** /api/v2/guides/{guideId}/sessions/{guideSessionId}/turns | Add a turn to a guide session.
2324
[**postGuideVersionJobs**](AIStudioApi#postGuideVersionJobs) | **POST** /api/v2/guides/{guideId}/versions/{versionId}/jobs | Start the publishing of a guide version.
2425
[**postGuideVersions**](AIStudioApi#postGuideVersions) | **POST** /api/v2/guides/{guideId}/versions | Create a guide version.
2526
[**postGuides**](AIStudioApi#postGuides) | **POST** /api/v2/guides | Create a guide.
@@ -786,6 +787,62 @@ apiInstance.postConversationsSummariesSettings(body)
786787
**SummarySetting**
787788

788789

790+
## postGuideSessionTurns
791+
792+
> GuideSessionTurnResponse postGuideSessionTurns(guideId, guideSessionId, body)
793+
794+
795+
POST /api/v2/guides/{guideId}/sessions/{guideSessionId}/turns
796+
797+
Add a turn to a guide session.
798+
799+
Creates a new turn in the specified guide session with the provided request data. If the session ID doesnt exist, a new session will be created automatically.
800+
801+
Requires ALL permissions:
802+
803+
* aiStudio:guideSessionTurn:add
804+
805+
### Example Usage
806+
807+
```{"language":"javascript"}
808+
// Browser
809+
const platformClient = require('platformClient');
810+
// Node
811+
const platformClient = require('purecloud-platform-client-v2');
812+
813+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
814+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
815+
816+
let apiInstance = new platformClient.AIStudioApi();
817+
818+
let guideId = "guideId_example"; // String | Guide ID
819+
let guideSessionId = "guideSessionId_example"; // String | Guide Session ID
820+
let body = {}; // Object |
821+
822+
apiInstance.postGuideSessionTurns(guideId, guideSessionId, body)
823+
.then((data) => {
824+
console.log(`postGuideSessionTurns success! data: ${JSON.stringify(data, null, 2)}`);
825+
})
826+
.catch((err) => {
827+
console.log('There was a failure calling postGuideSessionTurns');
828+
console.error(err);
829+
});
830+
```
831+
832+
### Parameters
833+
834+
835+
| Name | Type | Description | Notes |
836+
| ------------- | ------------- | ------------- | ------------- |
837+
**guideId** | **String** | Guide ID | |
838+
**guideSessionId** | **String** | Guide Session ID | |
839+
**body** | **Object** | | |
840+
841+
### Return type
842+
843+
**GuideSessionTurnResponse**
844+
845+
789846
## postGuideVersionJobs
790847

791848
> GuideVersionPublishJob postGuideVersionJobs(guideId, versionId, body)
@@ -1054,4 +1111,4 @@ apiInstance.putConversationsSummariesSetting(summarySettingId, body)
10541111
**SummarySetting**
10551112

10561113

1057-
_purecloud-platform-client-v2@239.0.0_
1114+
_purecloud-platform-client-v2@241.0.0_

0 commit comments

Comments
 (0)