Body_public_upload_documents_api_v1_workflows__workflow_id__documents_post
filesBinary files to upload. File Blobs. Not 1s and 0s, but actual files
file_namesDisplay names for each uploaded file, parallel to the files array.
JSON object with customer reference data for validation columns
ExtractionData
iddocument_idcolumn_idURL of the source document
valueExtracted value; shape depends on column type
Extraction cell status
ExtractionPage
totalTotal number of extraction results
pageCurrent page number
limitItems per page
BulkExtractRequest
Specific documents to extract. Should be used for filtering
Collection ID to extract. Should be used for filtering
Specific columns to extract. Should be used for filtering
forceForce re-extraction of already extracted columns
MergeCollectionDocumentsRequest
Document labels in desired merge order.
ColumnType
Column data types for extraction fields
ConfirmUploadRequest
file_idsFile IDs to confirm
Add documents to existing collection
Create new collection and add documents
validation_dataCustomer reference JSON to validate extractions against
DeleteResponse
statusOperation status
Deleted workflow ID
Deleted column ID
Deleted document ID
CreateEntityApiKeyRequest
namekey_environmenttest → alk_test.* token; live → alk_live.* (default)
Restrict key to these workflow IDs; omit for all entity workflows
Override default RPM cap
DocumentProcessingStatus
Document processing pipeline status
EntityApiKeyCreatedResponse
secretFull Bearer token (shown once). Format: {alk_live|alk_test}.
EntityApiKeyListItem
idnametoken_prefixkey_hintscopesFileUploadMetadata
filenameOriginal filename
content_typeMIME type of the file
size_bytesFile size in bytes
APIDocumentData
nameworkflow_idstatusDocument processing pipeline status
File URL from associated file
ApprovalType
How many approvers need to sign off before a stage's gate is satisfied.
ANY: one approval advances the doc. ALL: every approver listed on the stage must approve.
ExtractionStatus
Extraction result status
PaginatedExtractionResponse
totalTotal count
pageCurrent page
limitItems per page
pagesTotal pages
List of items
File URLs for each document, ordered by label_order when supplied.
WorkflowExtractionAPIData
document_idcolumn_ididDisplay name of the column
statusExtraction result status
Signed URL for the source document file
Whether the extracted value matches the customer reference data
Extracted value
Confidence level of the extraction
LLM reasoning
UploadURLItem
file_idFile record ID
signed_urlGCS v4 signed PUT URL
filenameSanitized filename
UploadURLRequest
File metadata for each upload
UploadURLResponse
Signed URL items
WorkflowColumnData
nameColumn name
column_typeColumn data type
promptNatural language extraction prompt
workflow_idorderDisplay order
Column width in UI
Tag options [{id, label, color, stageId}]
inputsList of column IDs this column depends on
Task type for this column
Model ID for this column
Sub-field definitions for table columns [{name, type, prompt}]
idis_deletedWorkflowData
nameWorkflow name
app_idApplication ID (e.g., 'deal-screening')
entity_idWorkflow description
Extensible metadata
idstatusWorkflow lifecycle status
is_extractingOverall extraction status: not_started, pending, complete, has_failures
WorkflowDocumentData
nameDocument name
workflow_idAssociated file ID
Current workflow stage
is_collectionIs this a collection
Parent document ID for collections
Collection ID this document belongs to
Order within collection
User-defined label for the document
idstatusDocument processing pipeline status
File URL from associated file
WorkflowStageData
idStage ID (e.g. 'stage_approved')
labelDisplay label
is_systemSystem stage cannot be deleted
positionStage color (e.g. 'emerald', 'blue')
requires_approvalapprover_idsapproval_typeHow many approvers need to sign off before a stage's gate is satisfied.
ANY: one approval advances the doc. ALL: every approver listed on the stage must approve.