For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact usJoin the Discord
ManualAPI GuideAPI Reference
  • Overview
    • API Reference
    • Client libraries
  • API Reference
      • POSTIngest Content
      • GETList Ingested Documents
      • POSTDelete Ingested Document
      • POSTRetrieve Full Document Content
      • POSTRetrieve Full Document Content in Chunks
LogoLogo
Contact usJoin the Discord
API ReferenceArtifacts

List Ingested Documents

GET
https://host.com/v1/artifacts/list
GET
/v1/artifacts/list
$curl -G https://host.com/v1/artifacts/list \
>     -d collection=collection
1{
2  "data": [
3    {
4      "artifact": "annual_report",
5      "object": "ingest.document",
6      "doc_metadata": {
7        "file_name": "2023_Annual.pdf",
8        "department": "finance",
9        "date": "2023-12-31"
10      }
11    },
12    {
13      "artifact": "policy_manual",
14      "object": "ingest.document",
15      "doc_metadata": {
16        "file_name": "employee_policy.docx",
17        "department": "hr",
18        "version": "2.1"
19      }
20    }
21  ],
22  "object": "list",
23  "model": "private-gpt"
24}
Retrieve a list of all documents ingested into a specific collection
Was this page helpful?
Previous

Delete Ingested Document

Next
Built with

Query parameters

collectionstringRequired

Response

This endpoint returns an object.
datalist of objects
List of ingested documents with their metadata and processing information
object"list"
Response object type, always 'list' for ingestion responses
model"private-gpt"

Model identifier, always ‘private-gpt’

Errors

401
Unauthorized
422
Unprocessable Entity