List Unstructured Documents - Fluid Topics - 3.2 - Reference Guides

Fluid Topics API Reference Guide

Product
Fluid Topics
Fluid Topics Version
3.2
Category
Reference Guides
Language
English
Target Audience
public

It is recommended to use pagination when crawling unstructured documents.

This web service returns the list of Fluid Topics unstructured documents.

Method

Endpoint

GET

/api/khub/documents

Input Example

{
"page": "3",
"per_page": "100"
}

Where:

  • "page" is the page number. This optional query parameter starts at 1 and defaults to 1.
  • "per_page" is the number of results per page. This optional query parameter defaults at -1, meaning that all results are returned. The maximum accepted value is 500.

Output Example

[
{
"id": "PsA9WUlJsLM6D44sbYAv~Q",
"filename": "Fluidy.jpg",
"title": "Fluidy",
"mimeType": "image/jpeg",
"documentApiEndpoint": "/api/khub/documents/PsA9WUlJsLM6D44sbYAv~Q",
"metadata": []
},
{
"id": "zDK13oDmZHDXCEPOc4xiyw",
"filename": "FluidTopics-Zoom-KHub-Internals-2015c.pdf",
"title": "FluidTopics-Zoom-KHub-Internals-2015c",
"mimeType": "application/pdf",
"documentApiEndpoint": "/api/khub/documents/zDK13oDmZHDXCEPOc4xiyw",
"metadata": [
{
"key": "author",
"label": "author",
"values": [
"Fabrice LACROIX"
]
}
]
},
{
"id": "GGGLebFzhuz2faA2enV7yQ",
"filename": "internationalization.md",
"title": "Internationalization",
"mimeType": "text/plain",
"documentApiEndpoint": "/api/khub/documents/GGGLebFzhuz2faA2enV7yQ",
"metadata": []
},
{
"id": "HzMco07FtFvw~QeDbZgrmA",
"filename": "multi.zip",
"title": "Multi",
"mimeType": "application/zip",
"documentApiEndpoint": "/api/khub/documents/HzMco07FtFvw~QeDbZgrmA",
"metadata": []
}
]

In this example, Fluid Topics returns four unstructured documents.

  • "id": unique identifier of the document.
  • "metadata": all the metadata of the document.
  • "title": the title used when referencing the document in the Fluid Topics UI.
  • "filename": the filename used for this document.
  • "mimeType": the mime-type of the document.
  • "documentApiEndpoint": the path to follow to get details about the corresponding document.