Objects

UploadResult

Result of a file upload: queued (asynchronous, the job is in the queue), skipped (this file already exists: duplicate, card_id, and card if your data profile can see the card), ready (synchronous indexing finished) or error (synchronous indexing failed; the HTTP status is still 200).

Fields

statusstringrequired
Allowed values: queuedskippedreadyerror
job_idinteger
jobJob
cardCard | null
duplicatetrue
card_idstring | null
reasonstring
unchanged or an identical file is already indexed.
tablesinteger
timingsobject
Fields
- total_snumber
errorstring

Used by

POST/v1/cardsUpload a file as a card
PUT/v1/cards-by-external-id/{external_id}Create or replace a card by external ID
PUT/v1/cards/{card_id}/contentReplace the content of a card