GET
/
v2
/
documents
List Documents
curl --request GET \
  --url https://tavusapi.com/v2/documents \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "uuid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "document_name": "Important Document",
      "document_url": "https://example.com/document.pdf",
      "status": "ready",
      "created_at": "2024-01-01T12:00:00Z",
      "updated_at": "2024-01-01T12:05:00Z",
      "callback_url": "https://your-server.com/webhook",
      "tags": [
        "important",
        "meeting"
      ],
      "properties": {
        "department": "sales",
        "priority": "high"
      }
    }
  ],
  "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

200
application/json

List of documents

The response is of type object.