Documents

get

Authorizations

bearer

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Query parameters

afterstringOptional

limitnumberOptional

externalIdstringOptional

Responses

200Success

application/json

Responseall of

and

get

/v1/documents

HTTPcURLJavaScriptPython

GET /v1/documents HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "paging": {
    "next": {
      "after": "text"
    }
  },
  "data": [
    {
      "id": "text",
      "file_name": "text",
      "external_id": "text",
      "original_file_name": "text",
      "original_file_path": "text",
      "original_author": "text",
      "extension": "text",
      "file_path": "text",
      "valid_from": "text",
      "valid_until": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "size_kb": 1,
      "storage": "text"
    }
  ]
}

post

Authorizations

bearer

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Body

application/json

file_namestringRequired

A user friendly name for the document

external_idstringRequired

The id generated by the system from which the document was extracted

original_file_namestring | nullableRequired

The file name as of the extracted file.

original_file_pathstring | nullableRequired

The file path of the extracted file.

original_authorstring | nullableRequired

The author of the document.

extensionstringRequired

The file extension.

file_pathstringRequired

The file path as stored in the object storage.

valid_fromstring | nullableRequired

The date at which the document has been made available.

valid_untilstring | nullableRequired

The date at which the document will be made unavailable.

size_kbnumber | nullableRequired

The file size in kb.

storagestringRequired

The object storage ID to which the document is associated

Responses

200Success

application/json

post

/v1/documents

HTTPcURLJavaScriptPython

POST /v1/documents HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 276

{
  "file_name": "text",
  "external_id": "text",
  "original_file_name": "text",
  "original_file_path": "text",
  "original_author": "text",
  "extension": "text",
  "file_path": "text",
  "valid_from": "text",
  "valid_until": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "size_kb": 1,
  "storage": "text"
}

200Success

{
  "id": "text",
  "file_name": "text",
  "external_id": "text",
  "original_file_name": "text",
  "original_file_path": "text",
  "original_author": "text",
  "extension": "text",
  "file_path": "text",
  "valid_from": "text",
  "valid_until": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "size_kb": 1,
  "storage": "text"
}

get

Authorizations

bearer

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Path parameters

documentIdstringRequired

Responses

200Success

application/json

get

/v1/documents/{documentId}

HTTPcURLJavaScriptPython

GET /v1/documents/{documentId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "text",
  "file_name": "text",
  "external_id": "text",
  "original_file_name": "text",
  "original_file_path": "text",
  "original_author": "text",
  "extension": "text",
  "file_path": "text",
  "valid_from": "text",
  "valid_until": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "size_kb": 1,
  "storage": "text"
}

put

Authorizations

bearer

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Path parameters

documentIdstringRequired

Body

application/json

idstringRequired

Unique ID

file_namestringRequired

A user friendly name for the document

external_idstringRequired

The id generated by the system of referenced

original_file_namestring | nullableRequired

The file name as of the extracted file.

original_file_pathstring | nullableRequired

The file path of the extracted file.

original_authorstring | nullableRequired

The author of the document.

extensionstringRequired

The file extension.

file_pathstringRequired

The file path as stored in the object storage.

valid_fromstring | nullableRequired

The date at which the document has been made available.

valid_untilstring | nullableRequired

The date at which the document will be made unavailable.

size_kbnumber | nullableRequired

The file size in kb.

storagestringRequired

The object storage ID to which the document is associated

Responses

200Success

application/json

put

/v1/documents/{documentId}

HTTPcURLJavaScriptPython

PUT /v1/documents/{documentId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 288

{
  "id": "text",
  "file_name": "text",
  "external_id": "text",
  "original_file_name": "text",
  "original_file_path": "text",
  "original_author": "text",
  "extension": "text",
  "file_path": "text",
  "valid_from": "text",
  "valid_until": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "size_kb": 1,
  "storage": "text"
}

200Success

{
  "id": "text",
  "file_name": "text",
  "external_id": "text",
  "original_file_name": "text",
  "original_file_path": "text",
  "original_author": "text",
  "extension": "text",
  "file_path": "text",
  "valid_from": "text",
  "valid_until": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "size_kb": 1,
  "storage": "text"
}

delete

Authorizations

bearer

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Path parameters

documentIdstringRequired

Responses

200Success

application/json

delete

/v1/documents/{documentId}

HTTPcURLJavaScriptPython

DELETE /v1/documents/{documentId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "text",
  "isDeleted": true
}