Skip to main content
PUT
/
v1
/
documents
/
{document_id}
Update Document
curl --request PUT \
  --url https://api.simplicity.ai/v1/documents/{document_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "original_filename": "<string>",
  "metadata": {
    "title": "<string>",
    "keywords": [
      "<string>"
    ]
  }
}
'
{
  "form_id": "<string>",
  "form_name": "<string>",
  "original_form_name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "form_description": "<string>",
  "form_title": "<string>",
  "form_url": "<string>",
  "last_filled_at": "2023-11-07T05:31:56Z",
  "file_size": 123,
  "fillable_field_count": 123,
  "source_document_details": [
    {
      "file_key": "<string>",
      "external_document_id": "<string>",
      "document_id": "<string>",
      "extension": "<string>",
      "original_filename": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
document_id
string
required

Body

application/json
​
original_filename
string | null

The original filename of the document

​
metadata
Metadata · object

The metadata of the document

Response

Successful Response

​
form_id
string
required
​
form_name
string
required
​
original_form_name
string
required
​
updated_at
string<date-time>
required
​
created_at
string<date-time>
required
​
form_description
string
​
form_title
string
​
form_url
string
​
last_filled_at
string<date-time>
​
file_size
integer
​
fillable_field_count
integer
​
source_document_details
Source Document Details · object[]