Affinda integration (AI, Data). Imported from open-connector.
https://api.affinda.com/v3/organizations
/v3/workspaces
| Param | Type | Required | Description |
|---|---|---|---|
| organization | string | required | The Affinda organization identifier to list workspaces for. |
| name | string | optional | Only return workspaces whose name matches this value. |
/v3/document_types
| Param | Type | Required | Description |
|---|---|---|---|
| organization | string | optional | Filter document types by Affinda organization identifier. |
| workspace | string | optional | Filter document types by Affinda workspace identifier. |
/v3/documents
| Param | Type | Required | Description |
|---|---|---|---|
| url | string | required | The publicly reachable document URL for Affinda to download and parse. |
| workspace | string | required | The Affinda workspace identifier to upload the document to. |
| documentType | string | optional | The Affinda document type identifier when the document type is already known. |
| wait | boolean | optional | Whether Affinda should wait for parsing to complete before responding. |
| customIdentifier | string | optional | An optional user-defined identifier for tracking the document in Affinda. |
| fileName | string | optional | The filename Affinda should associate with this document. |
| expiryTime | string | optional | The ISO 8601 time when Affinda should automatically delete the document. |
| language | string | optional | The document language code to send to Affinda. |
| rejectDuplicates | boolean | optional | Whether Affinda should reject duplicate documents without consuming credits. |
| lowPriority | boolean | optional | Whether Affinda should process this document as low priority. |
| compact | boolean | optional | Whether Affinda should return a compact parse result when wait is true. |
| deleteAfterParse | boolean | optional | Whether Affinda should delete stored data after parsing. Only use with wait tru… |
| enableValidationTool | boolean | optional | Whether the document should be viewable in the Affinda Validation Tool. |
| useOcr | boolean | optional | Whether Affinda should force OCR for this document. |
| llmHint | string | optional | Optional hint inserted into Affinda's LLM prompt. |
/v3/documents
| Param | Type | Required | Description |
|---|---|---|---|
| offset | integer | optional | The number of documents to skip before collecting results. |
| limit | integer | optional | The number of documents to return. |
| workspace | string | optional | Filter by Affinda workspace identifier. |
| state | string | optional | Filter by the Affinda document state. |
| tags | array | optional | Filter by Affinda tag IDs. |
| search | string | optional | Match document file names or tag names case-insensitively. |
| includeData | boolean | optional | Whether Affinda should include parsed data summaries in the list. |
| failed | boolean | optional | Filter by failed processing status. |
| ready | boolean | optional | Filter by ready processing status. |
| validatable | boolean | optional | Filter to documents that can be validated. |
| customIdentifier | string | optional | Filter documents by the custom identifier set at upload. |
| compact | boolean | optional | Whether Affinda should return compact parsed data. |
/v3/documents/{identifier}
| Param | Type | Required | Description |
|---|---|---|---|
| identifier | string | required | The Affinda document identifier. |
| compact | boolean | optional | Whether Affinda should return compact parsed data. |