List all documents

Develop Env

http://localhost:3030

GET

/platform/api/v1/documents

Retrieve a list of all documents for a specific assistant

Request

Authorization

API Key

Add parameter in header

api_access_token

Example:

api_access_token: ********************

Query Params

Responses

🟢200

application/json; charset=utf-8

Documents retrieved successfully

Body

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://localhost:3030/platform/api/v1/documents?assistant_id' \
--header 'api_access_token: <api-key>'

Response Example

200 - Example 1

{
    "success": true,
    "documents": [
        {
            "id": 456,
            "name": "Product Manual",
            "external_link": "https://example.com/manual.pdf",
            "content": "This is the content of the product manual...",
            "assistant_id": 123,
            "assistant_name": "Customer Support Bot",
            "account_id": 789,
            "status": "in_progress",
            "faqs_count": 5,
            "created_at": "2024-01-15T10:30:00Z",
            "updated_at": "2024-01-15T10:30:00Z"
        }
    ],
    "total_count": 3,
    "message": "Documents retrieved successfully"
}

Modified at 2025-12-16 21:29:06

Create a new conversation

Create a new document