- Documents
- Get Document Status
Documents
Get Document Status
GET
/documents/{document_id}/status
curl --request GET \
--url https://app.backboard.io/api/documents/{document_id}/status \
--header 'X-API-Key: <api-key>' \
--header 'authorization: <authorization>' \
--header 'x_session_token: <x_session_token>'
curl --request GET \
--url https://app.backboard.io/api/documents/{document_id}/status \
--header 'X-API-Key: <api-key>' \
--header 'authorization: <authorization>' \
--header 'x_session_token: <x_session_token>'Authorizations
X-API-Key
required
string
API Key authentication
Query Parameters
document_id
required
string
authorization
x_session_token
Response
application/json
200
422
Successful Response
document_id
required
string
Document Id
filename
required
string
Filename
document_type
required
string
Document Type
status
required
string
Status
created_at
required
string
Created At
status_message
string | null
Status Message
file_size_bytes
integer | null
File Size Bytes
total_tokens
integer | null
Total Tokens
chunk_count
integer | null
Chunk Count
processing_started_at
string | null
Processing Started At
processing_completed_at
string | null
Processing Completed At
updated_at
string | null
Updated At
curl --request GET \
--url https://app.backboard.io/api/documents/{document_id}/status \
--header 'X-API-Key: <api-key>' \
--header 'authorization: <authorization>' \
--header 'x_session_token: <x_session_token>'
curl --request GET \
--url https://app.backboard.io/api/documents/{document_id}/status \
--header 'X-API-Key: <api-key>' \
--header 'authorization: <authorization>' \
--header 'x_session_token: <x_session_token>'