Skip to main content
GET
/
documents
/
{filename}
Get a document by filename
curl --request GET \
  --url https://api.artosai.com/documents/{filename} \
  --header 'Authorization: Bearer <token>'
{
  "document_id": "<string>",
  "filename": "<string>",
  "upload_date": "2023-11-07T05:31:56Z",
  "file_size": 123,
  "s3_url": "<string>",
  "file_type": "<string>",
  "document_type": "<string>",
  "description": "<string>",
  "file_synopsis": "<string>",
  "processing_status": "<string>",
  "extraction_metadata": {
    "total_pages": 123,
    "total_words": 123,
    "total_images": 123,
    "total_tables": 123,
    "extraction_format": "<string>",
    "last_processed": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

filename
string
required

Response

200 - application/json

Detailed document metadata

A processed document and its metadata.

document_id
string
filename
string
upload_date
string<date-time>
file_size
integer

Size in bytes

s3_url
string<uri>
file_type
string
document_type
string
description
string
file_synopsis
string
processing_status
string
extraction_metadata
object