BRbrainfish-ai
documents

List all documents

Changed on

Returns a summary of all ingested documents in the database.

get/v1/documents

Request

Response

List of documents

idstring
titlestring
total_nodesinteger
max_depthinteger
source_pathstring
mime_typestring
file_sizeinteger
table_idstring
tagsstring[]
metadataobject
created_atstring date-time

Example response

[
  {
    "id": "doc_abc123",
    "title": "Machine Learning Handbook",
    "total_nodes": 42,
    "max_depth": 4,
    "source_path": "/uploads/ml-handbook.pdf",
    "mime_type": "application/pdf",
    "file_size": 2048576,
    "table_id": "tbl_legal",
    "created_at": "2024-01-15T10:30:00Z"
  }
]

Changes

  • 308c06c063f5Revision changes
    • info

      added the non-success response with the status

  • 180d59085b78Revision changes
    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status