Create a Document from a File

POST

https://api-platform.digitpulse.ai/v1/datasets/{dataset_id}/document/create-by-file

Last modified:2025-01-13 09:02:22

This API is based on an existing knowledge and creates a new document through a file based on this knowledge.

Request

Path Params

Header Params

Body Params multipart/form-data

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api-platform.digitpulse.ai/v1/datasets//document/create-by-file' \
--header 'Authorization: ' \
--header 'X-Timestamp: 1739933362' \
--header 'X-Signature: 1739933362' \
--form 'file=@""' \
--form 'data="{\"indexing_technique\":\"high_quality\",\"process_rule\":{\"rules\":{\"pre_processing_rules\":[{\"id\":\"remove_extra_spaces\",\"enabled\":true},{\"id\":\"remove_urls_emails\",\"enabled\":true}],\"segmentation\":{\"separator\":\"###\",\"max_tokens\":500}},\"mode\":\"custom\"}}";type=multipart/form-data json string'

Responses

🟢200Success

application/json

Body

Example

{
    "document": {
        "id": "",
        "position": 1,
        "data_source_type": "upload_file",
        "data_source_info": {
            "upload_file_id": ""
        },
        "dataset_process_rule_id": "",
        "name": "Pulse AI.txt",
        "created_from": "api",
        "created_by": "",
        "created_at": 1695308667,
        "tokens": 0,
        "indexing_status": "waiting",
        "error": null,
        "enabled": true,
        "disabled_at": null,
        "disabled_by": null,
        "archived": false,
        "display_status": "queuing",
        "word_count": 0,
        "hit_count": 0,
        "doc_form": "text_model"
    },
    "batch": ""
}

Modified at 2025-01-13 09:02:22

Create a Document from Text

Create an Empty Knowledge Base