← Tools Reference

Affinda

Affinda integration (AI, Data). Imported from open-connector.

API key6 toolshttps://api.affinda.com
GET
affinda_list_organizations
List Affinda organizations available to the connected API key.

/v3/organizations

GET
affinda_list_workspaces
List Affinda workspaces in an organization.

/v3/workspaces

2 parameters
ParamTypeRequiredDescription
organizationstringrequiredThe Affinda organization identifier to list workspaces for.
namestringoptionalOnly return workspaces whose name matches this value.
GET
affinda_list_document_types
List Affinda document types available to the API key.

/v3/document_types

2 parameters
ParamTypeRequiredDescription
organizationstringoptionalFilter document types by Affinda organization identifier.
workspacestringoptionalFilter document types by Affinda workspace identifier.
POST
affinda_create_document_from_url
Upload a document to Affinda from a URL and optionally wait for parsing results.

/v3/documents

15 parameters
ParamTypeRequiredDescription
urlstringrequiredThe publicly reachable document URL for Affinda to download and parse.
workspacestringrequiredThe Affinda workspace identifier to upload the document to.
documentTypestringoptionalThe Affinda document type identifier when the document type is already known.
waitbooleanoptionalWhether Affinda should wait for parsing to complete before responding.
customIdentifierstringoptionalAn optional user-defined identifier for tracking the document in Affinda.
fileNamestringoptionalThe filename Affinda should associate with this document.
expiryTimestringoptionalThe ISO 8601 time when Affinda should automatically delete the document.
languagestringoptionalThe document language code to send to Affinda.
rejectDuplicatesbooleanoptionalWhether Affinda should reject duplicate documents without consuming credits.
lowPrioritybooleanoptionalWhether Affinda should process this document as low priority.
compactbooleanoptionalWhether Affinda should return a compact parse result when wait is true.
deleteAfterParsebooleanoptionalWhether Affinda should delete stored data after parsing. Only use with wait tru…
enableValidationToolbooleanoptionalWhether the document should be viewable in the Affinda Validation Tool.
useOcrbooleanoptionalWhether Affinda should force OCR for this document.
llmHintstringoptionalOptional hint inserted into Affinda's LLM prompt.
GET
affinda_list_documents
List Affinda documents with optional workflow and pagination filters.

/v3/documents

12 parameters
ParamTypeRequiredDescription
offsetintegeroptionalThe number of documents to skip before collecting results.
limitintegeroptionalThe number of documents to return.
workspacestringoptionalFilter by Affinda workspace identifier.
statestringoptionalFilter by the Affinda document state.
tagsarrayoptionalFilter by Affinda tag IDs.
searchstringoptionalMatch document file names or tag names case-insensitively.
includeDatabooleanoptionalWhether Affinda should include parsed data summaries in the list.
failedbooleanoptionalFilter by failed processing status.
readybooleanoptionalFilter by ready processing status.
validatablebooleanoptionalFilter to documents that can be validated.
customIdentifierstringoptionalFilter documents by the custom identifier set at upload.
compactbooleanoptionalWhether Affinda should return compact parsed data.
GET
affinda_get_document
Get one Affinda document by identifier.

/v3/documents/{identifier}

2 parameters
ParamTypeRequiredDescription
identifierstringrequiredThe Affinda document identifier.
compactbooleanoptionalWhether Affinda should return compact parsed data.