From eb7a59abd0e06956ad3a260e23bc948119ab31da Mon Sep 17 00:00:00 2001 From: fadyesk12 <136813453+fadyesk12@users.noreply.github.com> Date: Tue, 8 Jul 2025 13:59:07 +0300 Subject: [PATCH] added more details to widget docs --- api-reference/openapi.json | 3 ++- widget.mdx | 9 ++++++--- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/api-reference/openapi.json b/api-reference/openapi.json index 393eff3..0e93dd7 100644 --- a/api-reference/openapi.json +++ b/api-reference/openapi.json @@ -660,7 +660,8 @@ } ], "title": "Expirystamp", - "default": -1 + "default": -1, + "description": "The expiry stamp uses Unix timestamps so make sure you have a valid timestamp in your request" }, "simliAPIKey": { "type": "string", diff --git a/widget.mdx b/widget.mdx index 0df309e..7d8af74 100644 --- a/widget.mdx +++ b/widget.mdx @@ -1,7 +1,8 @@ --- title: Embed a Widget icon: "message-smile" -description: "Embed a Simli Avatar on your website in a few minutes using Simli Auto." +description: "Embed a Simli Avatar on your website in a few minutes using Simli Auto.

+Just navigate to the widget section after clicking your avatar and you'll find readymade widget code you can add to any html page!" --- @@ -66,12 +67,13 @@ The Simli Widget can be customized using various parameters in the embed code. H overlay="false" > + ``` ### Parameters -- `token` (required): Your Simli API token for authentication -- `agentid` (required): The unique identifier of your Simli Agent +- `token` (required): Your Simli API token for authentication.

Refer to our [API doc](/api-reference/endpoint/simli-auto/token) for retrieving the token +- `agentid` (required): The unique identifier of your Simli Agent.

You can find your agent ID by clicking an avatar #### Default Mode - `position`: Controls the widget's position on the page @@ -93,6 +95,7 @@ The Simli Widget can be customized using various parameters in the embed code. H overlay="true" > + ```