Affinda
affindaAffinda provides an AI-powered document processing platform that automates data extraction from various document types.
Acciones disponibles (39)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Batch Update AnnotationsAFFINDA_BATCH_UPDATE_ANNOTATIONSAcciónTool to update multiple annotations in one request. use when you need to modify parsed values or other fields across many annotations at once.
AFFINDA_BATCH_UPDATE_ANNOTATIONSAcciónTool to update multiple annotations in one request. use when you need to modify parsed values or other fields across many annotations at once.
Parámetros de entrada
annotationsobject[]ObligatorioList of annotation update objects.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create CollectionAFFINDA_CREATE_COLLECTIONAcciónTool to create a new collection. use after you have a valid workspace id and want to group documents by a specific extractor within that workspace.
AFFINDA_CREATE_COLLECTIONAcciónTool to create a new collection. use after you have a valid workspace id and want to group documents by a specific extractor within that workspace.
Parámetros de entrada
namestringObligatorioThe name of the collection to be created.
extractorstringObligatorioThe type of extractor to be used for the collection (e.g., 'resume').
workspacestringObligatorioThe identifier of the workspace where the collection will be created.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create DocumentAFFINDA_CREATE_DOCUMENTAcciónTool to upload a new document for parsing. use when you have the document file or a public url and need to extract structured data immediately.
AFFINDA_CREATE_DOCUMENTAcciónTool to upload a new document for parsing. use when you have the document file or a public url and need to extract structured data immediately.
Parámetros de entrada
urlstringPublic URL of the document. Alternative to `file` upload.
filestringbinaryBinary content of the document to upload (e.g., PDF, DOCX).
fileNamestringName of the file when uploading by URL. Ignored if `file` is provided.
workspacestringWorkspace identifier. Defaults to primary workspace if omitted.
collectionstringIdentifier for the collection to which the document belongs.
expiryTimestringExpiry time for document access, ISO 8601 format.
identifierstringCustom identifier for your own reference.
additionalExtractionsobjectAdditional extraction parameters as JSON object.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create OrganizationAFFINDA_CREATE_ORGANIZATIONAcciónTool to create a new organization. use when you have a unique organization name and want to group resources under it.
AFFINDA_CREATE_ORGANIZATIONAcciónTool to create a new organization. use when you have a unique organization name and want to group resources under it.
Parámetros de entrada
namestringObligatorioName of the organization to be created
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create RESTHook SubscriptionAFFINDA_CREATE_RESTHOOK_SUBSCRIPTIONAcciónTool to create a new resthook subscription. use after confirming your webhook endpoint is ready to receive document event notifications.
AFFINDA_CREATE_RESTHOOK_SUBSCRIPTIONAcciónTool to create a new resthook subscription. use after confirming your webhook endpoint is ready to receive document event notifications.
Parámetros de entrada
eventstringObligatorioenumThe event to subscribe to.
document.parse.completeddocument.parse.succeededdocument.parse.faileddocument.validate.completeddocument.classify.completeddocument.classify.succeededdocument.classify.faileddocument.rejectedtargetUrlstringObligatorioThe URL where webhook notifications will be sent.
organizationstringObligatorioThe organization identifier for which the subscription is created.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create TagAFFINDA_CREATE_TAGAcciónTool to create a new tag. use when you need to label documents in a specific workspace.
AFFINDA_CREATE_TAGAcciónTool to create a new tag. use when you need to label documents in a specific workspace.
Parámetros de entrada
namestringObligatorioThe name of the tag to be created.
workspacestringObligatorioThe identifier of the workspace where the tag will be created.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Validation ResultAFFINDA_CREATE_VALIDATION_RESULTAcciónTool to create a validation result. use when recording validation outcomes for a document after parsing.
AFFINDA_CREATE_VALIDATION_RESULTAcciónTool to create a validation result. use when recording validation outcomes for a document after parsing.
Parámetros de entrada
passedbooleanIndicates whether the validation passed. Omit or set to null if not applicable.
messagestringObligatorioMessage explaining why the validation passed or failed.
documentstringObligatorioIdentifier of the document being validated.
ruleSlugstringObligatorioThe slug of the validation rule being applied.
annotationsinteger[]ObligatorioList of annotation IDs that this validation result applies to.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create WorkspaceAFFINDA_CREATE_WORKSPACEAcciónTool to create a new workspace. use when you need to programmatically create a workspace container within an organization.
AFFINDA_CREATE_WORKSPACEAcciónTool to create a new workspace. use when you need to programmatically create a workspace container within an organization.
Parámetros de entrada
namestringObligatorioName of the workspace.
visibilitystringenumVisibility setting of the workspace. Possible values are 'ORGANIZATION' or 'PRIVATE'.
ORGANIZATIONPRIVATEorganizationstringObligatorioIdentifier of the organization to which the workspace will belong.
reject_invalid_documentsbooleanFlag indicating whether to reject invalid documents.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete CollectionAFFINDA_DELETE_COLLECTIONAcciónTool to delete a specific collection by its id. use when you need to remove an unused collection. use after verifying the collection id.
AFFINDA_DELETE_COLLECTIONAcciónTool to delete a specific collection by its id. use when you need to remove an unused collection. use after verifying the collection id.
Parámetros de entrada
collection_idstringObligatorioThe unique identifier of the collection to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete DocumentAFFINDA_DELETE_DOCUMENTAcciónTool to delete a specific document by its id. use when you need to remove a document that is incorrect or no longer needed, after confirming the document id.
AFFINDA_DELETE_DOCUMENTAcciónTool to delete a specific document by its id. use when you need to remove a document that is incorrect or no longer needed, after confirming the document id.
Parámetros de entrada
identifierstringObligatorioThe unique identifier of the document to delete. Must match an existing document ID.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete OrganizationAFFINDA_DELETE_ORGANIZATIONAcciónTool to delete a specific organization by its id. use when you need to remove an organization after confirming its identifier.
AFFINDA_DELETE_ORGANIZATIONAcciónTool to delete a specific organization by its id. use when you need to remove an organization after confirming its identifier.
Parámetros de entrada
identifierstringObligatorioThe unique identifier of the organization to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Resthook SubscriptionAFFINDA_DELETE_RESTHOOK_SUBSCRIPTIONAcciónTool to delete a specific resthook subscription by id. use after confirming the subscription identifier when the webhook is no longer needed.
AFFINDA_DELETE_RESTHOOK_SUBSCRIPTIONAcciónTool to delete a specific resthook subscription by id. use after confirming the subscription identifier when the webhook is no longer needed.
Parámetros de entrada
identifierintegerObligatorioThe unique identifier of the resthook subscription to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete WorkspaceAFFINDA_DELETE_WORKSPACEAcciónTool to delete a specific workspace by its id. use when you need to remove an unused workspace after confirming the workspace id.
AFFINDA_DELETE_WORKSPACEAcciónTool to delete a specific workspace by its id. use when you need to remove an unused workspace after confirming the workspace id.
Parámetros de entrada
workspace_idstringObligatorioThe unique identifier of the workspace to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Workspace MembershipAFFINDA_DELETE_WORKSPACE_MEMBERSHIPAcciónTool to remove a user from a workspace by membership id. use after confirming the workspace membership id to revoke access.
AFFINDA_DELETE_WORKSPACE_MEMBERSHIPAcciónTool to remove a user from a workspace by membership id. use after confirming the workspace membership id to revoke access.
Parámetros de entrada
identifierstringObligatorioThe unique identifier of the workspace membership to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get TagsAFFINDA_GET_ALL_TAGSAcciónTool to list all tags. use after confirming authentication to fetch tags across workspaces.
AFFINDA_GET_ALL_TAGSAcciónTool to list all tags. use after confirming authentication to fetch tags across workspaces.
Parámetros de entrada
namestringFilter tags by name (partial match).
limitintegerMaximum number of tags to return per page.
offsetintegerZero-based index of the first tag to return.
workspacestringFilter tags by a specific workspace identifier.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All Validation ResultsAFFINDA_GET_ALL_VALIDATION_RESULTSAcciónTool to list validation results for documents. use after processing documents to inspect validation outcomes.
AFFINDA_GET_ALL_VALIDATION_RESULTSAcciónTool to list validation results for documents. use after processing documents to inspect validation outcomes.
Parámetros de entrada
limitintegerMaximum number of validation results to return.
offsetintegerNumber of items to skip before starting to collect the result set (pagination offset).
documentstringObligatorioIdentifier of the document to filter validation results by.
orderingstringField by which to order results. Prefix with '-' for descending order.
workspacestringUUID of the workspace to filter validation results by.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Workspace MembershipsAFFINDA_GET_ALL_WORKSPACE_MEMBERSHIPSAcciónTool to list all workspace memberships for the authenticated user. use when you need to see roles and access across all workspaces.
AFFINDA_GET_ALL_WORKSPACE_MEMBERSHIPSAcciónTool to list all workspace memberships for the authenticated user. use when you need to see roles and access across all workspaces.
Parámetros de entrada
userstringPartial, case-insensitive match on user's email.
limitintegerMaximum number of items to return.
offsetintegerNumber of items to skip before starting to collect the result set (pagination offset).
workspacestringFilter results by a specific workspace identifier.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get AnnotationsAFFINDA_GET_ANNOTATIONSAcciónTool to retrieve a list of all annotations. use after parsing documents to list their annotations.
AFFINDA_GET_ANNOTATIONSAcciónTool to retrieve a list of all annotations. use after parsing documents to list their annotations.
Parámetros de entrada
afterstringReturn only annotations created after this timestamp (ISO 8601 format).
limitintegerMaximum number of annotations to return. Must be ≥1.
beforestringReturn only annotations created before this timestamp (ISO 8601 format).
offsetintegerNumber of annotations to skip before collecting the result set. Must be ≥0.
documentstringUUID of the document to filter annotations by.
workspacestringUUID of the workspace to filter annotations by.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get CollectionAFFINDA_GET_COLLECTIONAcciónTool to retrieve details of a specific collection by its id. use when you need full metadata about a collection after confirming its identifier.
AFFINDA_GET_COLLECTIONAcciónTool to retrieve details of a specific collection by its id. use when you need full metadata about a collection after confirming its identifier.
Parámetros de entrada
collection_idstringObligatorioThe unique identifier of the collection to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get CollectionsAFFINDA_GET_COLLECTIONSAcciónTool to retrieve a list of all collections. use when you need to list collections in your affinda workspace after authentication.
AFFINDA_GET_COLLECTIONSAcciónTool to retrieve a list of all collections. use when you need to list collections in your affinda workspace after authentication.
Parámetros de entrada
limitintegerMaximum number of items to return. Default is 10 if not provided.
offsetintegerNumber of items to skip before starting the result set (pagination offset).
workspacestringObligatorioIdentifier of the workspace to filter collections by.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get DocumentAFFINDA_GET_DOCUMENTAcciónTool to retrieve details of a specific document by its id. use when you need full metadata and parsing results for a document after upload.
AFFINDA_GET_DOCUMENTAcciónTool to retrieve details of a specific document by its id. use when you need full metadata and parsing results for a document after upload.
Parámetros de entrada
identifierstringObligatorioThe unique identifier of the document to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get DocumentsAFFINDA_GET_DOCUMENTSAcciónTool to retrieve a list of all documents. use when you need to list documents in your affinda workspace after authentication.
AFFINDA_GET_DOCUMENTSAcciónTool to retrieve a list of all documents. use when you need to list documents in your affinda workspace after authentication.
Parámetros de entrada
limitintegerMaximum number of items to return.
offsetintegerNumber of items to skip before starting to collect the result set (pagination offset).
workspacestringUUID of the workspace to filter documents by.
collectionstringUUID of the collection to filter documents by.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Document TypeAFFINDA_GET_DOCUMENT_TYPEAcciónTool to retrieve details of a specific document type by its id. use when you need to confirm the configuration or metadata of a document type before processing documents.
AFFINDA_GET_DOCUMENT_TYPEAcciónTool to retrieve details of a specific document type by its id. use when you need to confirm the configuration or metadata of a document type before processing documents.
Parámetros de entrada
identifierstringObligatorioThe unique identifier of the document type.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Document TypesAFFINDA_GET_DOCUMENT_TYPESAcciónTool to retrieve a list of all document types. use when you need to display or filter documents by type before processing.
AFFINDA_GET_DOCUMENT_TYPESAcciónTool to retrieve a list of all document types. use when you need to display or filter documents by type before processing.
Parámetros de entrada
limitintegerMaximum number of document types to return.
offsetintegerIndex of the first document type to return.
orderingstringField by which to order the document types (e.g., 'name' or '-name').
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get ExtractorsAFFINDA_GET_EXTRACTORSAcciónTool to retrieve a list of all extractors. use when you need to paginate through available extractors.
AFFINDA_GET_EXTRACTORSAcciónTool to retrieve a list of all extractors. use when you need to paginate through available extractors.
Parámetros de entrada
limitintegerMaximum number of extractors to return per page.
offsetintegerZero-based index of the first extractor to return.
organizationstringObligatorioIdentifier of the organization to filter extractors.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get OrganizationAFFINDA_GET_ORGANIZATIONAcciónTool to retrieve details of a specific organization by its id. use when you need to fetch an organization's metadata after confirming its identifier.
AFFINDA_GET_ORGANIZATIONAcciónTool to retrieve details of a specific organization by its id. use when you need to fetch an organization's metadata after confirming its identifier.
Parámetros de entrada
identifierstringObligatorioThe unique identifier of the organization to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get OrganizationsAFFINDA_GET_ORGANIZATIONSAcciónTool to retrieve a list of all organizations. use after authenticating to list all organizations available to the api key.
AFFINDA_GET_ORGANIZATIONSAcciónTool to retrieve a list of all organizations. use after authenticating to list all organizations available to the api key.
Parámetros de entrada
limitintegerMaximum number of organizations to return. Default is server-defined if not provided.
offsetintegerNumber of organizations to skip before starting to collect the result set (pagination offset).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Resthook SubscriptionAFFINDA_GET_RESTHOOK_SUBSCRIPTIONAcciónTool to retrieve details of a specific resthook subscription by its id. use after confirming its creation to verify its settings.
AFFINDA_GET_RESTHOOK_SUBSCRIPTIONAcciónTool to retrieve details of a specific resthook subscription by its id. use after confirming its creation to verify its settings.
Parámetros de entrada
identifierintegerObligatorioThe unique identifier of the resthook subscription to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get RESTHook SubscriptionsAFFINDA_GET_RESTHOOK_SUBSCRIPTIONSAcciónTool to retrieve a list of all resthook subscriptions. use after authenticating to list all webhook subscriptions associated with your account.
AFFINDA_GET_RESTHOOK_SUBSCRIPTIONSAcciónTool to retrieve a list of all resthook subscriptions. use after authenticating to list all webhook subscriptions associated with your account.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Usage by WorkspaceAFFINDA_GET_USAGE_BY_WORKSPACEAcciónTool to retrieve monthly credits consumption for a workspace. use when tracking usage over a specific period before reporting.
AFFINDA_GET_USAGE_BY_WORKSPACEAcciónTool to retrieve monthly credits consumption for a workspace. use when tracking usage over a specific period before reporting.
Parámetros de entrada
endstringEnd month for usage data in YYYY-MM format.
startstringStart month for usage data in YYYY-MM format.
workspace_idstringObligatorioUnique identifier of the workspace to retrieve usage for.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get WorkspaceAFFINDA_GET_WORKSPACEAcciónTool to retrieve details of a specific workspace by its id. use when you need full workspace metadata after confirming its identifier.
AFFINDA_GET_WORKSPACEAcciónTool to retrieve details of a specific workspace by its id. use when you need full workspace metadata after confirming its identifier.
Parámetros de entrada
identifierstringObligatorioThe unique identifier of the workspace to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Workspace MembershipAFFINDA_GET_WORKSPACE_MEMBERSHIPAcciónTool to retrieve details of a specific workspace membership by its id. use when you need to confirm a user's role and details within a workspace after obtaining the membership identifier.
AFFINDA_GET_WORKSPACE_MEMBERSHIPAcciónTool to retrieve details of a specific workspace membership by its id. use when you need to confirm a user's role and details within a workspace after obtaining the membership identifier.
Parámetros de entrada
identifierstringObligatorioThe unique identifier of the workspace membership to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get WorkspacesAFFINDA_GET_WORKSPACESAcciónTool to retrieve a list of all workspaces. use when you need to list workspaces filtered by organization and optional name.
AFFINDA_GET_WORKSPACESAcciónTool to retrieve a list of all workspaces. use when you need to list workspaces filtered by organization and optional name.
Parámetros de entrada
namestringFilter by workspace name (partial match).
organizationstringObligatorioFilter by organization identifier.
Parámetros de salida
dataobject[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update CollectionAFFINDA_UPDATE_COLLECTIONAcciónTool to update specific fields of a collection. use when you need to rename or reassign a collection after creation.
AFFINDA_UPDATE_COLLECTIONAcciónTool to update specific fields of a collection. use when you need to rename or reassign a collection after creation.
Parámetros de entrada
namestringNew name for the collection.
documentsstring[]List of document identifiers to set for this collection.
workspacestringIdentifier of the workspace to assign the collection to.
identifierstringObligatorioIdentifier of the collection to update.
custom_fieldsobject[]Custom fields defined for this collection.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update DocumentAFFINDA_UPDATE_DOCUMENTAcciónTool to update specific fields of a document. use when you need to rename, reassign, or adjust expiry and storage settings after document creation.
AFFINDA_UPDATE_DOCUMENTAcciónTool to update specific fields of a document. use when you need to rename, reassign, or adjust expiry and storage settings after document creation.
Parámetros de entrada
fileNamestringNew file name for the document.
languagestringISO 639-1 language code (e.g., 'en', 'fr', 'zh-cn').
workspacestringIdentifier of the workspace to move the document to.
collectionstringIdentifier of the collection to move the document to.
expiryTimestringExpiry time in ISO 8601 format when the document will be automatically deleted.
identifierstringObligatorioThe unique identifier of the document to update.
regionBiasobjectGeographic bias parameters to influence geocoding or location-based parsing.
customIdentifierstringCustom identifier for your own reference.
deleteAfterParsebooleanIf true, no data will be stored after parsing. Only valid with synchronous parsing.
enableValidationToolbooleanIf false, validation UI is disabled to speed up parsing.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Document DataAFFINDA_UPDATE_DOCUMENT_DATAAcciónTool to update parsed data for a resume or job description document. use after retrieving the document when you want to correct or add parsed fields.
AFFINDA_UPDATE_DOCUMENT_DATAAcciónTool to update parsed data for a resume or job description document. use after retrieving the document when you want to correct or add parsed fields.
Parámetros de entrada
dataobjectObligatorioStructured data to update for the document. Only include fields you wish to change.
identifierstringObligatorioThe unique identifier of the document to update.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update OrganizationAFFINDA_UPDATE_ORGANIZATIONAcciónTool to update specific fields of an organization. use when you need to modify an organization's name, avatar, or webhook and validation settings after creation.
AFFINDA_UPDATE_ORGANIZATIONAcciónTool to update specific fields of an organization. use when you need to modify an organization's name, avatar, or webhook and validation settings after creation.
Parámetros de entrada
namestringNew name for the organization.
avatarstringbinaryBinary content of the new avatar image (e.g., PNG or JPEG).
identifierstringObligatorioUnique identifier of the organization to update.
resthook_signature_keystringNew key for signing resthook notifications.
validation_tool_configobjectNew configuration settings for the organization's validation tool.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update RESTHook SubscriptionAFFINDA_UPDATE_RESTHOOK_SUBSCRIPTIONAcciónTool to update an existing resthook subscription. use after confirming the subscription identifier to modify its url, event, or activation status.
AFFINDA_UPDATE_RESTHOOK_SUBSCRIPTIONAcciónTool to update an existing resthook subscription. use after confirming the subscription identifier to modify its url, event, or activation status.
Parámetros de entrada
eventstringThe event type to subscribe to
activebooleanWhether the subscription should be active
targetUrlstringThe new URL where webhook notifications will be sent
identifierintegerObligatorioThe unique identifier of the resthook subscription to update
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update WorkspaceAFFINDA_UPDATE_WORKSPACEAcciónTool to update specific fields of a workspace. use when you need to modify a workspace’s name, visibility, or document rejection policy after creation.
AFFINDA_UPDATE_WORKSPACEAcciónTool to update specific fields of a workspace. use when you need to modify a workspace’s name, visibility, or document rejection policy after creation.
Parámetros de entrada
namestringThe new name for the workspace.
visibilitystringenumThe visibility setting for the workspace. Possible values are 'ORGANIZATION' or 'PRIVATE'.
ORGANIZATIONPRIVATEworkspace_idstringObligatorioThe unique identifier of the workspace to update.
reject_invalid_documentsbooleanFlag indicating whether to reject invalid documents.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not