Affinda for AI agents
Agents read Affinda at once. Changes and sends are held for a person's approval by default.
About Affinda
Affinda provides an AI-powered document processing platform that automates data extraction from various document types.
What an agent can do in Affinda
Every Affinda action is classed by the platform as a read, a change or a send. Reads run at once. Changes and sends are held for a person by default.
Runs at once (reads)
Looks things up in Affinda without asking first. 44 actions.
- Get All API UsersTool to retrieve a list of all API users. Use when you need to list API users, optionally filtered by organization.
- Get All InvitationsTool to retrieve all invitations you created or sent to you. Use when you need to list organization invitations with optional filtering by status, role, or organization.
- Get Organization MembershipsRetrieve all organization memberships across the account. Returns paginated results showing which users belong to which organizations. Use to audit organization access or find specific user membership
- Get Workspace MembershipsRetrieve all workspace memberships across the account. Returns paginated results showing which users belong to which workspaces. Use to audit workspace access or find specific user memberships.
- Get CollectionTool to retrieve details of a specific collection by its ID. Use when you need full metadata about a collection after confirming its identifier.
- Get CollectionsTool to retrieve a list of all collections. Use when you need to list collections in your Affinda workspace after authentication.
- Get DocumentRetrieve full details and parsed data for a specific document by its identifier. Use this tool to get comprehensive information about a document including: - Processing status (ready/failed) - Documen
- Get DocumentsTool to retrieve a list of all documents. Use when you need to list documents in your Affinda workspace after authentication.
- Get OrganizationTool to retrieve details of a specific organization by its ID. Use when you need to fetch an organization's metadata after confirming its identifier.
- Get OrganizationsRetrieves all organizations accessible to the authenticated user. Returns a list of organizations with details including identifier, name, user role, trial status, and configuration settings. Use the
- Get WorkspaceTool to retrieve details of a specific workspace by its ID. Use when you need full workspace metadata after confirming its identifier.
- Get Workspace MembershipTool 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.
Show all 44
- Get WorkspacesTool to retrieve a list of all workspaces. Use when you need to list workspaces filtered by organization and optional name.
- Get All Document SplittersTool to get a list of all document splitters. Use when you need to retrieve document splitters, optionally filtered by organization.
- Get TagsTool to list all tags. Use after confirming authentication to fetch tags across workspaces.
- Get All Validation ResultsTool to list validation results for documents. Use after processing documents to inspect validation outcomes.
- Get AnnotationsRetrieves all annotations for a specific document. Annotations are extracted data fields (text, dates, numbers, tables, etc.) from parsed documents. Use this after a document has been processed to acc
- Get Data SourceTool to retrieve details of a specific mapping data source by its identifier. Use when you need to fetch mapping data source metadata and schema configuration.
- Get Data Source ValueTool to retrieve a specific value from a mapping data source. Use when you need to get details about a particular value in a data source.
- Get Data Source ValuesTool to retrieve all values from a mapping data source. Use when you need to list or search values in a specific data source after authentication.
- Get Document SplitterTool to retrieve details of a specific document splitter by its identifier. Use when you need to fetch metadata about a document splitter configuration.
- Get Document TypeTool 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.
- Get Document Type JSON SchemaTool to generate a JSON schema from a document type by its identifier. Use when you need the structured schema definition for a document type to understand its field structure and validation rules.
- Get Document Type Pydantic ModelsTool to generate Pydantic model code from a document type's schema. Use when you need type-safe Python models for parsing documents of a specific type.
- Get Document TypesRetrieve all document types accessible to the authenticated user. Returns a list containing each document type's identifier, name, description, ingest email, and organization. Use this to discover ava
- Get ExtractorTool to retrieve detailed information about a specific extractor by its identifier. Use when you need complete metadata about an extractor's configuration, fields, and capabilities.
- Get ExtractorsRetrieve all extractors available for an organization. Extractors are document parsing configurations that define what data to extract from documents. This includes both Affinda's built-in extractors
- Get Index DocumentsTool to retrieve all indexed documents for a specific index. Use when you need to list documents in a search index after creating or accessing an index.
- Get InvitationTool to retrieve details of a specific organization invitation by its identifier. Use when you need to check invitation status or get invitation metadata.
- Get Job Description Search ConfigTool to get the configuration for the logged in user's embeddable job description search tool. Returns display settings, field weights, and maximum results limits.
- Get MappingTool to retrieve a specific mapping by its identifier. Use when you need to fetch mapping configuration details for a lookup against a MappingDataSource.
- Get Organization MembershipTool to retrieve details of a specific organization membership by its ID. Use when you need to confirm a user's role and details within an organization.
- Get Resthook SubscriptionTool to retrieve details of a specific resthook subscription by its ID. Use after confirming its creation to verify its settings.
- Get RESTHook SubscriptionsTool to retrieve a list of all RESTHook subscriptions. Use after authenticating to list all webhook subscriptions associated with your account.
- Get TagTool to retrieve details of a specific tag by its ID. Use when you need to fetch information about a particular tag.
- Get Usage by WorkspaceRetrieves monthly document processing usage statistics for a specific workspace. Returns a list of usage records showing how many documents were processed each month. Use this to track workspace activ
- List Data PointsTool to retrieve all data points. Returns both custom data points and Affinda's off-the-shelf data points. Use when you need to list available data points for extractors.
- List Data SourcesTool to retrieve the list of all custom mapping data sources. Use when you need to list or search for mapping data sources in your Affinda workspace.
- List IndexesTool to retrieve a list of all search indexes. Use when you need to view available indexes for searching and matching documents in Affinda.
- List MappingsTool to retrieve the list of all custom data mappings. Use when you need to list mappings for a specific data source.
- List Occupation GroupsTool to retrieve the list of searchable occupation groups. Use when you need to get available occupation categories for job matching or classification.
- List Resume Search ConfigTool to get the configuration for the logged in user's embeddable resume search tool. Use this to retrieve display field settings, search weights, maximum results, and theme customization options for
- List Resume Search Job Title SuggestionsTool to get job title suggestions based on provided job title(s). Use when you need to find related job titles for resume search.
- List Resume Search Skill SuggestionsTool to get skill suggestions based on provided skills. Use when you need to find related skills to expand or refine resume search queries.
Held for approval by default (changes and sends)
Held for a person's approval by default. The approval is recorded and the action is sent once, never twice, with 10 seconds to undo. 60 actions.
- Create API UserTool to create a new API user within an organization. Use when you need to generate a new API user with authentication credentials for programmatic access to Affinda services.
- Create CollectionTool 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.
- Create Data SourceTool to create a custom mapping data source. Use when you need to set up a new data source for mapping AI-extracted values to your database records.
- Create DocumentUpload a document to Affinda for parsing and data extraction. Use this action when you need to: - Parse resumes/CVs to extract candidate information - Process invoices to extract line items, amounts,
- Create ExtractorTool to create a new extractor. Use when you need to define a custom document parser with specific fields and extraction rules, typically derived from a base extractor.
- Create IndexTool to create a new index for search and match functionality. Use when you need to set up a new index for organizing and searching documents like resumes or job descriptions.
- Create InvitationTool to create a new organization invitation. Use when you need to invite a user to join an organization with a specific role.
- Create Job Description SearchSearch through parsed job descriptions using custom criteria or resume matching. Use this action when you need to find job postings that match specific requirements such as skills, experience, locatio
- Create OrganizationTool to create a new organization. Use when you have a unique organization name and want to group resources under it.
- Create Resume SearchTool to search through parsed resumes using three methods: match to a job description, match to a resume, or custom criteria. Use when you need to find candidates matching specific requirements.
- Create WorkspaceTool to create a new workspace. Use when you need to programmatically create a workspace container within an organization.
- Create Workspace MembershipTool to add a user to a workspace by creating a membership. Use when you need to grant a user access to a specific workspace.
Show all 60
- Delete CollectionPermanently delete a collection from Affinda by its identifier. This is a destructive operation that cannot be undone. Use Get Collections first to verify the collection ID before deletion. Note: Docu
- Delete Data SourcePermanently delete a mapping data source from the database by its identifier. This is a destructive operation that cannot be undone. Use when you need to remove a data source that is no longer needed
- Delete DocumentTool 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.
- Delete IndexTool to permanently delete an index from Affinda by its name. Use when you need to remove an index that is no longer needed. This is a destructive operation that cannot be undone.
- Delete InvitationTool to delete an invitation by its identifier. Use when you need to remove or revoke an invitation after confirming the invitation identifier.
- Delete OrganizationPermanently deletes an organization from Affinda. This action is destructive and cannot be undone. All workspaces, collections, and documents associated with the organization will also be deleted. Use
- Delete TagPermanently delete a tag from Affinda by its ID. This is a destructive operation that cannot be undone. Use Get Tags first to verify the tag ID before deletion.
- Delete WorkspaceTool to delete a specific workspace by its ID. Use when you need to remove an unused workspace after confirming the workspace ID.
- Delete Workspace MembershipTool to remove a user from a workspace by membership ID. Use after confirming the workspace membership ID to revoke access.
- Update CollectionTool to update specific fields of a collection. Use when you need to rename or reassign a collection after creation.
- Update DocumentTool to update specific fields of a document. Use when you need to rename, reassign, or adjust expiry and storage settings after document creation.
- Update WorkspaceTool to update specific fields of a workspace. Use when you need to modify a workspace's name, visibility, document rejection policy, or other settings. Only provide the fields you want to change; oth
- Add Tag to DocumentsTool to add a tag to multiple documents in a single operation. Use when you need to organize or categorize multiple documents by assigning them a shared tag. Tags enable efficient filtering and groupi
- Batch Update AnnotationsBatch update multiple document annotations in a single API call. Use this action to efficiently update parsed values or other fields across many annotations at once, rather than making individual upda
- Batch Create AnnotationsBatch create multiple document annotations in a single API call. Use this action to efficiently create multiple annotations at once for documents that have been processed by Affinda. This is useful fo
- Create Data Field For CollectionTool to create a data field for a collection along with a new data point. Use when you need to add a custom field to a collection for document processing and validation.
- Create Data Source ValueTool to add a new value to a mapping data source. Use when you need to add entries to a data source for mapping or validation purposes. The created value can then be referenced in document extraction
- Create Document TypeTool to create a new document type in the specified organization. Use when you need to define a new category of documents for processing. Document types allow you to organize and categorize documents
- Create Document from DataCreate a document from structured resume or job description data for Search & Match. Use this when you have structured data to create a document programmatically without file uploads. Returns an ident
- Create Job Description Search Embed URLTool to create and return a signed URL for the embeddable job description search tool. Use this when you need to generate a URL that can be embedded on a web page to provide job description search fun
- Create RESTHook SubscriptionTool to create a new RESTHook subscription. Use after confirming your webhook endpoint is ready to receive document event notifications.
- Create Resume Search Embed URLTool to create and return a signed URL for the embeddable resume search tool. Use this when you need to generate a URL that can be embedded on a web page to provide resume search functionality. Option
- Create TagCreates a new tag in the specified workspace. Tags can be used to categorize and label documents for organization and filtering. Each tag name must be unique within its workspace. Returns the created
- Create Validation ResultCreate a validation result for document annotations in Affinda. Use this tool to record validation outcomes after parsing a document. Validation results track whether specific annotations (extracted d
- Batch Create Validation ResultsBatch create multiple validation results for document annotations in a single API call. Use this action to efficiently record validation outcomes for multiple documents or rules at once, rather than m
- Batch Delete AnnotationsBatch delete multiple document annotations in a single API call. Use this action to efficiently remove multiple annotations at once rather than making individual delete requests for each annotation. P
- Delete Data Source ValueTool to delete a specific value from a mapping data source. Use when you need to remove an incorrect or outdated value from a data source mapping.
- Delete Document TypeTool to permanently delete a document type by its identifier. Use when you need to remove a document type that is no longer needed. This is a destructive operation that cannot be undone.
- Delete Resthook SubscriptionTool to delete a specific resthook subscription by ID. Use after confirming the subscription identifier when the webhook is no longer needed.
- Delete Validation ResultsDelete multiple validation results in a single API call. Use this action to efficiently remove multiple validation results at once rather than making individual delete requests for each validation res
- Remove Tag from DocumentsRemove a tag from multiple documents in a single batch operation. Use this action to efficiently untag many documents at once rather than making individual remove requests. The operation is idempotent
- Replace Data Source ValuesTool to completely replace all values in a mapping data source. Use when you need to bulk update or refresh an entire data source's value list. Note: For large data sources (>1000 values), new values
- Split Document PagesSplit a document into multiple documents by dividing its pages. Use when you need to separate a multi-page document into distinct documents based on page groupings. Prerequisites: - Obtain the documen
- Update AnnotationTool to update data of a single annotation in Affinda. Use when you need to correct extracted values, verify annotations, or modify annotation metadata after document processing. Prerequisites: - Obta
- Update Data Field For CollectionTool to update a data field configuration for a collection's data point. Use when you need to modify field properties such as label, type, mandatory status, or validation settings after the field has
- Update Data Source ValueTool to update an existing value in a mapping data source. Use when you need to modify the label or description of an existing data source value. The value identifier itself cannot be changed.
- Update Document DataUpdate parsed data for a resume or job description document in Affinda. This endpoint is ONLY applicable for documents that have been processed with 'resume' or 'job-description' extractors. For other
- Update Document TypeTool to update a document type by its identifier. Use when you need to modify the name or description of an existing document type.
- Update ExtractorTool to update specific fields of an extractor. Use when you need to modify an extractor's name, category, validation settings, or field groups after creation.
- Update IndexTool to update the name of an existing search index. Use when you need to rename an index after creation.
- Update InvitationTool to update an organization invitation's role. Use when you need to change the role assigned to an invitation before it is accepted.
- Update Job Description Search ConfigTool to update the configuration for the logged in user's embeddable job description search tool. Use to configure display fields, field weights, maximum results, and UI customization options.
- Update MappingTool to update a specific mapping's settings. Use when you need to adjust score cutoff or ordering for a lookup against a MappingDataSource.
- Update OrganizationTool 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.
- Update Organization MembershipTool to update an organization membership's role. Use when you need to change a user's role within an organization.
- Update RESTHook SubscriptionTool to update an existing RESTHook subscription. Use after confirming the subscription identifier to modify its URL, event, or activation status.
- Update Resume Search ConfigTool to update the configuration for the logged in user's embeddable resume search tool. Use this to modify which fields are displayed, their search weights, maximum results limit, distance units, cus
- Update TagTool to update data of a tag. Use when you need to modify a tag's name or reassign it to a different workspace. Only provide the fields you want to change; other fields will remain unchanged.
Changes wait in Needs you
Changes and sends in Affinda are held for a person's approval by default. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
Affinda questions
Can an agent change data in Affinda on its own?
Not by default. Changes and sends in Affinda are held for a person's approval. The approval is recorded, and the action is sent once, never twice, with 10 seconds to undo.
What can an agent read in Affinda?
This connector lists 44 read actions. Reads run at once, without waiting for approval.
How does Affinda connect?
It connects with API key. Connectors are built and maintained by third-party developers; availability is confirmed during scoping.