v1
latestOpenAPI 3.0.32026-07-267015229.9 KBDocuments
List Documents
Retrieve a list of documents.
get/v2/documents
Query parameters
limitinteger
Number of documents to return per page (default: 10)
pageinteger
Page number for pagination (0-based, default: 0)
sort'ascending' | 'descending'
Sort direction for the results (default: ascending)
statusstring
Filter documents by status
name_or_uuidstring
Search for documents by name or UUID
tagsstring
Comma-separated list of tags to filter by
Response
List of documents
Example response
{
"data": [
{
"document_id": "d8-5c71baca86fc",
"document_name": "Example Docs",
"document_url": "https://docs.example.com/",
"status": "ready",
"created_at": "2024-01-01T12:00:00Z",
"updated_at": "2024-01-01T12:05:00Z",
"callback_url": "https://your-server.com/webhook",
"tags": [
"docs",
"website"
],
"crawl_config": {
"depth": 2,
"max_pages": 10
},
"crawled_urls": [
"https://docs.example.com/",
"https://docs.example.com/getting-started"
],
"last_crawled_at": "2024-01-01T12:00:00Z",
"crawl_count": 1
}
],
"total_count": 42,
"limit": 10
}