Result Retrieval
To access the result of the submitted document, it is necessary to make a GET request, passing the received document's ID upon upload.
Documents Service - Document's Return
GET Environment URL/api_document/documents/[id]
The method /api_document/documents/[id] receives the following parameters, where [id] is the document's UUID code.
Header
| Identifier | Value |
|---|---|
| Content-type | application/json |
| Accept | application/json |
| X-API-KEY | [api_key] |
Return
Status code 200
An HTTP code 200 is returned when the document is inserted correctly.
| Parameter | Description | Types | Examples |
|---|---|---|---|
| id | Internal code of the document | UUID | "95893394-337c-429c-..." |
| apiKeyId | Internal code of the API key | UUID | "113d37ed-6b47-46b6-..." |
| type | Internal code of the document type | Integer | 1 |
| fileType | Type of the document sent | String | "pdf" |
| data | Object returned by the AI | Model related to the document type. | json_object |
| processTime | Processing time | Float | 10.02232 |
| status | Document request status (0-Received, 1-Finished, 2-Error) | Integer | 3 |
| statusDesc | Document request status description (RECEIVED, FINISHED, ERROR) | String | "FINISHED" |
| createdAt | Time when the document request was created | Datetime | "01/01/2023 00:00:00.0000" |
| updatedAt | Time when the document request was updated | Datetime | "01/01/2023 00:00:00.0000" |
Exemplo
{
"id": "bc1bc4ea-8964-4bb7-97cc-2d77d39908d8",
"apiKeyId": "bc1bc4ea-8964-4bb7-97cc-2d77d39908d8",
"type": 1,
"fileType": "pdf",
"data": null,
"processTime": null,
"status": 1,
"statusDesc": "FINISHED",
"createdAt": "2022-10-14 14:38:50.045316",
"updatedAt": "2022-10-14 14:38:50.045316"
}