Skip to main content
POST
Unlink document from source

Authorizations

x-api-key
string
header
required

API key authentication for the External Actor Gateway

Path Parameters

document_id
string
required

The document ID

Response

Document created successfully

versionNumber
integer
required
Required range: x <= 9007199254740991
validFrom
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
validTo
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
isDeleted
boolean
required
documentId
string
required
Minimum string length: 1
Pattern: ^doc_[a-z0-9]{26}$
folderId
string | null
required
Minimum string length: 1
Pattern: ^folder_[a-z0-9]{26}$
title
string
required
originalFileName
string | null
required
contentType
string | null
required
fileSizeBytes
integer | null
required
Required range: 0 <= x <= 9007199254740991
contentHash
string | null
required
metadata
object
required

Free-form JSON metadata attached to the document

sourceType
enum<string>
required
Available options:
upload,
source_link
Minimum string length: 1
Pattern: ^srclink_[a-z0-9]{26}$
sourceProviderType
enum<string> | null
required
Available options:
google_drive,
notion,
dropbox,
confluence
providerExternalId
string | null
required
processingStatus
enum<string>
required
Available options:
pending,
parsing,
chunking,
embedding,
extracting_kg,
ready,
failed
processingError
string | null
required