Skip to main content
GET
/
v2
/
documents
List Documents
curl --request GET \
  --url https://tavusapi.com/v2/documents \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "document_id": "d8-5c71baca86fc",
      "document_name": "Example Docs",
      "document_url": "https://docs.example.com/",
      "status": "ready",
      "progress": null,
      "error_message": "<string>",
      "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,
  "page": 0,
  "limit": 10
}
Retrieve a list of documents with support for pagination, sorting, and filtering by various criteria.

Authorizations

x-api-key
string
header
required

Query Parameters

limit
integer

Number of documents to return per page (default: 10)

page
integer

Page number for pagination (0-based, default: 0)

sort
enum<string>

Sort direction for the results (default: ascending)

Available options:
ascending,
descending
status
string

Filter documents by status

name_or_uuid
string

Search for documents by name or UUID

tags
string

Comma-separated list of tags to filter by

Response

List of documents

data
object[]
total_count
integer

Total number of documents matching the filter criteria

Example:

42

page
integer

Current page number

Example:

0

limit
integer

Number of documents per page

Example:

10