2025 November Week 2 release: Updates to existing APIs
Summary: Updated APIs for Document Generator Express. Updated APIs for Integration. Updated APIs for Search.
Document Generator Express
What's New
GET /livedocs-express/v2/teamsites/{teamsiteId}/batchInstances/{batchInstanceId}/downloadURLs
GET /livedocs-express/v2/teamsites/{teamsiteId}/batchInstances/{batchInstanceId}/downloadURLsGet download URLs from job
What's Changed
GET /livedocs-express/v2/teamsites/{teamsiteId}/batches/{batchId}/variants
GET /livedocs-express/v2/teamsites/{teamsiteId}/batches/{batchId}/variantsReturn Type:
Changed response : 200 OK
OK
- Changed content type :
application/json- Changed property
items(array)
Changed items (object):- Added property
adhocInputs(array)
Items (object):- Property
id(string) - Property
name(string) - Property
type(string) - Property
value(string)
- Property
- Added property
properties(array)
Items (object):- Property
id(string) - Property
name(string) - Property
type(string) - Property
values(array)
Items (string):
- Property
- Added property
- Changed property
PUT /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/variants/{variantId}
PUT /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/variants/{variantId}Request:
Changed content type : application/json
- Changed property
output(object)- Added property
uploadTolibrary(boolean)
- Added property
PUT /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/bulkVariants
PUT /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/bulkVariantsRequest:
Changed content type : application/json
- Changed property
output(object)- Added property
uploadTolibrary(boolean)
- Added property
GET /livedocs-express/v2/teamsites/{teamsiteId}/batchInstances/{batchInstanceId}/variantInstances
GET /livedocs-express/v2/teamsites/{teamsiteId}/batchInstances/{batchInstanceId}/variantInstancesReturn Type:
Changed response : 200 OK
OK
- Changed content type :
application/json- Added property
id(string) - Added property
createdAt(string) - Added property
createdBy(string) - Added property
modifiedAt(string) - Added property
modifiedBy(string) - Added property
completedAt(string) - Added property
teamsiteId(string) - Added property
batchInstanceId(string) - Added property
libraryContentId(string) - Added property
libraryContentVersionId(string) - Added property
content(object)- Property
experts(array) - Property
ownerId(string) - Property
expiresAt(string) - Property
externalId(string) - Property
description(string) - Property
parentFolderId(string) - Property
parentFolderName(string) - Property
externalConnectionId(string)
- Property
- Added property
output(object)- Property
name(string) - Property
format(string) - Property
pptxOptions(object)- Property
imageDpi(number) - Property
clearNotes(boolean)
- Property
- Property
uploadTolibrary(boolean)
- Property
- Added property
status(string) - Added property
error(string) - Added property
document_uri(string) - Added property
fileId(string) - Added property
outputVersionId(string) - Added property
outputVersion(string) - Added property
livedocVersion(number) - Deleted property
total(number) - Deleted property
limit(number) - Deleted property
offset(number) - Changed property
items(array)
Changed items (object):- Added property
adhocInputs(array)
Items (object):- Property
id(string) - Property
name(string) - Property
type(string) - Property
value(string)
- Property
- Added property
properties(array)
Items (object):- Property
id(string) - Property
name(string) - Property
type(string) - Property
values(array)
- Property
- Added property
blobId(string) - Changed property
output(object)- Added property
uploadTolibrary(boolean)
- Added property
- Added property
- Added property
GET /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/variants
GET /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/variantsReturn Type:
Changed response : 200 OK
OK
- Changed content type :
application/json- Changed property
items(array)
Changed items (object):- Added property
adhocInputs(array)
Items (object):- Property
id(string) - Property
name(string) - Property
type(string) - Property
value(string)
- Property
- Changed property
content(object)- Added property
properties(array)
Items (object):- Property
id(string) - Property
name(string) - Property
type(string) - Property
values(array)
- Property
- Added property
- Changed property
output(object)- Added property
uploadTolibrary(boolean)
- Added property
- Added property
- Changed property
POST /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/variants
POST /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/variantsRequest:
Changed content type : application/json
Changed items (object):
- Changed property
output(object)- Added property
uploadTolibrary(boolean)
- Added property
Return Type:
Changed response : 200 OK
OK
- Changed content type :
application/json
Changed items (object):- Changed property
output(object)- Added property
uploadTolibrary(boolean)
- Added property
- Changed property
GET /livedocs-express/v2/teamsites/{teamsiteId}/batches
GET /livedocs-express/v2/teamsites/{teamsiteId}/batchesReturn Type:
Changed response : 200 OK
OK
- Changed content type :
application/json- Changed property
items(array)
Changed items (object):- Added property
LiveDocs(array)
Items (object):- Property
libraryContentId(string)
- Property
- Added property
- Changed property
POST /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/variants/copy
POST /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/variants/copyReturn Type:
Changed response : 200 OK
OK
- Changed content type :
application/json- Changed property
items(array)
Changed items (object):- Changed property
output(object)- Added property
uploadTolibrary(boolean)
- Added property
- Changed property
- Changed property
GET /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/variantInstances
GET /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/variantInstancesReturn Type:
Changed response : 200 OK
OK
- Changed content type :
application/json- Changed property
items(array)
Changed items (object):- Added property
blobId(string) - Changed property
output(object)- Added property
uploadTolibrary(boolean)
- Added property
- Added property
- Changed property
GET /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/variantInstances/{variantInstanceId}
GET /livedocs-express/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}/variantInstances/{variantInstanceId}Return Type:
Changed response : 200 OK
OK
- Changed content type :
application/json- Changed property
items(array)
Changed items (object):- Added property
blobId(string) - Changed property
output(object)- Added property
uploadTolibrary(boolean)
- Added property
- Added property
- Changed property
Integration
What's Changed
GET /integration/v2/generatedLivedocs/{generatedLivedocId}
GET /integration/v2/generatedLivedocs/{generatedLivedocId}Return Type:
Changed response : 200 OK
OK
- Changed content type :
application/json- Changed property
outputs(array)
Changed items (object):- Deleted property
errorString(string)
- Deleted property
- Changed property
POST /integration/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}
POST /integration/v2/teamsites/{teamsiteId}/livedocVersions/{libraryContentVersionId}Parameters:
Changed: liveFormSellerTemplateId in query
This is an optional parameter. If a LiveFormSellerTemplateID is passed in, the LiveDoc will be generated based on the LiveForm Seller Template configuration, otherwise, the LiveDoc will be generated through input variables.
Search
What's Changed
POST /v1/content/query
POST /v1/content/queryRequest:
Changed content type : application/json
- Changed property
options(object)- Added property
enableSuggestedQueryResults(boolean)When true, if the initial search returns no results, the service will attempt to retrieve results based on related suggested terms
- Added property
- Changed property
filter(object)
Return Type:
Changed response : 200 OK
OK
- Changed content type :
application/json; charset=utf-8- Added property
actualSearchTerm(string)The search term that was actually used to retrieve results when enableSuggestedQueryResults is true and suggested terms were used
- Changed property
documents(array)
Changed items (object):- Added property
pageThumbnailUrls(array)
Items (string):
- Added property
- Added property