Skip to content

added more details to widget docs #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

added more details to widget docs #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
9 changes: 6 additions & 3 deletions widget.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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. <br></br>
Just navigate to the widget section after clicking your avatar and you'll find readymade widget code you can add to any html page!"
---

<Frame>
Expand Down Expand Up @@ -66,12 +67,13 @@ The Simli Widget can be customized using various parameters in the embed code. H
overlay="false"
>
</simli-widget>
<script src="https://app.simli.com/simli-widget/index.js" async type="text/javascript"></script>
```

### 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. <br></br> Refer to our [API doc](/api-reference/endpoint/simli-auto/token) for retrieving the token
- `agentid` (required): The unique identifier of your Simli Agent. <br></br> You can find your agent ID by clicking an avatar

#### Default Mode
- `position`: Controls the widget's position on the page
Expand All @@ -93,6 +95,7 @@ The Simli Widget can be customized using various parameters in the embed code. H
overlay="true"
>
</simli-widget>
<script src="https://app.simli.com/simli-widget/index.js" async type="text/javascript"></script>
```

<Card title="Simli Widget" icon="code" href="https://app.simli.com">
Expand Down