Skip to content

Commit ed03c76

Browse files
AnasMationsAnasMations
committed
Docs Restructure
1 parent 839f4aa commit ed03c76

26 files changed

+340
-13
lines changed

‎.DS_Store

6 KB
Binary file not shown.

‎.vscode/settings.json

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"workbench.colorCustomizations": {
3+
"activityBar.background": "#153506",
4+
"titleBar.activeBackground": "#1E4A09",
5+
"titleBar.activeForeground": "#F3FDEE"
6+
}
7+
}

‎api-reference/available-faces.mdx ‎api-reference/create-agent.mdx

+21-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,24 @@
11
---
2-
title: 'Create Avatar'
3-
icon: person
4-
description: "Use our pre-made faces or create your own avatar"
2+
title: 'Create Agent'
3+
icon: "masks-theater"
4+
description: "Create your own Simli Agent"
55
---
6+
<Frame>
7+
<img src="/images/simli-screenshot1.jpg" />
8+
</Frame>
9+
10+
<Card title="Create Agent" icon="masks-theater" href="https://app.simli.com">
11+
Start creating your own Simli Agent here.
12+
</Card>
13+
14+
### Instructions
15+
1. Upload an image of the face you want to clone
16+
2. Image ratio should be ideally 1:1 (512px:512px)
17+
3. Click on the "Create Agent" button
18+
4. Wait for the agent to be created, this may take a few minutes
19+
5. Find your agent in the [Your Agents](https://app.simli.com) section
20+
21+
{/*
622
Create your own avatar here -> [app.simli.com](https://app.simli.com)
723
824
<CardGroup cols={4}>
@@ -42,4 +58,5 @@ Create your own avatar here -> [app.simli.com](https://app.simli.com)
4258
<Frame caption="Aunt Mimi: 11c30c18-86c3-424e-bb29-9c6d1fd6003b">
4359
<img src="https://firebasestorage.googleapis.com/v0/b/simliai2.appspot.com/o/public%2FAunt_Mimi.png?alt=media&token=9e418787-40c3-431d-8e8f-e064f068436c" />
4460
</Frame>
45-
</CardGroup>
61+
</CardGroup>
62+
*/}

‎api-reference/backend-authentication.mdx ‎api-reference/javascript-auth.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Backend Authentication
3-
icon: "code"
3+
icon: "js"
44
---
55

66
[SimliClient](https://github.com/simliai/simli-client) is awesome on it's own. However, it uses the API key directly on client-side which isn't so great for security as someone with a little bit of knowledge can get your API key. With SimliClient 1.2.7+, you can handle auth on your own backend by making the authentication request there and passing the session_token and ICE Config back to the client.

‎api-reference/simli-client.mdx ‎api-reference/javascript.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Javascript SDK
3-
icon: "code"
2+
title: JavaScript
3+
icon: "js"
44
---
55

66
[SimliClient](https://github.com/simliai/simli-client) is a powerful tool for integrating real-time audio and video streaming capabilities into your web applications using WebRTC. This guide will walk you through the process of setting up and using SimliClient in your project.

‎api-reference/python-sdk.mdx ‎api-reference/python.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Python SDK
3-
icon: "code"
2+
title: Python
3+
icon: "python"
44
---
55

66
The Simli WebRTC SDK is a powerful tool for integrating real-time audio and video streaming capabilities into your python applications using WebRTC. You can use this SDK to display a Simli outside the browser, save the stream into a file, or integrate your stream in your program however you want!

‎api-reference/samples.mdx ‎api-reference/samples/all-samples.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Starter Repos
3-
icon: "github"
2+
title: All Samples
3+
icon: "grid"
44
description: "Explore our open-source projects on GitHub integrating Simli with various AI agents"
55
---
66

‎api-reference/samples/livekit.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: "LiveKit"
3+
icon: "circle"
4+
url: "https://github.com/livekit/livekit"
5+
---

‎api-reference/samples/pipecat.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: "Pipecat"
3+
icon: "cat"
4+
url: "https://github.com/pipecat-ai/pipecat"
5+
---

‎api-reference/simli-auto.mdx

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Simli Auto
3+
icon: "code"
4+
iconType: "duotone"
5+
---
6+
7+
Auto content goes here

‎api-reference/swagger.mdx

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "Swagger"
3+
url: "https://api.simli.ai/docs#/"
4+
---

‎api-reference/widget.mdx

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: Simli Widget
3+
icon: "code"
4+
description: "Embed a Simli Agent on your website in a few minutes."
5+
---
6+
7+
<Frame>
8+
<video
9+
autoPlay
10+
muted
11+
loop
12+
playsInline
13+
className=""
14+
src="/images/widget1.mp4"
15+
></video>
16+
</Frame>
17+
18+
<Card title="Simli Widget" icon="code" href="https://app.simli.com">
19+
Start using the Simli Widget on your website.
20+
</Card>
21+
22+
Simli Widget is a simple and easy to use code embedding that allows you to embed a Simli Agent on any HTML website. It utilizes the Simli Auto API.
23+
## Supported platforms
24+
- Any website that supports HTML
25+
- WordPress
26+
- Shopify
27+
- Squarespace
28+
- Wix
29+
- Weebly
30+
31+
## How to use?
32+
- Create an Agent in the Simli app
33+
- Copy the embed code
34+
- Paste the embed code in the HTML of your website
35+
36+
<Info>
37+
Make sure to update the embded code on your website if you update your API Keys or Allowlist.
38+
</Info>
39+
40+
## Features
41+
42+
<CardGroup>
43+
<Card title="Customize widget appearance" icon="palette">
44+
<Frame>
45+
<video
46+
autoPlay
47+
muted
48+
loop
49+
playsInline
50+
className=""
51+
src="/images/widget2.mp4"
52+
></video>
53+
</Frame>
54+
</Card>
55+
56+
<Card title="Share Agent link" icon="link">
57+
<Frame>
58+
<video
59+
autoPlay
60+
muted
61+
loop
62+
playsInline
63+
className=""
64+
src="/images/widget3.mp4"
65+
></video>
66+
</Frame>
67+
</Card>
68+
</CardGroup>
69+
<Card title="Simli Widget" icon="code" href="https://app.simli.com">
70+
Start using the Simli Widget on your website.
71+
</Card>
72+

‎docs.json

+163
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
{
2+
"$schema": "https://mintlify.com/docs.json",
3+
"theme": "mint",
4+
"name": "Simli",
5+
"colors": {
6+
"primary": "#000000",
7+
"light": "#FFFFFF",
8+
"dark": "#000000"
9+
},
10+
"favicon": "/favicon.svg",
11+
"navigation": {
12+
"tabs": [
13+
{
14+
"tab": "Documentation",
15+
"pages": [
16+
{
17+
"group": "Get Started",
18+
"pages": [
19+
"overview",
20+
"api-reference/create-agent"
21+
]
22+
},
23+
{
24+
"group": "Use Simli Widget",
25+
"pages": [
26+
"api-reference/widget"
27+
]
28+
},
29+
{
30+
"group": "Use Simli Auto",
31+
"pages": [
32+
"api-reference/simli-auto"
33+
]
34+
},
35+
{
36+
"group": "Use an SDK",
37+
"pages": [
38+
{
39+
"group": "JavaScript",
40+
"icon": "js",
41+
"pages": [
42+
"api-reference/javascript",
43+
"api-reference/javascript-auth"
44+
]
45+
},
46+
"api-reference/python",
47+
{
48+
"group": "Starter repos",
49+
"icon": "github",
50+
"pages": [
51+
"api-reference/simli-agent",
52+
"api-reference/openAI",
53+
"api-reference/elevenlabs",
54+
"api-reference/samples/all-samples"
55+
]
56+
}
57+
]
58+
},
59+
{
60+
"group": "Links",
61+
"pages": [
62+
"api-reference/discord"
63+
]
64+
}
65+
]
66+
},
67+
{
68+
"tab": "API Reference",
69+
"pages": [
70+
{
71+
"group": "WebRTC API",
72+
"pages": [
73+
"api-reference/endpoint/textToVideoStream",
74+
"api-reference/endpoint/audioToVideoStream",
75+
"api-reference/endpoint/startAudioToVideoSession",
76+
"api-reference/endpoint/StartWebRTCSession",
77+
"api-reference/endpoint/getIceServers"
78+
]
79+
},
80+
{
81+
"group": "End 2 End API (Simli Auto)",
82+
"pages": [
83+
"api-reference/endpoint/startE2ESession",
84+
"api-reference/endpoint/customLLM"
85+
]
86+
},
87+
{
88+
"group": "Face ID Creation",
89+
"pages": [
90+
"api-reference/endpoint/generateFaceID",
91+
"api-reference/endpoint/getRequestStatus"
92+
]
93+
},
94+
{
95+
"group": "Integrate with Simli",
96+
"pages": [
97+
"api-reference/samples/pipecat",
98+
"api-reference/samples/livekit",
99+
{
100+
"group": "WebRTC Guides",
101+
"icon": "book",
102+
"pages": [
103+
"api-reference/simli-webrtc",
104+
"api-reference/webrtc-signaling-guide",
105+
"api-reference/WSDC_Migration_Guide",
106+
"api-reference/webrtc-info",
107+
"api-reference/audio-info"
108+
]
109+
}
110+
]
111+
},
112+
{
113+
"group": "Links",
114+
"pages": [
115+
"api-reference/swagger"
116+
]
117+
}
118+
]
119+
},
120+
{
121+
"tab": "Video Tutorials",
122+
"pages": [
123+
{
124+
"group": "Videos",
125+
"pages": [
126+
"video-section/tutorials",
127+
"video-section/showcase"
128+
]
129+
},
130+
{
131+
"group": "By Language",
132+
"pages": [
133+
"video-section/english",
134+
"video-section/arabic",
135+
"video-section/norwegian"
136+
]
137+
}
138+
]
139+
}
140+
]
141+
},
142+
"logo": {
143+
"light": "/logo/light.svg",
144+
"dark": "/logo/dark.svg"
145+
},
146+
"appearance": {
147+
"default": "dark",
148+
"strict": true
149+
},
150+
"navbar": {
151+
"links": [
152+
{
153+
"label": "Join our Discord",
154+
"href": "https://discord.gg/yQx49zNF4d"
155+
}
156+
],
157+
"primary": {
158+
"type": "button",
159+
"label": "Simli Dashboard",
160+
"href": "https://app.simli.com/"
161+
}
162+
}
163+
}

‎favicon.svg

+2-2
Loading

‎images/.DS_Store

6 KB
Binary file not shown.

‎images/simli banner.jpg

1.26 MB
Loading

‎images/simli banner.png

2.53 MB
Loading

‎images/simli-screenshot1.jpg

1.27 MB
Loading

‎images/simli_hook.jpg

2.23 MB
Loading

‎images/widget1.mp4

2.05 MB
Binary file not shown.

‎images/widget2.mp4

1.59 MB
Binary file not shown.

‎images/widget3.mp4

1.41 MB
Binary file not shown.

‎overview.mdx

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Welcome to Simli
3+
icon: "flag"
4+
description: "The API devs use to add faces to realtime AI agents"
5+
---
6+
7+
<img noZoom src="/images/simli banner.jpg" alt="Simli. Avatars. Face. Create. Realtime" height={20} />
8+
9+
The Simli speech-to-video API lets developers create lip-synced AI avatar interactions. With visual AI avatars, you can create anything! Mock interviews, sales assistants, language learning, coaching, customer-service training, historical characters, and so much more. To see it in action first, [try our demo](https://www.simli.com/demo).
10+
Ready to make your first one?
11+
12+
<Card title="Use Simli Widget" icon="code" href="/api-reference/widget">
13+
Embed a Simli Agent on your website in a few minutes.
14+
</Card>
15+
16+
<CardGroup cols={2}>
17+
18+
<Card title="Use Simli Auto" icon="code" iconType="duotone" href="/api-reference/simli-auto">
19+
Recommended if you want to develop a custom interface for your Simli Agent.
20+
</Card>
21+
22+
<Card title="Use an SDK" icon="js" href="/api-reference/javascript">
23+
Recommended if you're adding a Simli Face to your own custom Agent stack.
24+
</Card>
25+
26+
</CardGroup>
27+
28+
#
29+
30+
<Card title="Join our community" icon="discord" href="https://discord.gg/yQx49zNF4d">
31+
Share your projects, get technical help, and stay up-to-date with the latest features.
32+
</Card>

‎video-section/showcase.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: 'Community Showcase'
3+
icon: "video"
4+
description: "Video showcase for Simli"
5+
---

0 commit comments

Comments
 (0)