Create a new document

Develop Env

http://localhost:3030

POST

/platform/api/v1/documents

Create a new document for a specific assistant

Request

Authorization

API Key

Add parameter in header

api_access_token

Example:

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

Body Params application/json; charset=utf-8Required

Examples

Responses

🟢201

application/json; charset=utf-8

Document created successfully

Body

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://localhost:3030/platform/api/v1/documents' \
--header 'api_access_token: <api-key>' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "name": "Product Manual",
    "external_link": "https://example.com/manual.pdf",
    "content": "This is the content of the product manual...",
    "assistant_id": 123
}'

Response Example

201 - Example 1

{
    "success": true,
    "document": {
        "id": 456,
        "name": "Product Manual",
        "external_link": "https://example.com/manual.pdf",
        "content": "This is the content of the product manual...",
        "assistant_id": 123,
        "account_id": 789,
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z"
    },
    "message": "Document created successfully with FAQ and embeddings",
    "faqs_generated": 5
}

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

List all documents

Show a specific document