Skip to main content
GET
/
v1
/
documents
/
{document_id}
Get Document By Id
curl --request GET \
  --url https://api.simplicity.ai/v1/documents/{document_id} \
  --header 'X-API-Key: <api-key>'
{
  "document_id": "<string>",
  "file_key": "<string>",
  "extension": "<string>",
  "original_filename": "<string>",
  "document_type": "SOURCE_DOCUMENT",
  "original_document_url": "<string>",
  "presigned_url": "<string>",
  "metadata": {
    "title": "<string>",
    "keywords": [
      "<string>"
    ],
    "total_pages": 123,
    "file_size": 123,
    "file_type": "PDF"
  },
  "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

Response

Successful Response

document_id
string
required

The unique identifier for the document

file_key
string
required

The file key for the document in the S3 bucket

extension
string | null

The extension of the document

original_filename
string | null

The original filename of the document

document_type
enum<string> | null
default:SOURCE_DOCUMENT

Whether this file is the FORM_DOCUMENT (the form to fill) or a SOURCE_DOCUMENT (context for filling). See the DocumentSource schema for details.

Available options:
FORM_DOCUMENT,
SOURCE_DOCUMENT
original_document_url
string | null

The original URL of the document that was supplied by the user

presigned_url
string | null

The Presigned url of the document

metadata
DocumentMetadata · object

The metadata of the document

created_at
string<date-time>
updated_at
string<date-time> | null

Date and time document was updated