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
}

GET

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

Response

List of documents

data

object[]

Show child attributes

data.uuid

string

Unique identifier for the document

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

data.document_name

string

Name of the document

Example:

"Important Document"

data.document_url

string

URL of the document

Example:

"https://example.com/document.pdf"

data.status

string

Current status of the document processing

Example:

"ready"

data.created_at

string

ISO 8601 timestamp of when the document was created

Example:

"2024-01-01T12:00:00Z"

data.updated_at

string

ISO 8601 timestamp of when the document was last updated

Example:

"2024-01-01T12:05:00Z"

data.callback_url

string

URL that receives status updates

Example:

"https://your-server.com/webhook"

data.tags

string[]

Array of document tags

Example:

["important", "meeting"]

data.properties

object

Additional document properties

Example:

{ "department": "sales", "priority": "high" }

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

Get Document Delete Document

⌘I

Introduction

Conversation

Persona

Replica

Objectives

Guardrails

Knowledge Base

Video Generation

List Documents

Authorizations

Query Parameters

Response