Create document
Create document. See the OpenAPI-defined parameters, request body, and responses below.
POST
/DocumentCreate document. See the OpenAPI-defined parameters, request body, and responses below.
OpenAPI description: Este endpoint cria um novo documento, opcionalmente com arquivo, com os dados fornecidos.
Authentication
Authentication required. Send your user API key in the X-API-Key header.
Parameters
This operation has no path, query, or header parameters.
Request body
Content type: multipart/form-data · Schema: object
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
file | string · binary | No | — | — |
Id | integer · int32 | No | — | — |
Title | string | No | — | — |
Description | string | No | — | — |
FileUrl | string | No | — | — |
DocumentStatusId | integer · int32 | No | — | — |
DocumentType | DocumentType | No | — | — |
DocumentChecklistId | integer · int32 | No | — | — |
Private | boolean | No | — | — |
Example request
curl --request POST \
--url 'https://api.zild.ai/Document' \
--header 'X-API-Key: YOUR_USER_API_KEY' \
--form 'file=@file' \
--form 'Id={Id}' \
--form 'Title={Title}' \
--form 'Description={Description}' \
--form 'FileUrl={FileUrl}' \
--form 'DocumentStatusId={DocumentStatusId}' \
--form 'DocumentType={DocumentType}' \
--form 'DocumentChecklistId={DocumentChecklistId}' \
--form 'Private={Private}'
Responses
| Status | Description | Response body |
|---|---|---|
200 | Documento criado com sucesso | 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