DocsICP FilingConsole
Documentation

DescribeDocument

Updated at:
Copy as MD
Product
My Favorites

Retrieves the details of a specific document.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
KbUuid

string

Yes

The ID of the knowledge base.

kb-***
DocumentName

string

Yes

The name of the document.

test.md

Response elements

Element

Type

Description

Example

object

The response object.

RequestId

string

The unique request ID. Provide this ID for troubleshooting if an error occurs.

67E910F2-4B62-5B0C-ACA3-7547695C****
Data

object

The details of the document.

KbUuid

string

The ID of the knowledge base.

kb-***
Name

string

The name of the document.

test.md
Description

string

The description of the document.

abc
FileExt

string

The file extension of the document.

md
DocumentLoaderName

string

The name of the document loader.

ADBPGLoader
TextSplitterName

string

The name of the text splitter.

ChineseRecursiveTextSplitter
FileSize

integer

The size of the document in bytes.

20307
DocsCount

integer

The number of chunks.

123
State

integer

The document state. Possible values are:

  • 0: Parsing complete.

  • -1: Not parsed.

  • -2: Parsing in progress.

  • -3: Parsing failed.

  • -4: Parsing canceled.

0
GmtCreate

string

The creation time of the document, in UTC.

2026-04-22 22:59:35
GmtModified

string

The last modification time of the document, in UTC.

2026-04-24 21:22:53
Summary

string

The summary of the document.

This is a test document.
Keywords

string

The keywords of the document.

["test","abc"]
Success

boolean

Indicates whether the request succeeded. Valid values:

  • true: The request succeeded.

  • false: The request failed.

true
ErrorCode

string

The error code returned when the request fails.

KnowledgeBaseNotFound
ErrorMessage

string

The error message returned when the request fails.

Resource not found kb-***

Examples

Success response

JSON format

{
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "Data": {
    "KbUuid": "kb-***",
    "Name": "test.md",
    "Description": "abc",
    "FileExt": "md",
    "DocumentLoaderName": "ADBPGLoader",
    "TextSplitterName": "ChineseRecursiveTextSplitter",
    "FileSize": 20307,
    "DocsCount": 123,
    "State": 0,
    "GmtCreate": "2026-04-22 22:59:35",
    "GmtModified": "2026-04-24 21:22:53",
    "Summary": "This is a test document.",
    "Keywords": "[\"test\",\"abc\"]"
  },
  "Success": true,
  "ErrorCode": "KnowledgeBaseNotFound",
  "ErrorMessage": "Resource not found kb-***\n"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.