Document Polling

POST

/v2/api/document/polling

Allows authenticated users to poll the processing status and metadata of one or more documents using their unique document_ids.

Purpose:

Efficiently monitor the lifecycle and state of documents in the system.

Retrieve up-to-date metadata including tags, processing stage, summary output, and user information.

What is document_id?

A document_id is a unique numeric identifier assigned to a document when it is uploaded to the system.

It ensures precise tracking and referencing of a document across all document-related endpoints.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///v2/api/document/polling' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "document_ids": [
        19297
    ]
}'

Response Example

200 - Example 1

[
    {
        "id": 19297,
        "user": {
            "id": 16,
            "email": "user@example.com",
            "first_name": "user",
            "last_name": "Nasir",
            "organization": 1
        },
        "created_by": "user@example.com",
        "created_on": "2025-01-17T18:23:21.420968Z",
        "modified_by": "user@example.com",
        "modified_on": "2025-01-17T18:23:21.420989Z",
        "type": "file",
        "source": "Book11737138201.xlsx",
        "access_url": "https://testenvrstorage.blob.core.windows.net/dev-datafiles/Book11737138201.xlsx",
        "text": null,
        "tags": [
            "llama",
            "llms"
        ],
        "is_deleted": false,
        "upload_from": "web",
        "step": "completed",
        "is_failed": false,
        "summary_token_usage": {
            "total_tokens": 977,
            "prompt_tokens": 899,
            "completion_tokens": 78
        },
        "keywords_question_token_usage": {
            "total_tokens": 5210,
            "prompt_tokens": 4818,
            "completion_tokens": 392
        },
        "pages": 5,
        "corpus": 1739
    }
]

Request

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Successfully polled the document(s).

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Add Or Remove Tags On Document

Trigger a refresh(reindex) of a Document