NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Affinda

affinda

Affinda provides an AI-powered document processing platform that automates data extraction from various document types.

Artificial IntelligenceAI Document ExtractionWeb del proveedor
Acciones
39
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Tool 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[]Obligatorio

    List of annotation update objects.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create CollectionAFFINDA_CREATE_COLLECTIONAcción

Tool 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

  • namestringObligatorio

    The name of the collection to be created.

  • extractorstringObligatorio

    The type of extractor to be used for the collection (e.g., 'resume').

  • workspacestringObligatorio

    The identifier of the workspace where the collection will be created.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create DocumentAFFINDA_CREATE_DOCUMENTAcción

Tool 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

  • urlstring

    Public URL of the document. Alternative to `file` upload.

  • filestringbinary

    Binary content of the document to upload (e.g., PDF, DOCX).

  • fileNamestring

    Name of the file when uploading by URL. Ignored if `file` is provided.

  • workspacestring

    Workspace identifier. Defaults to primary workspace if omitted.

  • collectionstring

    Identifier for the collection to which the document belongs.

  • expiryTimestring

    Expiry time for document access, ISO 8601 format.

  • identifierstring

    Custom identifier for your own reference.

  • additionalExtractionsobject

    Additional extraction parameters as JSON object.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create OrganizationAFFINDA_CREATE_ORGANIZATIONAcción

Tool to create a new organization. use when you have a unique organization name and want to group resources under it.

Parámetros de entrada

  • namestringObligatorio

    Name of the organization to be created

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create RESTHook SubscriptionAFFINDA_CREATE_RESTHOOK_SUBSCRIPTIONAcción

Tool to create a new resthook subscription. use after confirming your webhook endpoint is ready to receive document event notifications.

Parámetros de entrada

  • eventstringObligatorioenum

    The event to subscribe to.

    document.parse.completeddocument.parse.succeededdocument.parse.faileddocument.validate.completeddocument.classify.completeddocument.classify.succeededdocument.classify.faileddocument.rejected
  • targetUrlstringObligatorio

    The URL where webhook notifications will be sent.

  • organizationstringObligatorio

    The organization identifier for which the subscription is created.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create TagAFFINDA_CREATE_TAGAcción

Tool to create a new tag. use when you need to label documents in a specific workspace.

Parámetros de entrada

  • namestringObligatorio

    The name of the tag to be created.

  • workspacestringObligatorio

    The identifier of the workspace where the tag will be created.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Validation ResultAFFINDA_CREATE_VALIDATION_RESULTAcción

Tool to create a validation result. use when recording validation outcomes for a document after parsing.

Parámetros de entrada

  • passedboolean

    Indicates whether the validation passed. Omit or set to null if not applicable.

  • messagestringObligatorio

    Message explaining why the validation passed or failed.

  • documentstringObligatorio

    Identifier of the document being validated.

  • ruleSlugstringObligatorio

    The slug of the validation rule being applied.

  • annotationsinteger[]Obligatorio

    List of annotation IDs that this validation result applies to.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create WorkspaceAFFINDA_CREATE_WORKSPACEAcción

Tool to create a new workspace. use when you need to programmatically create a workspace container within an organization.

Parámetros de entrada

  • namestringObligatorio

    Name of the workspace.

  • visibilitystringenum

    Visibility setting of the workspace. Possible values are 'ORGANIZATION' or 'PRIVATE'.

    ORGANIZATIONPRIVATE
  • organizationstringObligatorio

    Identifier of the organization to which the workspace will belong.

  • reject_invalid_documentsboolean

    Flag indicating whether to reject invalid documents.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete CollectionAFFINDA_DELETE_COLLECTIONAcción

Tool 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_idstringObligatorio

    The unique identifier of the collection to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete DocumentAFFINDA_DELETE_DOCUMENTAcción

Tool 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

  • identifierstringObligatorio

    The unique identifier of the document to delete. Must match an existing document ID.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete OrganizationAFFINDA_DELETE_ORGANIZATIONAcción

Tool to delete a specific organization by its id. use when you need to remove an organization after confirming its identifier.

Parámetros de entrada

  • identifierstringObligatorio

    The unique identifier of the organization to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Resthook SubscriptionAFFINDA_DELETE_RESTHOOK_SUBSCRIPTIONAcción

Tool 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

  • identifierintegerObligatorio

    The unique identifier of the resthook subscription to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete WorkspaceAFFINDA_DELETE_WORKSPACEAcción

Tool 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_idstringObligatorio

    The unique identifier of the workspace to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Workspace MembershipAFFINDA_DELETE_WORKSPACE_MEMBERSHIPAcción

Tool to remove a user from a workspace by membership id. use after confirming the workspace membership id to revoke access.

Parámetros de entrada

  • identifierstringObligatorio

    The unique identifier of the workspace membership to delete.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get TagsAFFINDA_GET_ALL_TAGSAcción

Tool to list all tags. use after confirming authentication to fetch tags across workspaces.

Parámetros de entrada

  • namestring

    Filter tags by name (partial match).

  • limitinteger

    Maximum number of tags to return per page.

  • offsetinteger

    Zero-based index of the first tag to return.

  • workspacestring

    Filter tags by a specific workspace identifier.

Parámetros de salida

  • dataobject[]Obligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All Validation ResultsAFFINDA_GET_ALL_VALIDATION_RESULTSAcción

Tool to list validation results for documents. use after processing documents to inspect validation outcomes.

Parámetros de entrada

  • limitinteger

    Maximum number of validation results to return.

  • offsetinteger

    Number of items to skip before starting to collect the result set (pagination offset).

  • documentstringObligatorio

    Identifier of the document to filter validation results by.

  • orderingstring

    Field by which to order results. Prefix with '-' for descending order.

  • workspacestring

    UUID of the workspace to filter validation results by.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Workspace MembershipsAFFINDA_GET_ALL_WORKSPACE_MEMBERSHIPSAcción

Tool 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

  • userstring

    Partial, case-insensitive match on user's email.

  • limitinteger

    Maximum number of items to return.

  • offsetinteger

    Number of items to skip before starting to collect the result set (pagination offset).

  • workspacestring

    Filter results by a specific workspace identifier.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get AnnotationsAFFINDA_GET_ANNOTATIONSAcción

Tool to retrieve a list of all annotations. use after parsing documents to list their annotations.

Parámetros de entrada

  • afterstring

    Return only annotations created after this timestamp (ISO 8601 format).

  • limitinteger

    Maximum number of annotations to return. Must be ≥1.

  • beforestring

    Return only annotations created before this timestamp (ISO 8601 format).

  • offsetinteger

    Number of annotations to skip before collecting the result set. Must be ≥0.

  • documentstring

    UUID of the document to filter annotations by.

  • workspacestring

    UUID of the workspace to filter annotations by.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get CollectionAFFINDA_GET_COLLECTIONAcción

Tool 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_idstringObligatorio

    The unique identifier of the collection to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get CollectionsAFFINDA_GET_COLLECTIONSAcción

Tool to retrieve a list of all collections. use when you need to list collections in your affinda workspace after authentication.

Parámetros de entrada

  • limitinteger

    Maximum number of items to return. Default is 10 if not provided.

  • offsetinteger

    Number of items to skip before starting the result set (pagination offset).

  • workspacestringObligatorio

    Identifier of the workspace to filter collections by.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get DocumentAFFINDA_GET_DOCUMENTAcción

Tool 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

  • identifierstringObligatorio

    The unique identifier of the document to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get DocumentsAFFINDA_GET_DOCUMENTSAcción

Tool to retrieve a list of all documents. use when you need to list documents in your affinda workspace after authentication.

Parámetros de entrada

  • limitinteger

    Maximum number of items to return.

  • offsetinteger

    Number of items to skip before starting to collect the result set (pagination offset).

  • workspacestring

    UUID of the workspace to filter documents by.

  • collectionstring

    UUID of the collection to filter documents by.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Document TypeAFFINDA_GET_DOCUMENT_TYPEAcción

Tool 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

  • identifierstringObligatorio

    The unique identifier of the document type.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Document TypesAFFINDA_GET_DOCUMENT_TYPESAcción

Tool 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

  • limitinteger

    Maximum number of document types to return.

  • offsetinteger

    Index of the first document type to return.

  • orderingstring

    Field by which to order the document types (e.g., 'name' or '-name').

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get ExtractorsAFFINDA_GET_EXTRACTORSAcción

Tool to retrieve a list of all extractors. use when you need to paginate through available extractors.

Parámetros de entrada

  • limitinteger

    Maximum number of extractors to return per page.

  • offsetinteger

    Zero-based index of the first extractor to return.

  • organizationstringObligatorio

    Identifier of the organization to filter extractors.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get OrganizationAFFINDA_GET_ORGANIZATIONAcción

Tool 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

  • identifierstringObligatorio

    The unique identifier of the organization to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get OrganizationsAFFINDA_GET_ORGANIZATIONSAcción

Tool to retrieve a list of all organizations. use after authenticating to list all organizations available to the api key.

Parámetros de entrada

  • limitinteger

    Maximum number of organizations to return. Default is server-defined if not provided.

  • offsetinteger

    Number of organizations to skip before starting to collect the result set (pagination offset).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Resthook SubscriptionAFFINDA_GET_RESTHOOK_SUBSCRIPTIONAcción

Tool to retrieve details of a specific resthook subscription by its id. use after confirming its creation to verify its settings.

Parámetros de entrada

  • identifierintegerObligatorio

    The unique identifier of the resthook subscription to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get RESTHook SubscriptionsAFFINDA_GET_RESTHOOK_SUBSCRIPTIONSAcción

Tool 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Usage by WorkspaceAFFINDA_GET_USAGE_BY_WORKSPACEAcción

Tool to retrieve monthly credits consumption for a workspace. use when tracking usage over a specific period before reporting.

Parámetros de entrada

  • endstring

    End month for usage data in YYYY-MM format.

  • startstring

    Start month for usage data in YYYY-MM format.

  • workspace_idstringObligatorio

    Unique identifier of the workspace to retrieve usage for.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get WorkspaceAFFINDA_GET_WORKSPACEAcción

Tool 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

  • identifierstringObligatorio

    The unique identifier of the workspace to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Workspace MembershipAFFINDA_GET_WORKSPACE_MEMBERSHIPAcción

Tool 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

  • identifierstringObligatorio

    The unique identifier of the workspace membership to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get WorkspacesAFFINDA_GET_WORKSPACESAcción

Tool to retrieve a list of all workspaces. use when you need to list workspaces filtered by organization and optional name.

Parámetros de entrada

  • namestring

    Filter by workspace name (partial match).

  • organizationstringObligatorio

    Filter by organization identifier.

Parámetros de salida

  • dataobject[]Obligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update CollectionAFFINDA_UPDATE_COLLECTIONAcción

Tool to update specific fields of a collection. use when you need to rename or reassign a collection after creation.

Parámetros de entrada

  • namestring

    New name for the collection.

  • documentsstring[]

    List of document identifiers to set for this collection.

  • workspacestring

    Identifier of the workspace to assign the collection to.

  • identifierstringObligatorio

    Identifier of the collection to update.

  • custom_fieldsobject[]

    Custom fields defined for this collection.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update DocumentAFFINDA_UPDATE_DOCUMENTAcción

Tool 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

  • fileNamestring

    New file name for the document.

  • languagestring

    ISO 639-1 language code (e.g., 'en', 'fr', 'zh-cn').

  • workspacestring

    Identifier of the workspace to move the document to.

  • collectionstring

    Identifier of the collection to move the document to.

  • expiryTimestring

    Expiry time in ISO 8601 format when the document will be automatically deleted.

  • identifierstringObligatorio

    The unique identifier of the document to update.

  • regionBiasobject

    Geographic bias parameters to influence geocoding or location-based parsing.

  • customIdentifierstring

    Custom identifier for your own reference.

  • deleteAfterParseboolean

    If true, no data will be stored after parsing. Only valid with synchronous parsing.

  • enableValidationToolboolean

    If false, validation UI is disabled to speed up parsing.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Document DataAFFINDA_UPDATE_DOCUMENT_DATAAcción

Tool 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

  • dataobjectObligatorio

    Structured data to update for the document. Only include fields you wish to change.

  • identifierstringObligatorio

    The unique identifier of the document to update.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update OrganizationAFFINDA_UPDATE_ORGANIZATIONAcción

Tool 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

  • namestring

    New name for the organization.

  • avatarstringbinary

    Binary content of the new avatar image (e.g., PNG or JPEG).

  • identifierstringObligatorio

    Unique identifier of the organization to update.

  • resthook_signature_keystring

    New key for signing resthook notifications.

  • validation_tool_configobject

    New configuration settings for the organization's validation tool.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update RESTHook SubscriptionAFFINDA_UPDATE_RESTHOOK_SUBSCRIPTIONAcción

Tool to update an existing resthook subscription. use after confirming the subscription identifier to modify its url, event, or activation status.

Parámetros de entrada

  • eventstring

    The event type to subscribe to

  • activeboolean

    Whether the subscription should be active

  • targetUrlstring

    The new URL where webhook notifications will be sent

  • identifierintegerObligatorio

    The unique identifier of the resthook subscription to update

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update WorkspaceAFFINDA_UPDATE_WORKSPACEAcción

Tool 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

  • namestring

    The new name for the workspace.

  • visibilitystringenum

    The visibility setting for the workspace. Possible values are 'ORGANIZATION' or 'PRIVATE'.

    ORGANIZATIONPRIVATE
  • workspace_idstringObligatorio

    The unique identifier of the workspace to update.

  • reject_invalid_documentsboolean

    Flag indicating whether to reject invalid documents.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not