Skip to main content

Create Pre-built UI using Experience API


This API returns the URL of the Video Summary UI and Text Summary UI.

Video Summary UI Sample#

Video Summary UI

HTTP REQUEST#

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

Sample Request#

info

Before using the API you must get the authentication token (AUTH_TOKEN) from our authentication process.

Video Summary UI#

curl --location --request POST "https://api.symbl.ai/v1/conversations/$CONVERSATION_ID/experiences" \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $AUTH_TOKEN" \
--data-raw '{
"name": "video-summary",
"videoUrl": "https://storage.googleapis.com/rammer-transcription-bucket/small.mp4",
"logo": "https://symblsanitydata.s3.us-east-2.amazonaws.com/symbl-logo.png",
"favicon" :"https://symblsanitydata.s3.us-east-2.amazonaws.com/symbl-favicon.png",
"color": {
"background": "#0A2136",
"topicsFilter": "#FF0000",
"insightsFilter": "#FF0000"
},
"font": {
"family": "roboto"
},
"readOnly": true
}
}'

Text Summary UI#

curl --location --request POST "https://api.symbl.ai/v1/conversations/$CONVERSATION_ID/experiences" \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $AUTH_TOKEN" \
--data-raw '{
"name": "verbose-text-summary",
"logo": "https://symblsanitydata.s3.us-east-2.amazonaws.com/symbl-logo.png",
"favicon" :"https://symblsanitydata.s3.us-east-2.amazonaws.com/symbl-favicon.png",
"color": {
"background": "#0A2136",
"topicsFilter": "#FF0000",
"insightsFilter": "#FF0000"
},
"font": {
"family": "roboto"
},
"readOnly": true
}
}'

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
AuthorizationYesBearer <token> The token you get from our authentication process.
Content-TypeYesThe only current valid type is application/json.
x-api-keyNoDEPRECATED. The JWT token you get from our authentication process.

Request Body#

FieldREQUIREDTypeDescription
nameMandatoryStringFor Summary UI use verbose-text-summary and for Video Summary UI use video-summary.
videoUrlOptionalStringThis field is only required when the field name is set to video-summary.
logoOptionalStringThis field accepts public URL for setting custom logo in Video Summary UI(video-summary) or Summary UI(verbose-text-summary).
faviconOptionalStringThis field accepts public URL for setting custom favicon in Video Summary UI (video-summary) or Summary UI(verbose-text-summary).
colorOptionalObjectThis option can be used to customise the colors of UI background, topics filter and insights filter elements in UI.
fontOptionalObjectYou can directly set any Google Fonts by passing the name of the font.
summaryURLExpiresInOptionalNumberThis sets the expiry time for the summary URL. It is interpreted as seconds. If the value 0 is passed the URL will never expire. Default time for a URL to expire is 2592000 which is 30 days.
readOnlyOptionalBooleanSetting this parameter to true generates a non-editable, read-only version of the video-summary and verbose-text-summary. It is defaulted to false. Note that this feature does not have any impact on the existing summary URLs that have already been generated.

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"
caution

disableSummaryURLAuthentication is not supported as we accept only secure URL generation to comply with the mandatory security requirements.