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
Body_public_bulk_upload_documents_api_v1_workflows__workflow_id__documents_bulk_post
filesBinary files to upload. Every file referenced by any manifest item must be included here.
manifestJSON array of upload groups, one item per person or group. Item fields: files (required, list of uploaded filenames or zero-based indexes into files[]), collection_name or collection_id (optional, mutually exclusive; several files, or naming a collection, make the item a collection), validation_data (optional object with reference data for that item), file_names (optional display names parallel to the item files). An item with more than one file must set collection_name or collection_id. validation_data is capped at 50 keys and 4096 bytes. Omit validation_data to leave the reference data on an existing collection untouched. Sending it with a collection_id replaces the stored object wholesale, so send the complete object rather than a partial update. Every uploaded file must be referenced by exactly one item; use indexes when filenames repeat or when a file was uploaded without a name. Example: [{"files": ["claim1.pdf", "claim1-photos.pdf"], "collection_name": "Claim 1001", "validation_data": {"policy_number": "POL-1"}}, {"files": ["claim2.pdf"], "validation_data": {"policy_number": "POL-2"}}]
extract_when_readyStart extraction automatically once every document in this batch has converted or failed conversion. A document counts as ready either way, so one bad file cannot stall the batch; documents from multiple uploads that become ready together are extracted in a single run. If the account has insufficient credits, extraction does not start and the reason is recorded on the affected documents' error_message.
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
NoMatchFallback
How an option field handles a result outside its declared options.
ConfirmUploadRequest
file_idsFile IDs to confirm
Add documents to existing collection
Create new collection and add documents
Customer reference JSON to validate extractions against
ConfirmUploadItem
file_idsFile IDs to confirm, from the upload-url response
Add documents to an existing collection
Create a new collection and add documents to it
Customer reference data to validate extractions for this item against
ConfirmUploadBulkRequest
One entry per person or group being confirmed
extract_when_readyStart extraction automatically once every document in this batch has converted or failed conversion. A document counts as ready either way, so one bad file cannot stall the batch; documents from multiple uploads that become ready together are extracted in a single run. If the account has insufficient credits, extraction does not start and the reason is recorded on the affected documents' error_message.
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
DeleteResponse
statusOperation status
Deleted workflow ID
Deleted column ID
Deleted document ID
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
idnameworkflow_idstatusDocument processing pipeline status
BulkUploadItemResult
Uploaded documents for this item. Empty when error is set.
Failure reason for this item. When set, documents is empty and any files uploaded for this item were rolled back.
BulkUploadResponse
uploaded_countDocuments created across all items; an item with three files adds three
failed_countNumber of items that failed; see error on each item
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
WorkflowExtractionAPIData
document_idcolumn_idName of the source document
Page number where the value was found
Source documents for collection extractions
idDisplay 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_idDoc generation settings when task_type is generate
fallback_behaviorHow option fields handle values outside their declared options
Value to use when no option matches and default_value is selected
orderDisplay 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_idllm_modelLLM model (empty = use provider default)
llm_providerLLM provider name
Workflow description
Extensible metadata
idstatusWorkflow lifecycle status
is_extractingOverall extraction status: not_started, pending, complete, has_failures
Documents whose extraction has fully resolved, including ones whose cells failed
Documents in the workflow
WorkflowDocumentData
nameDocument name
workflow_idMIME type of document content
Signed GCS GET URL for document content
TTL for content_url in seconds
ID-enriched LLM context
First 1000 characters of the LLM context, for thumbnails
Per-page dimensions the segment bboxes are expressed in
Document segments with bboxes
Customer reference data for validation, stored on standalone documents
Associated 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.