Skip to main content

aiPromptsList

List aiPromptsList(folderId)

GET /api/2.0/ai/prompts/list

List saved prompts

Lists the caller's saved prompts, newest first. folderId scopes the answer to one folder, and omitting it - or sending it empty - lists the prompts that sit at the root rather than every prompt, because the client fetcher cannot tell an absent value from a null one. There is therefore no way to ask for the whole library in one call: walk the folders from GET api/2.0/ai/prompts/list-folders, or take everything at once with GET api/2.0/ai/prompts/export. The prompts of other users are never included.

Parameters​

NameInTypeDescriptionNotes
folderIdqueryStringThe prompt folder identifier. Omit to list the prompts that sit outside any folder.[optional] [example: 44444444-4444-4444-4444-444444444444]

Responses​

Status codeDescriptionTypeResponse headers
200The prompts of the scope, newest first.List-
401Missing asc_auth_key cookie or Authorization header.AiErrorResponse-
403AI is disabled for this portal, the caller is a guest, or the room named by entityId is one the caller cannot open. Relayed from the DocSpace AI service or the Files API.AiErrorResponse-
500Unhandled failure. The reason is logged server-side and never echoed back.AiErrorResponse-

Return type​

List

Authorization​

cookieAuth, bearerAuth

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json