Skip to content

Create a new document

POST
/document

Authorizations

Request Body required

object
refId
required

Document reference ID

string
docExt
required

Document extension

string
docName
required

Document name

string
docType
required

Document type

string
uploadBatchId

Upload batch identifier

string
isPublic

Document visibility

boolean
source
required

Document source

string
templateId

Associated template ID

string
groupId

Associated group ID

string
prompts
Array<object>
object
id
required

Prompt identifier

string
name
required

Prompt name

string
fieldType
required

Field type

string
format
required

Format specification

string
description
required

Prompt description

string
itemType

Item type

string
children
Array<object>
object
bulkDocumentId
string
providerModelId
string

Responses

201

Document created successfully

object
refId
required

Document reference ID

string
docExt
required

Document extension

string
docName
required

Document name

string
docType
required

Document type

string
uploadBatchId

Upload batch identifier

string
isPublic

Document visibility

boolean
source
required

Document source

string
templateId

Associated template ID

string
groupId

Associated group ID

string
prompts
Array<object>
object
id
required

Prompt identifier

string
name
required

Prompt name

string
fieldType
required

Field type

string
format
required

Format specification

string
description
required

Prompt description

string
itemType

Item type

string
children
Array<object>
object
bulkDocumentId
string
providerModelId
string

400

Bad request

object
code
required

HTTP status code

integer
status
required

Error status message

string