post
https://api.seismic.com/guided-assembly/v1/teamsites//contentversions//generations
This is where you start a generation, with the selected set of options that are passed as an answer to each question. If no option is provided for a given question, then the document will generate all options for that question. This can lead to large presentations to be generated (>150 slides), so recommendation is to at least select options for where dataType is PreliminaryQuestion or Category.
Each of the desired outputs must be specified in the "outputs" array. If you do not specify any outputs, this endpoint will return a 4xx error. Note: Generated outputs are only available for download for 4 hours from time of generation.
You also need to use Get status of Presentation Builder Generation to get the generation status. If it is Ready, you can download particular output from a Presentation Builder generation to get the gererated file
BODY PARAMETER DEFINITIONS
Request body example
{
"sourceDocumentType": "Article",
"sourceTeamSiteId": "e262c538-53cc-437d-adf9-f8b2b1a6bedb",
"sourceContentVersionId": "b3d8b711-0631-4305-9fb3-2f7fa21c1cc7",
"corePayload": {
"documentProperties": {
"desireDocumentFormat": "PPTX",
"fileName": "fileName",
"folderId": "DraftPresentationFolder"
},
"sections": [
{
"sectionId": "7cddb241-7bef-4bf9-85f5-db968dc3ae17",
"slides": [
{
"questionId": "95f1cee3-d7aa-40f0-9dba-3b46c595afd8",
"contentId": "374eeaad-f75d-4fe6-a71e-b11ee79ad67c",
"versionId": "34da8da6-6e23-4b4d-aa49-b5a19e959894",
"index": 0
},
{
"questionId": "95f1cee3-d7aa-40f0-9dba-3b46c595afd8",
"contentId": "374eeaad-f75d-4fe6-a71e-b11ee79ad67c",
"versionId": "34da8da6-6e23-4b4d-aa49-b5a19e959894",
"index": 1
},
{
"questionId": "9f017bdc-6341-4ff3-aace-a6e74ba66b81",
"contentId": "eada8e8f-68b8-4963-b81c-e64489e8cbfc",
"versionId": "abc40258-6e0b-4633-a985-c4dac9d16254",
"index": 0
}
]
}
],
"variableValues": [
{
"variableId": "dcefb57b-72da-4b95-816e-dca6bdd62f7c",
"value": "hello"
},
{
"variableId": "0add41da-9b76-456f-beba-0ff79d7140a4",
"value": "seismic"
}
]
}
}
The resourceVariables field of the input list you can use variableValues to set
[
{
"resourceId": "34da8da6-6e23-4b4d-aa49-b5a19e959894",
"inlineVariables": [
{
"id": "dcefb57b-72da-4b95-816e-dca6bdd62f7c",
"name": "Inline.A1",
"variableType": "inlineText",
"valueType": "string",
"text": "A1"
},
{
"id": "0add41da-9b76-456f-beba-0ff79d7140a4",
"name": "Inline.A2",
"variableType": "inlineText",
"valueType": "string",
"text": "A2"
},
{
"id": "a0602300-d40a-4ae9-b981-19f8c85835ab",
"name": "Inline.A3",
"variableType": "inlineText",
"valueType": "string",
"text": "A3"
},
{
"id": "1c45c08d-65b1-4bc2-af67-5d2e882d8e00",
"name": "Inline.A4",
"variableType": "inlineText",
"valueType": "string",
"text": "A4"
},
{
"id": "ef68869f-e71c-4b84-bc77-912f18fcfe25",
"name": "Inline.A5",
"variableType": "inlineText",
"valueType": "string",
"text": "A5"
}
],
"slides": [
{
"index": 0,
"variableAreas": [
{
"variableId": "dcefb57b-72da-4b95-816e-dca6bdd62f7c",
"variableFullName": "Inline.A1",
"areas": [
[
[
0.3925,
0.5746667
],
[
0.43525,
0.5746667
],
[
0.43525,
0.61466664
],
[
0.3925,
0.61466664
]
]
]
}
]
},
{
"index": 1,
"variableAreas": [
{
"variableId": "0add41da-9b76-456f-beba-0ff79d7140a4",
"variableFullName": "Inline.A2",
"areas": [
[
[
0.3925,
0.5746667
],
[
0.43525,
0.5746667
],
[
0.43525,
0.61466664
],
[
0.3925,
0.61466664
]
]
]
}
]
},
{
"index": 2,
"variableAreas": [
{
"variableId": "a0602300-d40a-4ae9-b981-19f8c85835ab",
"variableFullName": "Inline.A3",
"areas": [
[
[
0.3925,
0.5746667
],
[
0.43525,
0.5746667
],
[
0.43525,
0.61466664
],
[
0.3925,
0.61466664
]
]
]
}
]
},
{
"index": 3,
"variableAreas": [
{
"variableId": "1c45c08d-65b1-4bc2-af67-5d2e882d8e00",
"variableFullName": "Inline.A4",
"areas": [
[
[
0.3925,
0.5746667
],
[
0.43525,
0.5746667
],
[
0.43525,
0.61466664
],
[
0.3925,
0.61466664
]
]
]
}
]
},
{
"index": 4,
"variableAreas": [
{
"variableId": "ef68869f-e71c-4b84-bc77-912f18fcfe25",
"variableFullName": "Inline.A5",
"areas": [
[
[
0.3925,
0.5746667
],
[
0.43525,
0.5746667
],
[
0.43525,
0.61466664
],
[
0.3925,
0.61466664
]
]
]
}
]
}
]
}
]
"variableValues": [
{
"variableId": "dcefb57b-72da-4b95-816e-dca6bdd62f7c",
"value": "hello"
},
{
"variableId": "0add41da-9b76-456f-beba-0ff79d7140a4",
"value": "seismic"
}
]
Response example
{
"generationId": "3e811b3b-f7f4-4624-ad78-dd1692615aa4",
"sourceDocumentType": "Article",
"sourceTeamSiteId": "e262c538-53cc-437d-adf9-f8b2b1a6bedb",
"sourceContentVersionId": "86f53c0d-b9e4-4f19-acce-965c902db343"
}
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…