Create Pre-built UI using Experience API
This API returns the URL of the different Summary UIs depending upon the user request body.
#
HTTP REQUESTPOST
https://api.symbl.ai/v1/conversations/{conversationId}/experiences
#
Example API Call- cURL
- Javascript
#
ResponseResponse for verbose-text-summary
Response for video-summary
#
Request HeadersMethod | REQUIRED | Value |
---|---|---|
x-api-key | true | "Valid Token" |
Content-Type | true | application/json |
#
Request BodyField | REQUIRED | Type | Description |
---|---|---|---|
name | true | string | For Summary UI use 'verbose-text-summary' and for Video Summary UI use 'video-summary'. |
videoUrl | false | string | This field is only required when the field 'name' is set to 'video-summary'. |
logo | false | string | This field accepts public URL for setting custom logo in Video Summary UI(video-summary) or Summary UI(verbose-text-summary). |
favicon | false | string | This field accepts public URL for setting custom favicon in Video Summary UI (video-summary) or Summary UI(verbose-text-summary). |
color | false | Object | This option can be used to customise the colors of UI background, topics filter and insights filter elements in UI. |
font | false | Object | You can directly set any Google Fonts by passing the name of the font. |
#
color objectField | Description |
---|---|
background | This field changes the background color of the UI. It accept color in Hex Color Code. For example "#0A2136" . |
topicsFilter | This field changes the color of the topics filter element. It accept color in Hex Color Code. For example "#FF0000" . |
insightsFilter | This 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 objectField | Description |
---|---|
family | The name of the font available in Google Fonts. This key changes the font family of the whole UI. For example: "roboto" |