Skip to content

Commit 94d7ddc

Browse files
AnasMationsAnasMations
committedApr 4, 2024·
Quick start and Endpoints
1 parent a83817e commit 94d7ddc

8 files changed

+236
-254
lines changed
 

‎api-reference/endpoint/getPossibleFaceIDs.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
---
2-
title: '/getPossibleFaceIDs'
2+
title: 'Face IDs'
33
openapi: 'GET /getPossibleFaceIDs'
44
---

‎api-reference/endpoint/getPossibleVoiceIDs.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
---
2-
title: '/getPossibleVoiceIDs'
3-
openapi: 'GET /plants'
2+
title: 'Voice IDs'
3+
openapi: 'GET /getPossibleVoiceIDs'
44
---

‎api-reference/endpoint/isSessionAvailable.mdx

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
2-
title: '/isSessionAvailable'
3-
openapi: 'POST /plants'
2+
title: 'Sessions Availability'
3+
description: "API to check sessions availability before starting a session"
4+
openapi: 'POST /isSessionAvailable'
45
---

‎api-reference/endpoint/startSession.mdx

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
---
2-
title: '/startSession'
3-
openapi: 'POST /plants'
2+
title: 'Start Session'
3+
description: "API to start a virtual meeting call with a custom made character"
4+
openapi: 'POST /startSession'
45
---
6+
7+
We recommed checking out [Quick Start](/quickstart) to familiarize yourself with the our API before getting started

‎api-reference/openapi.json

+132-156
Original file line numberDiff line numberDiff line change
@@ -1,225 +1,201 @@
11
{
2-
"openapi": "3.0.1",
2+
"openapi": "3.0.0",
33
"info": {
4-
"title": "OpenAPI Plant Store",
5-
"description": "A sample API that uses a plant store as an example to demonstrate features in the OpenAPI specification",
6-
"license": {
7-
"name": "MIT"
8-
},
4+
"title": "API Documentation",
5+
"description": "Documentation for API endpoints",
96
"version": "1.0.0"
107
},
118
"servers": [
129
{
13-
"url": "http://sandbox.mintlify.com"
14-
}
15-
],
16-
"security": [
17-
{
18-
"bearerAuth": []
10+
"url": "http://35.214.172.224:8080"
1911
}
2012
],
2113
"paths": {
22-
"/plants": {
23-
"get": {
24-
"description": "Returns all plants from the system that the user has access to",
25-
"parameters": [
26-
{
27-
"name": "limit",
28-
"in": "query",
29-
"description": "The maximum number of results to return",
30-
"schema": {
31-
"type": "integer",
32-
"format": "int32"
14+
"/isSessionAvailable": {
15+
"post": {
16+
"summary": "Check if session is available",
17+
"requestBody": {
18+
"content": {
19+
"application/json": {
20+
"schema": {
21+
"type": "object",
22+
"properties": {
23+
"apiKey": {
24+
"type": "string"
25+
}
26+
},
27+
"required": ["apiKey"]
28+
}
3329
}
3430
}
35-
],
31+
},
3632
"responses": {
3733
"200": {
38-
"description": "Plant response",
34+
"description": "Session availability response",
3935
"content": {
4036
"application/json": {
4137
"schema": {
42-
"type": "array",
43-
"items": {
44-
"$ref": "#/components/schemas/Plant"
38+
"type": "object",
39+
"properties": {
40+
"isAvailable": {
41+
"type": "boolean"
42+
}
4543
}
4644
}
4745
}
4846
}
49-
},
50-
"400": {
51-
"description": "Unexpected error",
47+
}
48+
}
49+
}
50+
},
51+
"/getPossibleFaceIDs": {
52+
"get": {
53+
"summary": "Get possible face IDs",
54+
"parameters": [
55+
{
56+
"name": "apiKey",
57+
"in": "query",
58+
"required": true,
59+
"schema": {
60+
"type": "string"
61+
}
62+
}
63+
],
64+
"responses": {
65+
"200": {
66+
"description": "List of possible face IDs",
5267
"content": {
5368
"application/json": {
5469
"schema": {
55-
"$ref": "#/components/schemas/Error"
70+
"type": "object",
71+
"properties": {
72+
"faceIDs": {
73+
"type": "object",
74+
"additionalProperties": {
75+
"type": "string"
76+
}
77+
}
78+
}
5679
}
5780
}
5881
}
5982
}
6083
}
61-
},
84+
}
85+
},
86+
"/startSession": {
6287
"post": {
63-
"description": "Creates a new plant in the store",
88+
"summary": "Start a session",
6489
"requestBody": {
65-
"description": "Plant to add to the store",
6690
"content": {
6791
"application/json": {
6892
"schema": {
69-
"$ref": "#/components/schemas/NewPlant"
93+
"type": "object",
94+
"properties": {
95+
"apiKey": {
96+
"type": "string",
97+
"description": "Get your [API key](https://www.simli.com/sign-up-in)"
98+
},
99+
"faceId": {
100+
"type": "string",
101+
"description": "Character's face ID, see all possible face IDs [here](/api-reference/available-face-ids)"
102+
},
103+
"intro": {
104+
"type": "string",
105+
"description": "The character will say this at the beginning of the session"
106+
},
107+
"prompt": {
108+
"type": "string",
109+
"description": "Character interaction prompt, refer to [this guide](/quickstart#2-prompting) for more information"
110+
},
111+
"timeLimit": {
112+
"type": "object",
113+
"properties": {
114+
"limit": {
115+
"type": "integer",
116+
"description": "Session time limit in seconds, character will leave after this time"
117+
}
118+
}
119+
},
120+
"userName": {
121+
"type": "string",
122+
"description": "The character will refer to the user by this name"
123+
},
124+
"voiceId": {
125+
"type": "string",
126+
"description": "Character's voice ID, see all possible voice IDs [here](/api-reference/available-voice-ids)"
127+
}
128+
},
129+
"required": [
130+
"apiKey",
131+
"faceId",
132+
"intro",
133+
"prompt",
134+
"timeLimit",
135+
"userName",
136+
"voiceId"
137+
]
70138
}
71139
}
72-
},
73-
"required": true
140+
}
74141
},
75142
"responses": {
76143
"200": {
77-
"description": "plant response",
144+
"description": "Session start response",
78145
"content": {
79146
"application/json": {
80147
"schema": {
81-
"$ref": "#/components/schemas/Plant"
82-
}
83-
}
84-
}
85-
},
86-
"400": {
87-
"description": "unexpected error",
88-
"content": {
89-
"application/json": {
90-
"schema": {
91-
"$ref": "#/components/schemas/Error"
148+
"type": "object",
149+
"properties": {
150+
"message": {
151+
"type": "string"
152+
},
153+
"meetingUrl": {
154+
"type": "string",
155+
"description": "Daily call url to join the session, refer to [this guide](/quickstart#4-accessing-the-meeting-url) for more information"
156+
}
157+
}
92158
}
93159
}
94160
}
95161
}
96162
}
97163
}
98164
},
99-
"/plants/{id}": {
100-
"delete": {
101-
"description": "Deletes a single plant based on the ID supplied",
165+
"/getPossibleVoiceIDs": {
166+
"get": {
167+
"summary": "Get possible voice IDs",
102168
"parameters": [
103169
{
104-
"name": "id",
105-
"in": "path",
106-
"description": "ID of plant to delete",
170+
"name": "apiKey",
171+
"in": "query",
107172
"required": true,
108173
"schema": {
109-
"type": "integer",
110-
"format": "int64"
174+
"type": "string"
111175
}
112176
}
113177
],
114-
"responses": {
115-
"204": {
116-
"description": "Plant deleted",
117-
"content": {}
118-
},
119-
"400": {
120-
"description": "unexpected error",
121-
"content": {
122-
"application/json": {
123-
"schema": {
124-
"$ref": "#/components/schemas/Error"
125-
}
126-
}
127-
}
128-
}
129-
}
130-
}
131-
},
132-
"/getPossibleFaceIDs": {
133-
"get": {
134-
"description": "Returns all face IDs from the system that the user has access to",
135178
"responses": {
136179
"200": {
137-
"description": "Face ID response",
180+
"description": "List of possible voice IDs",
138181
"content": {
139182
"application/json": {
140183
"schema": {
141-
"type": "array",
142-
"items": {
143-
"type": "string"
184+
"type": "object",
185+
"properties": {
186+
"voiceIDs": {
187+
"type": "object",
188+
"additionalProperties": {
189+
"type": "string"
190+
}
191+
}
144192
}
145193
}
146194
}
147195
}
148-
},
149-
"400": {
150-
"description": "Unexpected error",
151-
"content": {
152-
"application/json": {
153-
"schema": {
154-
"$ref": "#/components/schemas/Error"
155-
}
156-
}
157-
}
158-
}
159-
}
160-
}
161-
}
162-
},
163-
"components": {
164-
"schemas": {
165-
"Plant": {
166-
"required": [
167-
"name"
168-
],
169-
"type": "object",
170-
"properties": {
171-
"name": {
172-
"description": "The name of the plant",
173-
"type": "string"
174-
},
175-
"tag": {
176-
"description": "Tag to specify the type",
177-
"type": "string"
178196
}
179197
}
180-
},
181-
"NewPlant": {
182-
"allOf": [
183-
{
184-
"$ref": "#/components/schemas/Plant"
185-
},
186-
{
187-
"required": [
188-
"id"
189-
],
190-
"type": "object",
191-
"properties": {
192-
"id": {
193-
"description": "Identification number of the plant",
194-
"type": "integer",
195-
"format": "int64"
196-
}
197-
}
198-
}
199-
]
200-
},
201-
"Error": {
202-
"required": [
203-
"error",
204-
"message"
205-
],
206-
"type": "object",
207-
"properties": {
208-
"error": {
209-
"type": "integer",
210-
"format": "int32"
211-
},
212-
"message": {
213-
"type": "string"
214-
}
215-
}
216-
}
217-
},
218-
"securitySchemes": {
219-
"bearerAuth": {
220-
"type": "http",
221-
"scheme": "bearer"
222198
}
223199
}
224200
}
225-
}
201+
}

0 commit comments

Comments
 (0)
Please sign in to comment.