Skip to navigation
Paperwork APISpace Files

Get a file record with download URLs

View as Markdown

Returns the file record plus a urls object of minted download links, each valid ~1 hour: urls.file (the stored original), and once processing has produced them, urls.processedMd (extracted markdown) and urls.processedJson (structured/grounded JSON). The record also carries status (waiting | stored | processing | processed | failed), processingKind, processingError, size, artifacts, and createdAt/storedAt/processedAt timestamps — poll this endpoint after uploading to watch status. Returns 404 if the file does not belong to :spaceId (cross-space access is hidden). Authorization: requires space:read on :spaceId (missing permission → 404; org admins bypass).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

spaceIdstringRequired
fileIdstringRequired

Response

The file record, with minted ~1h download URLs.

idstring
fileNamestring
parentTypestring
parentIdstring
mimeTypestring
sizedouble or null
Size in bytes, null until stored.
statusenum

Terminal values are stored (uploaded, no processing requested), processed and failed; waiting and processing mean keep polling.

Allowed values:
processingKindenum or null
Allowed values:
createdAtdatetime
processingErrorstringOptional
parentFileIdstringOptional

Source file this one was generated from (e.g. a redacted or signed copy).

artifactslist of stringsOptional

Parsing byproducts present, e.g. structured, transcript.

indexVectorsbooleanOptional
indexOntologybooleanOptional
storedAtdatetimeOptional
processedAtdatetimeOptional
urlsobjectOptional

Minted download links, each valid ~1 hour. Present on single-file reads only — list responses mint none.