Affinda Get Documents
Tool to retrieve a list of all documents. Use when you need to list documents in your Affinda workspace after authentication.
Write ActionRisk level 2 of 5API key connectionFree Action
Tool to retrieve a list of all documents. Use when you need to list documents in your Affinda workspace after authentication.
countbooleanIf false, skip computing document count for faster response on large collections. Default is true.
limitintegerMaximum number of documents to return (1-100).
readybooleanFilter by ready status. True for documents that have finished processing.
statestringFilter by document state. Options: uploaded, review, validated, archived, rejected.
failedbooleanFilter by failed processing status. True for failed documents only.
offsetintegerNumber of items to skip before starting to collect the result set (pagination).
searchstringPartial, case-insensitive match with file name or tag name.
compactbooleanIf true, compact response to annotations' parsed data only. Default is false.
orderingstringSort the result set. Use '-' prefix for DESC order. Options: file_name, extractor, created_dt, validated_dt, archived_dt.
workspacestringIdentifier of the workspace to filter documents by. Recommended for performance.
collectionstringIdentifier of the collection to filter documents by.
include_databooleanIf true, include parsed data summary in the response. Default is false.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.