Get document

Get document. See the OpenAPI-defined parameters, request body, and responses below.

GET /Document/{id}

Get document. See the OpenAPI-defined parameters, request body, and responses below.

OpenAPI description: Este endpoint retorna os detalhes de um documento especificado pelo identificador.

Authentication

Authentication required. Send your user API key in the X-API-Key header.

Parameters

Name	Location	Type	Required	Description	Constraints
`id`	`path`	`integer · int32`	Yes	—	—

Request body

This operation does not accept a request body.

Example request

curl --request GET \
  --url 'https://api.zild.ai/Document/{id}' \
  --header 'X-API-Key: YOUR_USER_API_KEY'

Responses

Status	Description	Response body
`200`	Sucesso ao retornar o documento	`application/json` · `DocumentCreateResponseDto`

Example response (200):

{
  "id": 0,
  "title": "string",
  "description": "string",
  "extractedText": "string",
  "analysisText": "string",
  "fileUrl": "string",
  "documentStatusId": 0,
  "documentType": 0,
  "createdAt": "2026-09-22T18:00:00Z",
  "analizedAt": "2026-09-22T18:00:00Z",
  "documentChecklistId": 0,
  "private": true
}

Data models

DocumentCreateResponseDto

Property	Type	Required	Description	Constraints
`id`	`integer · int32`	No	—	—
`title`	`string`	No	—	nullable
`description`	`string`	No	—	nullable
`extractedText`	`string`	No	—	nullable
`analysisText`	`string`	No	—	nullable
`fileUrl`	`string`	No	—	nullable
`documentStatusId`	`integer · int32`	No	—	—
`documentType`	`DocumentType`	No	—	—
`createdAt`	`string · date-time`	No	—	nullable
`analizedAt`	`string · date-time`	No	—	nullable
`documentChecklistId`	`integer · int32`	No	—	—
`private`	`boolean`	No	—	—

DocumentType

0 = Image; 1 = Word; 2 = PDF; 3 = Text

integer