Skip to content

Upload Library Document

POST
/library/documents/upload

Upload ONE file to the Library. Multipart, like the app.

The app’s rules are enforced by the app and documented here so a caller sees them before spending the upload: 50 MB maximum, and the extension must be one of pdf, docx, doc, txt, md, mdx, csv, json, png, jpg, jpeg, xls, xlsx, ppt, pptx. Text-bearing types are extracted and indexed for retrieval; the rest are stored as bytes.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
account_id
Any of:
string
campaign_id
Any of:
string
context_type
string
default: global
Allowed values: global campaign account
file
required

The file. 50 MB maximum.

string format: binary
folder_path
required

Where it lands. The folder must already exist.

string

Responses

201

Successful Response

object
data
required

An open envelope for one document, folder or questionnaire.

Open on purpose: a Library document carries extraction metadata, a questionnaire carries per-provider processing detail, and a generated deal document carries structured_data and highlights whose shape is the generator’s rather than this contract’s. Pinning those would silently drop whatever the app learned to return that this file had not caught up on.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string