cURL
curl --request GET \ --url https://api.example.com/v1/knowledge-bases/{knowledge_base_id}/documents/{status} \ --header 'X-API-Key: <api-key>'
{ "items": [ { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "summary": "<string>", "status": "trained", "error": {}, "updated_at": "2023-11-07T05:31:56Z", "created_at": "2023-11-07T05:31:56Z", "size": 123, "short_summary": "<string>", "doc_type": "<string>", "source_type": "Document", "source_metadata": {}, "content_type": "<string>", "has_conversion": true, "doc_metadata": {}, "name": "<string>", "prefix": "<string>", "uri": "<string>", "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" } ], "total": 1, "page": 2, "size": 2, "pages": 1 }
Get all documents by ingestion status
Page number
x >= 1
Page size
1 <= x <= 100
Successful Response
Show child attributes
trained
training
error
uploaded
folder
Document
Google Drive
Notion
Website
OneDrive
Slack
Linear
Github
Teams
Sharepoint
Custom
x >= 0