Skip to content

Commit 3ac5f28

Browse files
lalalunelalalune
committed
docs lint
1 parent 1cc3721 commit 3ac5f28

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+5372
-3934
lines changed

‎packages/docs/docs/rest/conversation-to-speech.api.mdx

+126-46
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,151 @@
11
---
22
id: conversation-to-speech
3-
title: "Process conversation and return speech"
4-
description: "Processes a conversational message and returns synthesized speech"
5-
sidebar_label: "Process conversation and return speech"
3+
title: 'Process conversation and return speech'
4+
description: 'Processes a conversational message and returns synthesized speech'
5+
sidebar_label: 'Process conversation and return speech'
66
hide_title: true
77
hide_table_of_contents: true
88
api: eJztVktz2zYQ/iuYPbUztKi26YU3NfZBM53GYysnx4cVsSKRgAADgLIVDv97ZwFKpG219iGTU3ghCez721cPASsPxR34lqisIQOsyAQP9xlI8qVTbVDWQAHXzpbkPXmBorRmT84jX6EWDXmPFQk0UjgKnTNe+IMJNXn1jaQ4ybYtuci0llDAXMrG3h6JWnTYUCDHdvVgsCEokllrCRkotqbFwLSOvnbKkYQiuI4y8GVNDULRQzi0zOaDU6aCDHbWNRiggK5TEobn3q0vhd2JUJOIimC4T8LJh7+sPLDE57pKawKTFj1g22pVRkfyz54F9i9NsdvPVAZ20HEcgiIfb+kxnDP4qX0begzHOLP1ztqGg/ga3421jVhfMguZoMLhLUxXkXJk6zy5fyIGr7F99OREhGvIRtjeqCkxxYfD7ltrfIrO78slv55yrTqprPDBETbiQYX6fLbNAWKOvGmpOgvNyyzZKoPuAMmid+eMWJs9aiVTvgjOHyca5b0ylYiYfrcM8V3JlTcj3FqrCQ1kQI/YtJqg2KH2xCg7Z93rMksr3wIPCxORdsjgmH5vZJtlq6SASvvXOS8jIUkR3RDKJED4MkERVGBvk4oTPO/O5EiExdggdrYz8icaPwqNP88VS7KhTSOEK2Te+39i82OwiYaF2vLsba2PrvIYLSDHVuVp8Of9OGmHPDXS/BlUntz+OJs7p6GAOoS2yHNtS9S19aH4Y7lcvjD4b74WkvakbdtwcSZJcdQy0DfTuL06YnUcj1MUjoNvOpnm2nQ2Da3pzDz5H3iR2Nmo4hgprb6h+HArVtfrF+avrtdC2rJjy2MoxM46cWLZ/7ZYLpYXqNsaxYVYiZ2mR7XVaSnyJWrkn9V6nBc73nEerPuy+GQ+mU2tPGsVygtJXlWGpAhWbEl0nmSacShihPVBuM4YLqKkXRkf0JS0EFdGtlaZ4AVqbR+ihaUjDMpU2SfToMGKP6NNygRyWPJdkn+0zYtQO9tVrPHm6naTKHdY0gIyYOxTRGYejxWMZazgMdCn2Ly3TdMZFQ4MzCljfJHnlQp1t12UtsmJqa1Pb+Bc5RRt0Mwkjivok+YxWzqnyf8Eun7qLt9liR3rkhMzbzUqE7ck9qsf6+kOsFXTKp1BMW2v8+1kKqv7DLhymLXvt+jpo9PDwMdfO3IHKO7uM9ijU5xFsfSk8vwtx372Pz7/cjMurr+K51vufzgzHqJhxPaoO/6DDL7QYbaJD/dDBjWhJBctSrfvk96LDcuYuF909SE7cqzKktowp52WNe4Np551/eF2Axlsx328iY0ZHD5wW8CHZKONEYgNNJ71oNFUXezGkDTz8y/mYoMe
9-
sidebar_class_name: "post api-method"
9+
sidebar_class_name: 'post api-method'
1010
info_path: docs/rest/eliza-os-api
1111
custom_edit_url: null
1212
---
1313

14-
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
15-
import ParamsDetails from "@theme/ParamsDetails";
16-
import RequestSchema from "@theme/RequestSchema";
17-
import StatusCodes from "@theme/StatusCodes";
18-
import OperationTabs from "@theme/OperationTabs";
19-
import TabItem from "@theme/TabItem";
20-
import Heading from "@theme/Heading";
14+
import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint';
15+
import ParamsDetails from '@theme/ParamsDetails';
16+
import RequestSchema from '@theme/RequestSchema';
17+
import StatusCodes from '@theme/StatusCodes';
18+
import OperationTabs from '@theme/OperationTabs';
19+
import TabItem from '@theme/TabItem';
20+
import Heading from '@theme/Heading';
2121

2222
<Heading
23-
as={"h1"}
24-
className={"openapi__heading"}
25-
children={"Process conversation and return speech"}
26-
>
27-
</Heading>
23+
as={'h1'}
24+
className={'openapi__heading'}
25+
children={'Process conversation and return speech'}
26+
></Heading>
2827

2928
<MethodEndpoint
30-
method={"post"}
31-
path={"/api/agents/{agentId}/speech/conversation"}
32-
context={"endpoint"}
33-
>
34-
35-
</MethodEndpoint>
36-
37-
29+
method={'post'}
30+
path={'/api/agents/{agentId}/speech/conversation'}
31+
context={'endpoint'}
32+
></MethodEndpoint>
3833

3934
Processes a conversational message and returns synthesized speech
4035

4136
<Heading
42-
id={"request"}
43-
as={"h2"}
44-
className={"openapi-tabs__heading"}
45-
children={"Request"}
46-
>
47-
</Heading>
37+
id={'request'}
38+
as={'h2'}
39+
className={'openapi-tabs__heading'}
40+
children={'Request'}
41+
></Heading>
4842

4943
<ParamsDetails
50-
parameters={[{"name":"agentId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"ID of the agent"}]}
51-
>
52-
53-
</ParamsDetails>
44+
parameters={[
45+
{
46+
name: 'agentId',
47+
in: 'path',
48+
required: true,
49+
schema: { type: 'string', format: 'uuid' },
50+
description: 'ID of the agent',
51+
},
52+
]}
53+
></ParamsDetails>
5454

5555
<RequestSchema
56-
title={"Body"}
57-
body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string","description":"Text message"},"roomId":{"type":"string","description":"Room ID"},"entityId":{"type":"string","description":"Entity ID"},"userName":{"type":"string","description":"User name"},"name":{"type":"string","description":"Entity name"}}}}}}}
58-
>
59-
60-
</RequestSchema>
56+
title={'Body'}
57+
body={{
58+
required: true,
59+
content: {
60+
'application/json': {
61+
schema: {
62+
type: 'object',
63+
properties: {
64+
text: { type: 'string', description: 'Text message' },
65+
roomId: { type: 'string', description: 'Room ID' },
66+
entityId: { type: 'string', description: 'Entity ID' },
67+
userName: { type: 'string', description: 'User name' },
68+
name: { type: 'string', description: 'Entity name' },
69+
},
70+
},
71+
},
72+
},
73+
}}
74+
></RequestSchema>
6175

6276
<StatusCodes
6377
id={undefined}
6478
label={undefined}
65-
responses={{"200":{"description":"Audio stream with synthesized speech","content":{"audio/mpeg":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid agent ID or missing text","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"details":{"type":"string","description":"Detailed error information"}}}},"title":"Error"}}}},"404":{"description":"Agent not found","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"details":{"type":"string","description":"Detailed error information"}}}},"title":"Error"}}}},"500":{"description":"Error processing conversation","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"details":{"type":"string","description":"Detailed error information"}}}},"title":"Error"}}}}}}
66-
>
67-
68-
</StatusCodes>
69-
70-
71-
79+
responses={{
80+
'200': {
81+
description: 'Audio stream with synthesized speech',
82+
content: { 'audio/mpeg': { schema: { type: 'string', format: 'binary' } } },
83+
},
84+
'400': {
85+
description: 'Invalid agent ID or missing text',
86+
content: {
87+
'application/json': {
88+
schema: {
89+
type: 'object',
90+
properties: {
91+
success: { type: 'boolean', example: false },
92+
error: {
93+
type: 'object',
94+
properties: {
95+
code: { type: 'string', description: 'Error code' },
96+
message: { type: 'string', description: 'Error message' },
97+
details: { type: 'string', description: 'Detailed error information' },
98+
},
99+
},
100+
},
101+
title: 'Error',
102+
},
103+
},
104+
},
105+
},
106+
'404': {
107+
description: 'Agent not found',
108+
content: {
109+
'application/json': {
110+
schema: {
111+
type: 'object',
112+
properties: {
113+
success: { type: 'boolean', example: false },
114+
error: {
115+
type: 'object',
116+
properties: {
117+
code: { type: 'string', description: 'Error code' },
118+
message: { type: 'string', description: 'Error message' },
119+
details: { type: 'string', description: 'Detailed error information' },
120+
},
121+
},
122+
},
123+
title: 'Error',
124+
},
125+
},
126+
},
127+
},
128+
'500': {
129+
description: 'Error processing conversation',
130+
content: {
131+
'application/json': {
132+
schema: {
133+
type: 'object',
134+
properties: {
135+
success: { type: 'boolean', example: false },
136+
error: {
137+
type: 'object',
138+
properties: {
139+
code: { type: 'string', description: 'Error code' },
140+
message: { type: 'string', description: 'Error message' },
141+
details: { type: 'string', description: 'Detailed error information' },
142+
},
143+
},
144+
},
145+
title: 'Error',
146+
},
147+
},
148+
},
149+
},
150+
}}
151+
></StatusCodes>

‎packages/docs/docs/rest/create-agent.api.mdx

+118-49
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,140 @@
11
---
22
id: create-agent
3-
title: "Create a new agent"
4-
description: "Creates a new agent from character configuration"
5-
sidebar_label: "Create a new agent"
3+
title: 'Create a new agent'
4+
description: 'Creates a new agent from character configuration'
5+
sidebar_label: 'Create a new agent'
66
hide_title: true
77
hide_table_of_contents: true
88
api: eJy9Vk1z2zYQ/SuYvfRCS0rbE29qooMzndgTOyfHhyWwJBGDAAyAllUN/3tnQdqSJU1j153qIonc77f7dreQsIlQ3gA2ZFOE2wIURRm0T9pZKOFjIEwUBQpLa5GlRB1cJ2SLAWWiIKSztW76gFmlAOdp/H2uoASZDSxZEQoIdN9TTH84tYFym//qQArKFHoqQDqbWLDcAnpvtMx25j8ix7KFKFvqkH+ljScowVU/SLJdH9hr0hT57XNsl5jaPfGYgrYNHObIUiI5gXtJ1doQDMXO1OcphkPPB+U6XRWhrfh8dfFF1C50mGDIHy5H9M7GMepfFx/466XBXDgxFlGJ2EtJMda9MRv4z8o1Wd0TrJwzhAwmPWLnDY0ADQUoTG8B4JToDvQbsNgRN91Lda1OgTbVroS+1+qo8t+svu9JaEU26VozhC6I1NIOVMYzO/xpR3zBjoSrj9Ur7X6ufdW6kESlXRPQt5uThiKlpG0T39BSZ9GT1LWW4lmZDW1iou4VQWU54YPrfDpdm5g2ht4Q0C9RSNd1vZ0aT4wGhgKMC/uGMATkftWJungc6nDoYfWYyCpSgu0ItEpUKO+a4HqrhLZjI7DoUEBHMWJDq7FP47u8ZhNishhzkXaMkAJqOykm57V8j6/rbOAlBEJHcWfd2pBqCCtDAivXJ1b2pm+0fY/Dy9GC6CMpUW0OweecdGL0d/BOLMXvfl8sjqlpFQIXiKlJ22bcDf8zKdVoIrMScSivoCWnXjH8U14su+uv16o9iWcAEmpzApxDzU9ZkJTIabxs8GEfmuwCJkw6Sq3jDetdzKnmXQdz9Ho+bXOmmfBAgTf8FvpgoIQ2JV/O58ZJNK2LqfxtsVgchfQnvxaKHsg43/EKGi3BcFsAQ/l1t8hXT2gcLd5dwodrlBPgPHNxnrIz+i8UF1dieXl+FNDy8lwoJ3uOZSQbns5nlYcPs8VscYbGtyjOxFLUhh51niGrRJRo8kAtz59PGOxo7cLd7Lv9bq9bHdkrT6CiqBtLig+CisZ5WevUChS5ZmYjQm+ZCCbv2saEVtJMrKzyTtsUBRrj1iN/TONRfLcdWmz4Z45J20RcEjaU7T/FxqwQXN+wx6+rq+tRskZJMyiA0RwrspfxNHUo89SNK25Xzo8jRyemi10PxHI+b3Rq+2omXTcnlnZx/M58wG3Vod2zON6C+6fgIUzb3fT/m8txGpNEj2nuDepM8Dnk7dTeN4BeQ7F3rnIP8/PttsJI34IZBn5831PYQHlzW8ADBs3o87+hgJZQ8WFys4U72nCgY8hn1+ydxU2fGfaQvIbiSWMpJfn0j7K3ewN6eXF1DQVU09HbZRaCgGs+hnANJeSrmbUzW+RnWzBomz5TD4w2+fM3S94XZg==
9-
sidebar_class_name: "post api-method"
9+
sidebar_class_name: 'post api-method'
1010
info_path: docs/rest/eliza-os-api
1111
custom_edit_url: null
1212
---
1313

14-
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
15-
import ParamsDetails from "@theme/ParamsDetails";
16-
import RequestSchema from "@theme/RequestSchema";
17-
import StatusCodes from "@theme/StatusCodes";
18-
import OperationTabs from "@theme/OperationTabs";
19-
import TabItem from "@theme/TabItem";
20-
import Heading from "@theme/Heading";
21-
22-
<Heading
23-
as={"h1"}
24-
className={"openapi__heading"}
25-
children={"Create a new agent"}
26-
>
27-
</Heading>
28-
29-
<MethodEndpoint
30-
method={"post"}
31-
path={"/api/agents"}
32-
context={"endpoint"}
33-
>
34-
35-
</MethodEndpoint>
14+
import MethodEndpoint from '@theme/ApiExplorer/MethodEndpoint';
15+
import ParamsDetails from '@theme/ParamsDetails';
16+
import RequestSchema from '@theme/RequestSchema';
17+
import StatusCodes from '@theme/StatusCodes';
18+
import OperationTabs from '@theme/OperationTabs';
19+
import TabItem from '@theme/TabItem';
20+
import Heading from '@theme/Heading';
3621

22+
<Heading as={'h1'} className={'openapi__heading'} children={'Create a new agent'}></Heading>
3723

24+
<MethodEndpoint method={'post'} path={'/api/agents'} context={'endpoint'}></MethodEndpoint>
3825

3926
Creates a new agent from character configuration
4027

4128
<Heading
42-
id={"request"}
43-
as={"h2"}
44-
className={"openapi-tabs__heading"}
45-
children={"Request"}
46-
>
47-
</Heading>
29+
id={'request'}
30+
as={'h2'}
31+
className={'openapi-tabs__heading'}
32+
children={'Request'}
33+
></Heading>
4834

49-
<ParamsDetails
50-
parameters={undefined}
51-
>
52-
53-
</ParamsDetails>
35+
<ParamsDetails parameters={undefined}></ParamsDetails>
5436

5537
<RequestSchema
56-
title={"Body"}
57-
body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"characterPath":{"type":"string","description":"Path to a character file"},"characterJson":{"type":"object","description":"Character configuration in JSON format"}}}}}}}
58-
>
59-
60-
</RequestSchema>
38+
title={'Body'}
39+
body={{
40+
required: true,
41+
content: {
42+
'application/json': {
43+
schema: {
44+
type: 'object',
45+
properties: {
46+
characterPath: { type: 'string', description: 'Path to a character file' },
47+
characterJson: {
48+
type: 'object',
49+
description: 'Character configuration in JSON format',
50+
},
51+
},
52+
},
53+
},
54+
},
55+
}}
56+
></RequestSchema>
6157

6258
<StatusCodes
6359
id={undefined}
6460
label={undefined}
65-
responses={{"201":{"description":"Agent created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true},"data":{"type":"object","properties":{"character":{"type":"object","required":["name"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the character"},"name":{"type":"string","description":"Name of the character"},"bio":{"type":"string","description":"Short biography of the character"},"settings":{"type":"object","description":"Character-specific settings"},"system":{"type":"string","description":"System prompt for the character"},"style":{"type":"object","description":"Character's communication style"},"lore":{"type":"array","items":{"type":"string"},"description":"Extended lore and background information"},"messageExamples":{"type":"array","items":{"type":"string"},"description":"Example messages for character training"},"topics":{"type":"array","items":{"type":"string"},"description":"Topics the character is knowledgeable about"},"plugins":{"type":"array","items":{"type":"string"},"description":"Plugins used by the character"}},"title":"Character"}}}}}}}},"400":{"description":"Error creating agent","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false},"error":{"type":"object","properties":{"code":{"type":"string","description":"Error code"},"message":{"type":"string","description":"Error message"},"details":{"type":"string","description":"Detailed error information"}}}},"title":"Error"}}}}}}
66-
>
67-
68-
</StatusCodes>
69-
70-
71-
61+
responses={{
62+
'201': {
63+
description: 'Agent created successfully',
64+
content: {
65+
'application/json': {
66+
schema: {
67+
type: 'object',
68+
properties: {
69+
success: { type: 'boolean', example: true },
70+
data: {
71+
type: 'object',
72+
properties: {
73+
character: {
74+
type: 'object',
75+
required: ['name'],
76+
properties: {
77+
id: {
78+
type: 'string',
79+
format: 'uuid',
80+
description: 'Unique identifier for the character',
81+
},
82+
name: { type: 'string', description: 'Name of the character' },
83+
bio: { type: 'string', description: 'Short biography of the character' },
84+
settings: { type: 'object', description: 'Character-specific settings' },
85+
system: { type: 'string', description: 'System prompt for the character' },
86+
style: { type: 'object', description: "Character's communication style" },
87+
lore: {
88+
type: 'array',
89+
items: { type: 'string' },
90+
description: 'Extended lore and background information',
91+
},
92+
messageExamples: {
93+
type: 'array',
94+
items: { type: 'string' },
95+
description: 'Example messages for character training',
96+
},
97+
topics: {
98+
type: 'array',
99+
items: { type: 'string' },
100+
description: 'Topics the character is knowledgeable about',
101+
},
102+
plugins: {
103+
type: 'array',
104+
items: { type: 'string' },
105+
description: 'Plugins used by the character',
106+
},
107+
},
108+
title: 'Character',
109+
},
110+
},
111+
},
112+
},
113+
},
114+
},
115+
},
116+
},
117+
'400': {
118+
description: 'Error creating agent',
119+
content: {
120+
'application/json': {
121+
schema: {
122+
type: 'object',
123+
properties: {
124+
success: { type: 'boolean', example: false },
125+
error: {
126+
type: 'object',
127+
properties: {
128+
code: { type: 'string', description: 'Error code' },
129+
message: { type: 'string', description: 'Error message' },
130+
details: { type: 'string', description: 'Detailed error information' },
131+
},
132+
},
133+
},
134+
title: 'Error',
135+
},
136+
},
137+
},
138+
},
139+
}}
140+
></StatusCodes>

0 commit comments

Comments
 (0)