Get Document

GET

/v2/api/document/{document_id}

Retrieve comprehensive details about a specific document using its unique document_id. This endpoint is designed for authenticated users to access document metadata, content, processing status, and token usage details efficiently.

Purpose:

To fetch all relevant information about a document including its origin, creator, associated user, upload source, and current processing state.

To assist users in viewing, auditing, or managing documents based on ID reference.

What is document_id?

document_id is a unique numerical identifier assigned to each document at the time of upload or creation.

It serves as a reference key to locate and retrieve the exact document from the system without ambiguity.

How to View Your Document ID?

To find your Document ID, visit the View Document ID Guide.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///v2/api/document/0' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

{
    "id": 18998,
    "user": {
        "id": 160,
        "email": "user@example.com",
        "first_name": "User",
        "last_name": "User",
        "organization": 1
    },
    "created_by": "user@example.com",
    "created_on": "2025-01-07T19:54:44.656134Z",
    "modified_by": "user@example.com",
    "modified_on": "2025-01-07T19:54:44.656169Z",
    "type": "text",
    "source": "905f47b8-08db-4e08-8b16-29994194abd0.txt",
    "access_url": "https://testenvrstorage.blob.core.windows.net/dev-pdfcontent/905f47b8-08db-4e08-8b16-29994194abd0.txt",
    "text": "I am user",
    "tags": [
        "llama"
    ],
    "is_deleted": false,
    "upload_from": "web",
    "step": "completed",
    "is_failed": false,
    "summary_token_usage": {
        "total_tokens": 887,
        "prompt_tokens": 864,
        "completion_tokens": 23
    },
    "keywords_question_token_usage": {
        "total_tokens": 301,
        "prompt_tokens": 261,
        "completion_tokens": 40
    },
    "pages": -1,
    "corpus": 1352
}

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Detailed information about the document.

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Delete Users from Project

Edit Document

Get Document

How to View Your Document ID?#

Request

Responses

How to View Your Document ID?