Get Document

Develop Env

https://dev.your-api-server.com

GET

/documents/{upload_id}

Get a document

Response:

Similar with POST /documents/upload, and pay attention to the following fields:

type:

collection: document collection

single_doc: standalone document

doc_of_collection: sub document of collection

documents: sub document list of collection, which only returns for collection

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://dev.your-api-server.com/documents/'

Response Example

200 - Example 1

{
    "id": "string",
    "status": 1,
    "name": "string",
    "created_at": 0,
    "type": "collection",
    "documents": [
        {
            "id": "string",
            "status": 1,
            "name": "string",
            "created_at": 0,
            "type": "collection"
        }
    ],
    "error_msg": {
        "error_code": 0,
        "error_msg": "string",
        "page_num": 0,
        "ocr_page_num": 0
    },
    "ocr_type": "disable"
}

Request

Path Params

upload_id

string

Upload Id

required

Responses

🟢200Successful Response

application/json

Body

string

required

status

enum<integer>

required

An enumeration.

Allowed values:

17101215202530405070120902103000-1-2-3-4-5-6-9-10-11-12-13-14-15-16-17-18-19-25

name

string

Name

required

created_at

integer

Created At

required

type

enum<string>

required

An enumeration.

Allowed values:

collectionsingle_docdoc_of_collection

documents

array[object (APIUploadResp) {5}]

Documents

optional

string

required

status

enum<integer>

required

An enumeration.

Allowed values:

17101215202530405070120902103000-1-2-3-4-5-6-9-10-11-12-13-14-15-16-17-18-19-25

name

string

Name

required

created_at

integer

Created At

required

type

enum<string>

required

An enumeration.

Allowed values:

collectionsingle_docdoc_of_collection

error_msg

object (DocumentErrorMessage)

optional

error_code

integer

Error Code

optional

error_msg

string

Error Msg

optional

page_num

integer

Page Num

optional

ocr_page_num

integer

Ocr Page Num

optional

ocr_type

enum<string>

optional

OCR type enum.

Allowed values:

disableautoforce

🟠422Validation Error

Modified at 2024-07-26 06:57:23

Upload Document

Delete Document