v1

latestOpenAPI 3.1.0Apache-2.02026-07-17586455.2 KB

Documents

Register a pointer-only document.

Idempotent on (user_id, source_site, provider, external_id, provider_version). Returns 201 on first registration; 200 on a re-register that matches an active row. Registration accepts storage_mode = 'pointer_only'; managed_blob and inline_small_text return 400.

post/v1/documents

Request body

account_idstring nullable

consent_policyobject

content_hashstring nullable

display_namestring nullable

external_idstring required

Required. external_id.

external_uristring nullable

extraction_status'pending' | 'not_required' | 'unsupported'

Initial extraction-layer state at register time. 'pending' = caller intends to extract; 'not_required' = pointer-only flow (default); 'unsupported' = caller knows the file type cannot be extracted. Service-owned values ('running', 'complete', 'failed') are rejected.

metadataobject

mime_typestring nullable

providerstring required

Required. provider.

provider_versionstring nullable

retention_policyobject

semantic_index_status'pending' | 'not_required'

Initial semantic-index-layer state at register time. 'pending' = caller intends to index; 'not_required' = no indexing planned. Service-owned transitions handle 'running', 'complete', 'failed', 'stale'.

size_bytesinteger

source_modified_atstring date-time

source_sitestring required

Required. source_site.

storage_mode'pointer_only'

user_idstring required

Required. user_id.

Response

Idempotent re-registration; document already existed.

createdboolean required