documents

List all documents

Returns a summary of all ingested documents in the database.

get/v1/documents

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

Changed in 3 of the 7 revisions of this API.24

    • added the non-success response with the status 401

      response-non-success-status-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 180d59085b7811See the full diff
    • removed the optional property items/author from the response with the 200 status

      response-optional-property-removed

    • added the optional property items/metadata to the response with the 200 status

      response-optional-property-added

  • 9404aa4fdc2212See the full diff
    • removed the optional property items/metadata from the response with the 200 status

      response-optional-property-removed

    • removed the non-success response with the status 401

      response-non-success-status-removed

    • added the optional property items/author to the response with the 200 status

      response-optional-property-added

    This revision also has 12 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog