Skip to content

Commit cfc2c2b

Browse files
author
PureCloud Jenkins
committed
doc publish
1 parent ba52706 commit cfc2c2b

88 files changed

Lines changed: 325 additions & 608 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-
2026-01-12T14:12:50
1+
2026-01-16T09:11:50

docs/AIStudioApi.md

Lines changed: 52 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ All URIs are relative to *https://api.mypurecloud.com*
2525
[**postGuideVersions**](AIStudioApi#postGuideVersions) | **POST** /api/v2/guides/{guideId}/versions | Create a guide version.
2626
[**postGuides**](AIStudioApi#postGuides) | **POST** /api/v2/guides | Create a guide.
2727
[**postGuidesJobs**](AIStudioApi#postGuidesJobs) | **POST** /api/v2/guides/jobs | Start a guide content generation job.
28+
[**postGuidesUploads**](AIStudioApi#postGuidesUploads) | **POST** /api/v2/guides/uploads | Generate presigned URL for uploading a file content to generate guide
2829
[**putConversationsSummariesSetting**](AIStudioApi#putConversationsSummariesSetting) | **PUT** /api/v2/conversations/summaries/settings/{summarySettingId} | Update a summary setting.
2930

3031

@@ -88,8 +89,6 @@ DELETE /api/v2/guides/{guideId}/jobs
8889

8990
Start the deletion of a guide.
9091

91-
deleteGuideJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
92-
9392
Requires ALL permissions:
9493

9594
* aiStudio:guideJob:add
@@ -252,8 +251,6 @@ GET /api/v2/guides/{guideId}
252251

253252
Get guide.
254253

255-
getGuide is a preview method and is subject to both breaking and non-breaking changes at any time without notice
256-
257254
Requires ALL permissions:
258255

259256
* aiStudio:guide:view
@@ -304,8 +301,6 @@ GET /api/v2/guides/{guideId}/jobs/{jobId}
304301

305302
Get the specified guide deletion job.
306303

307-
getGuideJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
308-
309304
Requires ALL permissions:
310305

311306
* aiStudio:guideJob:view
@@ -358,8 +353,6 @@ GET /api/v2/guides/{guideId}/versions/{versionId}
358353

359354
Get a guide version.
360355

361-
getGuideVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
362-
363356
Requires ALL permissions:
364357

365358
* aiStudio:guideVersion:view
@@ -412,8 +405,6 @@ GET /api/v2/guides/{guideId}/versions/{versionId}/jobs/{jobId}
412405

413406
Get the status of the publishing job for this guide version.
414407

415-
getGuideVersionJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
416-
417408
Requires ALL permissions:
418409

419410
* aiStudio:guideVersionJob:view
@@ -468,8 +459,6 @@ GET /api/v2/guides
468459

469460
Get all guides.
470461

471-
getGuides is a preview method and is subject to both breaking and non-breaking changes at any time without notice
472-
473462
Requires ALL permissions:
474463

475464
* aiStudio:guide:view
@@ -534,8 +523,6 @@ GET /api/v2/guides/jobs/{jobId}
534523

535524
Get the status of the guide content generation job.
536525

537-
getGuidesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
538-
539526
Requires ALL permissions:
540527

541528
* aiStudio:guideJob:view
@@ -586,8 +573,6 @@ PATCH /api/v2/guides/{guideId}
586573

587574
Update a guide.
588575

589-
patchGuide is a preview method and is subject to both breaking and non-breaking changes at any time without notice
590-
591576
Requires ALL permissions:
592577

593578
* aiStudio:guide:edit
@@ -640,8 +625,6 @@ PATCH /api/v2/guides/{guideId}/versions/{versionId}
640625

641626
Update a guide version.
642627

643-
patchGuideVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
644-
645628
Requires ALL permissions:
646629

647630
* aiStudio:guideVersion:edit
@@ -852,8 +835,6 @@ POST /api/v2/guides/{guideId}/versions/{versionId}/jobs
852835

853836
Start the publishing of a guide version.
854837

855-
postGuideVersionJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
856-
857838
Requires ALL permissions:
858839

859840
* aiStudio:guideVersionJob:add
@@ -908,8 +889,6 @@ POST /api/v2/guides/{guideId}/versions
908889

909890
Create a guide version.
910891

911-
postGuideVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
912-
913892
Requires ALL permissions:
914893

915894
* aiStudio:guideVersion:add
@@ -964,8 +943,6 @@ POST /api/v2/guides
964943

965944
Create a guide.
966945

967-
postGuides is a preview method and is subject to both breaking and non-breaking changes at any time without notice
968-
969946
Requires ALL permissions:
970947

971948
* aiStudio:guide:add
@@ -1016,8 +993,6 @@ POST /api/v2/guides/jobs
1016993

1017994
Start a guide content generation job.
1018995

1019-
postGuidesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1020-
1021996
Requires ALL permissions:
1022997

1023998
* aiStudio:guideJob:add
@@ -1059,6 +1034,56 @@ apiInstance.postGuidesJobs(body)
10591034
**GuideContentGenerationJob**
10601035

10611036

1037+
## postGuidesUploads
1038+
1039+
> UploadUrlResponse postGuidesUploads(body)
1040+
1041+
1042+
POST /api/v2/guides/uploads
1043+
1044+
Generate presigned URL for uploading a file content to generate guide
1045+
1046+
Requires ALL permissions:
1047+
1048+
* aiStudio:guide:upload
1049+
1050+
### Example Usage
1051+
1052+
```{"language":"javascript"}
1053+
// Browser
1054+
const platformClient = require('platformClient');
1055+
// Node
1056+
const platformClient = require('purecloud-platform-client-v2');
1057+
1058+
// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)
1059+
platformClient.ApiClient.instance.setAccessToken(yourAccessToken);
1060+
1061+
let apiInstance = new platformClient.AIStudioApi();
1062+
1063+
let body = {}; // Object | query
1064+
1065+
apiInstance.postGuidesUploads(body)
1066+
.then((data) => {
1067+
console.log(`postGuidesUploads success! data: ${JSON.stringify(data, null, 2)}`);
1068+
})
1069+
.catch((err) => {
1070+
console.log('There was a failure calling postGuidesUploads');
1071+
console.error(err);
1072+
});
1073+
```
1074+
1075+
### Parameters
1076+
1077+
1078+
| Name | Type | Description | Notes |
1079+
| ------------- | ------------- | ------------- | ------------- |
1080+
**body** | **Object** | query | |
1081+
1082+
### Return type
1083+
1084+
**UploadUrlResponse**
1085+
1086+
10621087
## putConversationsSummariesSetting
10631088

10641089
> SummarySetting putConversationsSummariesSetting(summarySettingId, body)
@@ -1111,4 +1136,4 @@ apiInstance.putConversationsSummariesSetting(summarySettingId, body)
11111136
**SummarySetting**
11121137

11131138

1114-
_purecloud-platform-client-v2@242.0.0_
1139+
_purecloud-platform-client-v2@243.0.0_

docs/AgentAssistantsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1273,4 +1273,4 @@ apiInstance.putAssistantsAgentchecklist(agentChecklistId, body)
12731273
**AgentChecklist**
12741274

12751275

1276-
_purecloud-platform-client-v2@242.0.0_
1276+
_purecloud-platform-client-v2@243.0.0_

docs/AgentCopilotApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,4 +166,4 @@ apiInstance.putAssistantCopilot(assistantId, body)
166166
**Copilot**
167167

168168

169-
_purecloud-platform-client-v2@242.0.0_
169+
_purecloud-platform-client-v2@243.0.0_

docs/AgentUIApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,4 +217,4 @@ apiInstance.putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body)
217217
**AutoAnswerSettings**
218218

219219

220-
_purecloud-platform-client-v2@242.0.0_
220+
_purecloud-platform-client-v2@243.0.0_

docs/AlertingApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -787,4 +787,4 @@ apiInstance.putAlertingRule(ruleId, body)
787787
**CommonRule**
788788

789789

790-
_purecloud-platform-client-v2@242.0.0_
790+
_purecloud-platform-client-v2@243.0.0_

docs/AnalyticsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6837,4 +6837,4 @@ apiInstance.putAnalyticsDataretentionSettings(body)
68376837
**AnalyticsDataRetentionResponse**
68386838

68396839

6840-
_purecloud-platform-client-v2@242.0.0_
6840+
_purecloud-platform-client-v2@243.0.0_

docs/ArchitectApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8348,4 +8348,4 @@ apiInstance.putFlowsOutcome(flowOutcomeId, opts)
83488348
**Operation**
83498349

83508350

8351-
_purecloud-platform-client-v2@242.0.0_
8351+
_purecloud-platform-client-v2@243.0.0_

docs/AuditApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -378,4 +378,4 @@ apiInstance.postAuditsQueryRealtimeRelated(body, opts)
378378
**AuditRealtimeRelatedResultsResponse**
379379

380380

381-
_purecloud-platform-client-v2@242.0.0_
381+
_purecloud-platform-client-v2@243.0.0_

docs/AuthorizationApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3231,4 +3231,4 @@ apiInstance.putUserRoles(subjectId, body)
32313231
**UserAuthorization**
32323232

32333233

3234-
_purecloud-platform-client-v2@242.0.0_
3234+
_purecloud-platform-client-v2@243.0.0_

0 commit comments

Comments
 (0)