Skip to main content
POST
Classify a document

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

document_id
string<uuid>
required

ID of the document.

Response

Successful Response

id
string<uuid>
required

Unique ID for the document.

filename
string
required

The uploaded file's name.

owner
string
required

Keycloak username of the person who uploaded the document.

mime_type
string
required

Media type of the uploaded file. For example, application/pdf.

size_bytes
integer
required

Size of the uploaded file in bytes.

page_count
integer | null
required

How many pages the document has.

chunk_count
integer | null
required

How many text chunks the document produces for search indexing.

subtype
string | null
required

The document's DataHub subtype, such as Runbook or FAQ.

status
enum<string>
required

The document's state in the upload pipeline.

Available options:
uploading,
extracting,
ocr_required,
indexed,
failed
enrichment_status
enum<string>
required

The document's state in the enrichment workflow.

Available options:
pending,
running,
awaiting_review,
confirmed,
failed
datahub_urn
string | null
required

URN identifying the document's entity in DataHub.

extraction_warning
string | null
required

A note about incomplete text extraction, such as a scanned PDF with no selectable text.

suggested_summary
string | null
required

AI-generated summary of the document.

error
string | null
required

Error message when processing the document failed.

s3_key
string | null
required

Storage key of the original file in S3.

suggested_tags
SuggestionItem · object[]

AI-suggested DataHub tags for the document.

suggested_glossary_terms
SuggestionItem · object[]

AI-suggested DataHub glossary terms for the document.

suggested_domain
SuggestionItem · object | null

AI-suggested DataHub domain for the document.