Skip to main content
PATCH
/
api
/
documents
/
{document_id}
/
enrichment
Confirm crew enrichment suggestions and push to DataHub
curl --request PATCH \
  --url https://api.example.com/api/documents/{document_id}/enrichment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "summary": "<string>",
  "tags": [
    "<string>"
  ],
  "glossary_terms": [
    "<string>"
  ],
  "domain": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "filename": "<string>",
  "mime_type": "<string>",
  "size_bytes": 123,
  "page_count": 123,
  "chunk_count": 123,
  "subtype": "<string>",
  "datahub_urn": "<string>",
  "extraction_warning": "<string>",
  "suggested_summary": "<string>",
  "suggested_domain": "<string>",
  "error": "<string>",
  "s3_key": "<string>",
  "suggested_tags": [
    "<string>"
  ],
  "suggested_glossary_terms": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt

Use this file to discover all available pages before exploring further.

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

Body

application/json
​
summary
string | null
​
tags
string[] | null
​
glossary_terms
string[] | null
​
domain
string | null

Response

Successful Response

​
id
string<uuid>
required
​
filename
string
required
​
mime_type
string
required
​
size_bytes
integer
required
​
page_count
integer | null
required
​
chunk_count
integer | null
required
​
subtype
string | null
required
​
status
enum<string>
required

Lifecycle status of an ingested document.

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

Crew-driven enrichment lifecycle.

Available options:
pending,
running,
awaiting_review,
confirmed,
failed
​
datahub_urn
string | null
required
​
extraction_warning
string | null
required
​
suggested_summary
string | null
required
​
suggested_domain
string | null
required
​
error
string | null
required
​
s3_key
string | null
required
​
suggested_tags
string[]
​
suggested_glossary_terms
string[]