Skip to main content
POST
/
ingest
/
reference-document
Upload a reference document for styling templates
curl --request POST \
  --url https://api.artosai.com/ingest/reference-document \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form 'name=<string>' \
  --form 'description=<string>'
{
  "referenceDocumentId": "<string>",
  "name": "<string>",
  "filename": "<string>",
  "upload_date": "2023-11-07T05:31:56Z",
  "file_size": 123,
  "s3_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
​
file
file
required

Reference document file in DOCX format.

​
name
string
required

Human‑readable identifier for the reference document.

​
description
string

Optional description of the styling template.

Response

200 - application/json

Reference document uploaded

​
referenceDocumentId
string
​
name
string
​
filename
string
​
upload_date
string<date-time>
​
file_size
integer
​
s3_url
string<uri>