Skip to content

Commit d82d6cf

Browse files
committed
fix: api
1 parent 4471464 commit d82d6cf

1 file changed

Lines changed: 199 additions & 78 deletions

File tree

docs.json

Lines changed: 199 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -133,87 +133,178 @@
133133
{
134134
"group": "AGENTS",
135135
"pages": [
136-
"rest-reference/agents/create-a-new-agent",
137-
"rest-reference/agents/get-agent-details",
138-
"rest-reference/agents/list-all-agents",
139-
"rest-reference/agents/update-agent",
140-
"rest-reference/agents/delete-an-agent",
141-
"rest-reference/agents/start-an-agent",
142-
"rest-reference/agents/stop-an-agent",
143-
"rest-reference/agents/get-agent-panels",
144-
"rest-reference/agents/create-a-world-for-an-agent",
145-
"rest-reference/agents/get-all-worlds",
146-
"rest-reference/agents/update-a-world"
136+
{
137+
"group": "CRUD Operations",
138+
"expanded": true,
139+
"pages": [
140+
"rest-reference/agents/list-all-agents",
141+
"rest-reference/agents/create-a-new-agent",
142+
"rest-reference/agents/get-agent-details",
143+
"rest-reference/agents/update-agent",
144+
"rest-reference/agents/delete-an-agent"
145+
]
146+
},
147+
{
148+
"group": "Lifecycle",
149+
"expanded": true,
150+
"pages": [
151+
"rest-reference/agents/start-an-agent",
152+
"rest-reference/agents/stop-an-agent",
153+
"rest-reference/agents/get-agent-panels"
154+
]
155+
},
156+
{
157+
"group": "Worlds",
158+
"expanded": true,
159+
"pages": [
160+
"rest-reference/agents/get-all-worlds",
161+
"rest-reference/agents/create-a-world-for-an-agent",
162+
"rest-reference/agents/update-a-world"
163+
]
164+
}
147165
]
148166
},
149167
{
150168
"group": "AUDIO",
151169
"pages": [
152-
"rest-reference/audio/generate-speech-from-text",
153-
"rest-reference/audio/synthesize-speech-from-text",
154-
"rest-reference/audio/transcribe-audio",
155-
"rest-reference/audio/process-audio-message",
156-
"rest-reference/audio/convert-conversation-to-speech"
170+
{
171+
"group": "Text-to-Speech",
172+
"expanded": true,
173+
"pages": [
174+
"rest-reference/audio/generate-speech-from-text",
175+
"rest-reference/audio/synthesize-speech-from-text",
176+
"rest-reference/audio/convert-conversation-to-speech"
177+
]
178+
},
179+
{
180+
"group": "Speech-to-Text",
181+
"expanded": true,
182+
"pages": [
183+
"rest-reference/audio/transcribe-audio",
184+
"rest-reference/audio/process-audio-message"
185+
]
186+
}
157187
]
158188
},
159189
{
160190
"group": "MESSAGING",
161191
"pages": [
162-
"rest-reference/messaging/create-server",
163-
"rest-reference/messaging/create-channel",
164-
"rest-reference/messaging/get-or-create-dm-channel",
165-
"rest-reference/messaging/send-message-to-channel",
166-
"rest-reference/messaging/get-channel-messages",
167-
"rest-reference/messaging/get-channel-details",
168-
"rest-reference/messaging/get-channel-info",
169-
"rest-reference/messaging/get-channel-participants",
170-
"rest-reference/messaging/update-channel",
171-
"rest-reference/messaging/delete-channel",
172-
"rest-reference/messaging/delete-channel-message",
173-
"rest-reference/messaging/delete-all-channel-messages",
174-
"rest-reference/messaging/delete-all-channel-messages-by-user",
175-
"rest-reference/messaging/add-agent-to-server",
176-
"rest-reference/messaging/add-agent-to-channel",
177-
"rest-reference/messaging/remove-agent-from-server",
178-
"rest-reference/messaging/get-server-agents",
179-
"rest-reference/messaging/get-server-channels",
180-
"rest-reference/messaging/process-external-message",
181-
"rest-reference/messaging/ingest-messages-from-external-platforms",
182-
"rest-reference/messaging/submit-a-message-to-the-central-messaging-system"
183-
]
184-
},
185-
{
186-
"group": "MESSAGING (Deprecated)",
187-
"pages": [
188-
"rest-reference/messaging/get-central-servers",
189-
"rest-reference/messaging/get-central-server-channels",
190-
"rest-reference/messaging/create-central-channel"
192+
{
193+
"group": "Servers & Channels",
194+
"expanded": true,
195+
"pages": [
196+
"rest-reference/messaging/create-server",
197+
"rest-reference/messaging/create-channel",
198+
"rest-reference/messaging/get-or-create-dm-channel",
199+
"rest-reference/messaging/get-channel-details",
200+
"rest-reference/messaging/get-channel-info",
201+
"rest-reference/messaging/update-channel",
202+
"rest-reference/messaging/delete-channel",
203+
"rest-reference/messaging/get-server-channels"
204+
]
205+
},
206+
{
207+
"group": "Messages",
208+
"expanded": true,
209+
"pages": [
210+
"rest-reference/messaging/send-message-to-channel",
211+
"rest-reference/messaging/get-channel-messages",
212+
"rest-reference/messaging/delete-channel-message",
213+
"rest-reference/messaging/delete-all-channel-messages",
214+
"rest-reference/messaging/delete-all-channel-messages-by-user"
215+
]
216+
},
217+
{
218+
"group": "Participants",
219+
"expanded": true,
220+
"pages": [
221+
"rest-reference/messaging/get-channel-participants",
222+
"rest-reference/messaging/add-agent-to-server",
223+
"rest-reference/messaging/add-agent-to-channel",
224+
"rest-reference/messaging/remove-agent-from-server",
225+
"rest-reference/messaging/get-server-agents"
226+
]
227+
},
228+
{
229+
"group": "External Integration",
230+
"expanded": true,
231+
"pages": [
232+
"rest-reference/messaging/process-external-message",
233+
"rest-reference/messaging/ingest-messages-from-external-platforms",
234+
"rest-reference/messaging/submit-a-message-to-the-central-messaging-system"
235+
]
236+
},
237+
{
238+
"group": "Deprecated",
239+
"expanded": true,
240+
"pages": [
241+
"rest-reference/messaging/get-central-servers",
242+
"rest-reference/messaging/get-central-server-channels",
243+
"rest-reference/messaging/create-central-channel"
244+
]
245+
}
191246
]
192247
},
193248
{
194-
"group": "SESSIONS API",
249+
"group": "SESSIONS",
195250
"pages": [
196-
"rest-reference/messaging/create-session",
197-
"rest-reference/messaging/get-session",
198-
"rest-reference/messaging/send-session-message",
199-
"rest-reference/messaging/get-session-messages",
200-
"rest-reference/messaging/renew-session",
201-
"rest-reference/messaging/update-session-timeout",
202-
"rest-reference/messaging/session-heartbeat",
203-
"rest-reference/messaging/end-session",
204-
"rest-reference/messaging/list-sessions",
205-
"rest-reference/messaging/sessions-health-check"
251+
{
252+
"group": "Session Management",
253+
"expanded": true,
254+
"pages": [
255+
"rest-reference/messaging/create-session",
256+
"rest-reference/messaging/get-session",
257+
"rest-reference/messaging/list-sessions",
258+
"rest-reference/messaging/end-session"
259+
]
260+
},
261+
{
262+
"group": "Session Messages",
263+
"expanded": true,
264+
"pages": [
265+
"rest-reference/messaging/send-session-message",
266+
"rest-reference/messaging/get-session-messages"
267+
]
268+
},
269+
{
270+
"group": "Session Lifecycle",
271+
"expanded": true,
272+
"pages": [
273+
"rest-reference/messaging/renew-session",
274+
"rest-reference/messaging/update-session-timeout",
275+
"rest-reference/messaging/session-heartbeat",
276+
"rest-reference/messaging/sessions-health-check"
277+
]
278+
}
206279
]
207280
},
208281
{
209282
"group": "MEMORY",
210283
"pages": [
211-
"rest-reference/memory/get-agent-memories",
212-
"rest-reference/memory/get-room-memories",
213-
"rest-reference/memory/create-a-room",
214-
"rest-reference/memory/update-a-memory",
215-
"rest-reference/memory/delete-all-agent-memories",
216-
"rest-reference/memory/delete-all-memories-for-a-room"
284+
{
285+
"group": "Read",
286+
"expanded": true,
287+
"pages": [
288+
"rest-reference/memory/get-agent-memories",
289+
"rest-reference/memory/get-room-memories"
290+
]
291+
},
292+
{
293+
"group": "Write",
294+
"expanded": true,
295+
"pages": [
296+
"rest-reference/memory/create-a-room",
297+
"rest-reference/memory/update-a-memory"
298+
]
299+
},
300+
{
301+
"group": "Delete",
302+
"expanded": true,
303+
"pages": [
304+
"rest-reference/memory/delete-all-agent-memories",
305+
"rest-reference/memory/delete-all-memories-for-a-room"
306+
]
307+
}
217308
]
218309
},
219310
{
@@ -236,27 +327,57 @@
236327
{
237328
"group": "LOGS",
238329
"pages": [
239-
"rest-reference/logs/get-agent-logs",
240-
"rest-reference/logs/get-system-logs",
241-
"rest-reference/logs/get-system-logs-post",
242-
"rest-reference/logs/delete-a-specific-log-entry",
243-
"rest-reference/logs/clear-system-logs"
330+
{
331+
"group": "Read",
332+
"expanded": true,
333+
"pages": [
334+
"rest-reference/logs/get-agent-logs",
335+
"rest-reference/logs/get-system-logs",
336+
"rest-reference/logs/get-system-logs-post"
337+
]
338+
},
339+
{
340+
"group": "Delete",
341+
"expanded": true,
342+
"pages": [
343+
"rest-reference/logs/delete-a-specific-log-entry",
344+
"rest-reference/logs/clear-system-logs"
345+
]
346+
}
244347
]
245348
},
246349
{
247350
"group": "SYSTEM",
248351
"pages": [
249-
"rest-reference/system/basic-health-check",
250-
"rest-reference/system/health-check-endpoint",
251-
"rest-reference/system/ping-health-check",
252-
"rest-reference/system/get-system-status",
253-
"rest-reference/system/get-system-config",
254-
"rest-reference/system/get-version",
255-
"rest-reference/system/get-server-debug-info",
256-
"rest-reference/system/get-server-debug-info-1",
257-
"rest-reference/system/get-local-environment-variables",
258-
"rest-reference/system/update-local-environment-variables",
259-
"rest-reference/system/stop-the-server"
352+
{
353+
"group": "Health & Status",
354+
"expanded": true,
355+
"pages": [
356+
"rest-reference/system/basic-health-check",
357+
"rest-reference/system/health-check-endpoint",
358+
"rest-reference/system/ping-health-check",
359+
"rest-reference/system/get-system-status",
360+
"rest-reference/system/get-version"
361+
]
362+
},
363+
{
364+
"group": "Configuration",
365+
"expanded": true,
366+
"pages": [
367+
"rest-reference/system/get-system-config",
368+
"rest-reference/system/get-local-environment-variables",
369+
"rest-reference/system/update-local-environment-variables"
370+
]
371+
},
372+
{
373+
"group": "Debug & Control",
374+
"expanded": true,
375+
"pages": [
376+
"rest-reference/system/get-server-debug-info",
377+
"rest-reference/system/get-server-debug-info-1",
378+
"rest-reference/system/stop-the-server"
379+
]
380+
}
260381
]
261382
},
262383
{

0 commit comments

Comments
 (0)