Create Pre-built UI using Experience API

This API returns the URL of the different Summary UIs depending upon the user request body.

HTTP REQUEST#

POST https://api.symbl.ai/v1/conversations/{conversationId}/experiences

Example API Call#

// Video Summary
curl --location --request POST 'https://api.symbl.ai/v1/conversations/{conversationId}/experiences' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <generated_valid_token>' \
--data-raw '{
"name": "video-summary",
"videoUrl": "https://storage.googleapis.com/rammer-transcription-bucket/small.mp4",
"logo": "https://symblsanitydataset.s3.us-east-2.amazonaws.com/googleImage.webp",
"favicon" :"https://symblsanitydataset.s3.us-east-2.amazonaws.com/googleImage.webp",
"color": {
"background": "#0A2136",
"topicsFilter": "#FF0000",
"insightsFilter": "#FF0000"
},
"font": {
"family": "roboto"
}
}'
// Verbose text summary
curl --location --request POST 'https://api.symbl.ai/v1/conversations/{conversationId}/experiences' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <generated_valid_token>' \
--data-raw '{
"name": "verbose-text-summary",
"logo": "https://symblsanitydataset.s3.us-east-2.amazonaws.com/googleImage.webp",
"favicon" :"https://symblsanitydataset.s3.us-east-2.amazonaws.com/googleImage.webp",
"color": {
"background": "#0A2136",
"topicsFilter": "#FF0000",
"insightsFilter": "#FF0000"
},
"font": {
"family": "roboto"
}
}'

Response#

Response for verbose-text-summary

{
"name": "verbose-text-summary",
"url": "https://meetinginsights.symbl.ai/meeting/#/eyJzZXNzaW9uSWQiOiI0NTMyNTY2NDc2NDU1OTM2In0="
}

Response for video-summary

{
"name": "video-summary",
"url": "https://meetinginsights.symbl.ai/meeting/#/eyJzZXNzaW9uSWQiOiI1ODU5NjczMDg1MzEzMDI0IiwidmlkZW9VcmwiOiJodHRwczovL3N0b3JhZ2UuZ29vZ2xlYXBpcy5jb20vcmFtbWVyLXRyYW5zY3JpcHRpb24tYnVja2V0L3NtYWxsLm1wNCJ9?showVideoSummary=true"
}

Request Headers#

MethodREQUIREDValue
x-api-keytrue"Valid Token"
Content-Typetrueapplication/json

Request Body#

FieldREQUIREDTypeDescription
nametruestringFor Summary UI use 'verbose-text-summary' and for Video Summary UI use 'video-summary'.
videoUrlfalsestringThis field is only required when the field 'name' is set to 'video-summary'.
logofalsestringThis field accepts public URL for setting custom logo in Video Summary UI(video-summary) or Summary UI(verbose-text-summary).
faviconfalsestringThis field accepts public URL for setting custom favicon in Video Summary UI (video-summary) or Summary UI(verbose-text-summary).
colorfalseObjectThis option can be used to customise the colors of UI background, topics filter and insights filter elements in UI.
fontfalseObjectYou can directly set any Google Fonts by passing the name of the font.

color object#

FieldDescription
background This field changes the background color of the UI. It accept color in Hex Color Code. For example "#0A2136".
topicsFilterThis field changes the color of the topics filter element. It accept color in Hex Color Code. For example "#FF0000".
insightsFilterThis field changes the color of the insights(includes action items, follow ups, ideas, etc.) filter element. It accept color in Hex Color Code. For example "#FF0000".

font object#

FieldDescription
familyThe name of the font available in Google Fonts. This key changes the font family of the whole UI. For example: "roboto"