Get Folder Documents

GET

/api/writing/folders/{folder_id}/documents

• DivinityEngine - Local development
• DivinityEngine - Localhost alternative

📄 Get documents in folder.

Gets all document IDs in a folder.

Args: folder_id: Folder ID service: Injected DocumentCategoriesService instance

Returns: WritingFolderDocumentsResponse: List of document IDs in the folder

Raises: HTTPException 500: If document lookup fails

Parameters

Path Parameters

folder_id

required

Folder Id

Folder ID

string

Folder ID

Responses

200

Successful Response

WritingFolderDocumentsResponse

Response model for getting documents in a folder in Writing Studio.

Lists all document IDs contained within a specific folder.

Fields:

• folder_id: Folder ID queried
• document_ids: List of document IDs in the folder
• count: Number of documents in folder

Usage: GET /api/creative/categories/folders/{folder_id}/documents returns this model.

JSON Example:

{
  "folderId": "folder_abc123",
  "documentIds": ["doc_1", "doc_2", "doc_3"],
  "count": 3
}

object

folderId

required

Folderid

Folder ID

string

documentIds

required

Documentids

Document IDs in folder

Array<string>

count

required

Count

Document count

integer

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object