{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants AI Studio API", "version": "v2" }, "items": [ { "info": { "name": "AI Studio", "type": "folder" }, "items": [ { "info": { "name": "Trigger summary preview event generation.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/summaries/preview" }, "docs": "Trigger summary preview event generation." }, { "info": { "name": "Get all summary settings.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/summaries/settings", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number." }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The maximum page size is 100." }, { "name": "name", "value": "", "type": "query", "description": "Filter by partially matching name - case insensitive." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort Order. Default value desc." }, { "name": "language", "value": "", "type": "query", "description": "Filter by matching language - case insensitive." }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by. Default value dateModified." } ] }, "docs": "Get all summary settings." }, { "info": { "name": "Create a summary setting.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/conversations/summaries/settings" }, "docs": "Create a summary setting." }, { "info": { "name": "Receive a summary setting.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/conversations/summaries/settings/:summarySettingId", "params": [ { "name": "summarySettingId", "value": "", "type": "path", "description": "Summary setting id" } ] }, "docs": "Receive a summary setting." }, { "info": { "name": "Update a summary setting.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/conversations/summaries/settings/:summarySettingId", "params": [ { "name": "summarySettingId", "value": "", "type": "path", "description": "Summary setting id" } ] }, "docs": "Update a summary setting." }, { "info": { "name": "Delete a summary setting.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/conversations/summaries/settings/:summarySettingId", "params": [ { "name": "summarySettingId", "value": "", "type": "path", "description": "Summary setting id" } ] }, "docs": "Delete a summary setting." }, { "info": { "name": "Get guide.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/guides/:guideId", "params": [ { "name": "guideId", "value": "", "type": "path", "description": "Guide ID" } ] }, "docs": "Get guide." }, { "info": { "name": "Update a guide.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/guides/:guideId", "params": [ { "name": "guideId", "value": "", "type": "path", "description": "Guide ID" } ] }, "docs": "Update a guide." }, { "info": { "name": "Start the deletion of a guide.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/guides/:guideId/jobs", "params": [ { "name": "guideId", "value": "", "type": "path", "description": "Guide ID" } ] }, "docs": "Start the deletion of a guide." }, { "info": { "name": "Get the specified guide deletion job.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/guides/:guideId/jobs/:jobId", "params": [ { "name": "guideId", "value": "", "type": "path", "description": "Guide ID" }, { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get the specified guide deletion job." }, { "info": { "name": "Add a turn to a guide session.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/guides/:guideId/sessions/:guideSessionId/turns", "params": [ { "name": "guideId", "value": "", "type": "path", "description": "Guide ID" }, { "name": "guideSessionId", "value": "", "type": "path", "description": "Guide Session ID" } ] }, "docs": "Creates a new turn in the specified guide session with the provided request data. If the session ID doesn't exist, a new session will be created automatically." }, { "info": { "name": "Get a guide version.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/guides/:guideId/versions/:versionId", "params": [ { "name": "guideId", "value": "", "type": "path", "description": "Guide ID" }, { "name": "versionId", "value": "", "type": "path", "description": "Version ID" } ] }, "docs": "Get a guide version." }, { "info": { "name": "Update a guide version.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/guides/:guideId/versions/:versionId", "params": [ { "name": "guideId", "value": "", "type": "path", "description": "Guide ID" }, { "name": "versionId", "value": "", "type": "path", "description": "Version ID" } ] }, "docs": "Update a guide version." }, { "info": { "name": "Start the publishing of a guide version.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/guides/:guideId/versions/:versionId/jobs", "params": [ { "name": "guideId", "value": "", "type": "path", "description": "Guide ID" }, { "name": "versionId", "value": "", "type": "path", "description": "Version ID" } ] }, "docs": "Start the publishing of a guide version." }, { "info": { "name": "Get the status of the publishing job for this guide version.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/guides/:guideId/versions/:versionId/jobs/:jobId", "params": [ { "name": "guideId", "value": "", "type": "path", "description": "Guide ID" }, { "name": "versionId", "value": "", "type": "path", "description": "Version ID" }, { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get the status of the publishing job for this guide version." }, { "info": { "name": "Create a guide version.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/guides/:guideId/versions", "params": [ { "name": "guideId", "value": "", "type": "path", "description": "Guide ID" } ] }, "docs": "Create a guide version." }, { "info": { "name": "Start a guide content generation job.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/guides/jobs" }, "docs": "Start a guide content generation job." }, { "info": { "name": "Get the status of the guide content generation job.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/guides/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get the status of the guide content generation job." }, { "info": { "name": "Get all guides.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/guides", "params": [ { "name": "name", "value": "", "type": "query", "description": "Filter by matching name - case insensitive." }, { "name": "nameContains", "value": "", "type": "query", "description": "Filter by name contains - case insensitive." }, { "name": "status", "value": "", "type": "query", "description": "Filter by status." }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by. Default value dateModified." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort Order. Default value desc." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number." }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The maximum page size is 100." } ] }, "docs": "Get all guides." }, { "info": { "name": "Create a guide.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/guides" }, "docs": "Create a guide." }, { "info": { "name": "Generate presigned URL for uploading a file content to generate guide", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/guides/uploads" }, "docs": "Generate presigned URL for uploading a file content to generate guide" } ] } ], "bundled": true }