Skip to main content
Every affinda.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
New to Corsair? See API access, authentication, and error handling.

​
Annotations

​
batchUpdateAnnotations

annotations.batchUpdateAnnotations Batch 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 update requests for each annotation. Prerequisites: - Obtain annotation IDs using the ‘Get Annotations’ action with a document filter - Annotations must exist in documents that have been processed by Affinda Common use cases: - Correcting OCR/extraction errors in bulk - Updating parsed values after manual review - Modifying annotation data programmatically Risk: write
Input
Output: any

​
createBatchAnnotations

annotations.createBatchAnnotations Batch 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 for programmatically adding structured data to documents or importing annotation data from external sources. Prerequisites: - Documents must be created first using ‘Create Document’ action - Obtain document identifiers from ‘Create Document’ or ‘Get Documents’ actions - Know the data point identifiers for your collection (from extractor configuration) Common use cases: - Importing annotation data from external systems - Programmatically adding structured data to documents - Creating annotations for validation or training purposes Risk: write
Input
Output: any

​
deleteAnnotationsBatch

annotations.deleteAnnotationsBatch Batch 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. Prerequisites: - Obtain annotation IDs using the ‘Get Annotations’ action with a document filter - Annotations must exist in documents that have been processed by Affinda Common use cases: - Removing incorrect or unwanted annotations in bulk - Cleaning up annotations after document reprocessing - Deleting specific extracted data fields programmatically Risk: destructive · Irreversible
Input
Output: any

​
getAnnotations

annotations.getAnnotations Retrieves 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 access the extracted data. Risk: read
Input
Output: any

​
updateAnnotation

annotations.updateAnnotation Tool 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: - Obtain the annotation ID using the ‘Get Annotations’ action with a document filter - Annotations must exist in documents that have been processed by Affinda Common use cases: - Correcting OCR or extraction errors in individual fields - Marking annotations as verified after manual review (set isClientVerified=true) - Updating parsed values to fix incorrect data extraction - Modifying annotation coordinates or page references Note: For bulk updates across multiple annotations, use the ‘Batch Update Annotations’ action instead for better efficiency. Risk: write
Input
Output: any

​
Api Users

​
createApiUser

apiUsers.createApiUser Tool 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. Risk: write
Input
Output: any

​
getAllApiUsers

apiUsers.getAllApiUsers Tool to retrieve a list of all API users. Use when you need to list API users, optionally filtered by organization. Risk: read
Input
Output: any

​
Collections

​
createCollection

collections.createCollection 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. Risk: write
Input
Output: any

​
createDataFieldForCollection

collections.createDataFieldForCollection Tool 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. Risk: write
Input
Output: any

​
deleteCollection

collections.deleteCollection Permanently 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: Documents in the collection may also be affected. Risk: destructive · Irreversible
Input
Output: any

​
getCollection

collections.getCollection Tool to retrieve details of a specific collection by its ID. Use when you need full metadata about a collection after confirming its identifier. Risk: read
Input
Output: any

​
getCollectionFields

collections.getCollectionFields Tool to retrieve data field configuration for a collection associated with a data point. Use when you need to understand the structure and validation rules of a specific field in a collection. Note: This endpoint is deprecated. Risk: read
Input
Output: any

​
getCollections

collections.getCollections Tool to retrieve a list of all collections. Use when you need to list collections in your Affinda workspace after authentication. Risk: read
Input
Output: any

​
getCollectionUsage

collections.getCollectionUsage Retrieves monthly credits consumption statistics for a specific collection. Returns a list of usage records showing how many credits were consumed each month. Use this to track collection activity, monitor consumption trends, or generate usage reports. Note: This endpoint is deprecated. Risk: read
Input
Output: any

​
updateCollection

collections.updateCollection Tool to update specific fields of a collection. Use when you need to rename or reassign a collection after creation. Risk: write
Input
Output: any

​
updateDataFieldForCollection

collections.updateDataFieldForCollection Tool 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 been created. Risk: write
Input
Output: any

​
Data Point Choices

​
createDataPointChoice

dataPointChoices.createDataPointChoice Tool to create a custom data point choice. Use when you need to add a new choice option for a specific data point in a collection or organization. Note: This endpoint is deprecated but still functional. Risk: write
Input
Output: any

​
getDataPointChoice

dataPointChoices.getDataPointChoice Tool to return a specific data point choice by its ID. Use when you need details about a particular data point choice option. Note: This endpoint is deprecated but still functional. Risk: read
Input
Output: any

​
listDataPointChoices

dataPointChoices.listDataPointChoices Tool to retrieve available choices for a specific enum data point. Use when you need to discover valid options for dropdown/enum fields in a collection’s data schema. Note: This endpoint is deprecated but still functional for accessing data point choice metadata. Risk: read
Input
Output: any

​
replaceDataPointChoices

dataPointChoices.replaceDataPointChoices Tool to completely replace all choices for a data point. Use when you need to bulk update enum options - existing choices are matched by value, new values are created, updated values are modified, and values not in the incoming list are deleted. Note: This is a deprecated endpoint but still functional. Either collection or organization must be specified to scope the replacement. Risk: write
Input
Output: any

​
updateDataPointChoice

dataPointChoices.updateDataPointChoice Tool to update data of a data point choice by its ID. Use when you need to modify label, value, description, synonyms, or associated collection/organization for an existing data point choice. Note: This endpoint is deprecated but still functional. Risk: write
Input
Output: any

​
Data Points

​
createDataPoint

dataPoints.createDataPoint Tool to create a custom data point for document extraction. Use when you need to define a new field that should be extracted from documents in a specific extractor. Note: This endpoint is deprecated but still functional. Data points define custom fields for extraction models. Risk: write
Input
Output: any

​
deleteDataPoint

dataPoints.deleteDataPoint Tool to permanently delete a data point by its identifier. Use when you need to remove a data point from the database after confirming the identifier. Note: This endpoint is deprecated but still functional. Risk: destructive · Irreversible
Input
Output: any

​
getDataPoint

dataPoints.getDataPoint Tool to retrieve details of a specific data point by its identifier. Use when you need to inspect a data point’s configuration, type, or structure. Data points represent individual fields that can be extracted from documents (e.g., ‘name’, ‘email’, ‘date’). This endpoint is deprecated but still functional for retrieving data point metadata. Risk: read
Input
Output: any

​
listDataPoints

dataPoints.listDataPoints Tool 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. Risk: read
Input
Output: any

​
updateDataPoint

dataPoints.updateDataPoint Tool to update data of a data point by its identifier. Use when you need to modify a data point’s name, description, slug, parent, or mapping data source. Note: This endpoint is deprecated but still functional. Risk: write
Input
Output: any

​
Data Sources

​
createDataSource

dataSources.createDataSource Tool 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. Risk: write
Input
Output: any

​
createDataSourceValue

dataSources.createDataSourceValue Tool 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 and mapping workflows. Risk: write
Input
Output: any

​
deleteDataSource

dataSources.deleteDataSource Permanently 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 or was created in error. Risk: destructive · Irreversible
Input
Output: any

​
deleteDataSourceValue

dataSources.deleteDataSourceValue Tool 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. Risk: destructive · Irreversible
Input
Output: any

​
getDataSource

dataSources.getDataSource Tool 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. Risk: read
Input
Output: any

​
getDataSourceValue

dataSources.getDataSourceValue Tool 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. Risk: read
Input
Output: any

​
getDataSourceValues

dataSources.getDataSourceValues Tool 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. Risk: read
Input
Output: any

​
listDataSources

dataSources.listDataSources Tool 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. Risk: read
Input
Output: any

​
replaceDataSourceValues

dataSources.replaceDataSourceValues Tool 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 may take a few minutes to become searchable after the operation completes. Risk: write
Input
Output: any

​
updateDataSourceValue

dataSources.updateDataSourceValue Tool 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. Risk: write
Input
Output: any

​
Documents

​
addTagToDocuments

documents.addTagToDocuments Tool 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 grouping of documents in your workspace. Risk: write
Input
Output: any

​
createDocument

documents.createDocument Upload 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, and vendor details - Extract data from any supported document type (PDF, DOCX, images) You can upload either a file directly or provide a publicly accessible URL. The document will be processed by Affinda’s AI extraction engine. Prerequisites: - For collection-based uploads: Get collection ID from get_collections action - For workspace-specific uploads: Get workspace ID from get_workspaces action Risk: write
Input
Output: any

​
createFromDataDocuments

documents.createFromDataDocuments Create 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 identifier for subsequent status checks via /documents/. Risk: write
Input
Output: any

​
deleteDocument

documents.deleteDocument 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. Risk: destructive · Irreversible
Input
Output: any

​
getDocument

documents.getDocument Retrieve 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) - Document metadata (file name, page count, language) - Parsed/extracted data results - URLs for PDF, original file, and review page - Collection and workspace information The document identifier can be either a system-generated ID or a custom identifier set during document upload. Risk: read
Input
Output: any

​
getDocumentRedacted

documents.getDocumentRedacted Tool to retrieve the redacted version of a document as a PDF file. Use when you need to get a document with sensitive information removed. The original document is not modified by this operation. Risk: read
Input
Output: any

​
getDocuments

documents.getDocuments Tool to retrieve a list of all documents. Use when you need to list documents in your Affinda workspace after authentication. Risk: read
Input
Output: any

​
removeTagFromDocuments

documents.removeTagFromDocuments Remove 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 - removing a tag that isn’t present on a document will not cause an error. Risk: write
Input
Output: any

​
updateDocument

documents.updateDocument Tool to update specific fields of a document. Use when you need to rename, reassign, or adjust expiry and storage settings after document creation. Risk: write
Input
Output: any

​
updateDocumentData

documents.updateDocumentData Update 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 document types, use the batch_update_annotations endpoint instead. Use this tool when you need to correct or add parsed fields to an existing resume or job description document after it has been uploaded and processed. Risk: write
Input
Output: any

​
Document Splitters

​
getAllDocumentSplitters

documentSplitters.getAllDocumentSplitters Tool to get a list of all document splitters. Use when you need to retrieve document splitters, optionally filtered by organization. Risk: read
Input
Output: any

​
getDocumentSplitter

documentSplitters.getDocumentSplitter Tool to retrieve details of a specific document splitter by its identifier. Use when you need to fetch metadata about a document splitter configuration. Risk: read
Input
Output: any

​
Document Types

​
createDocumentType

documentTypes.createDocumentType Tool 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 within an organization. Risk: write
Input
Output: any

​
deleteDocumentType

documentTypes.deleteDocumentType Tool 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. Risk: destructive · Irreversible
Input
Output: any

​
getDocumentType

documentTypes.getDocumentType 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. Risk: read
Input
Output: any

​
getDocumentTypeJsonSchema

documentTypes.getDocumentTypeJsonSchema Tool 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. Risk: read
Input
Output: any

​
getDocumentTypePydanticModels

documentTypes.getDocumentTypePydanticModels Tool 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. Risk: read
Input
Output: any

​
getDocumentTypes

documentTypes.getDocumentTypes Retrieve 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 available document types before uploading or processing documents. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | data | string | Yes | Data from the action execution | | error | string | No | Error if any occurred during the execution of the action | | successful | boolean | Yes | Whether or not the action execution was successful or not | Risk: read
Input
Output: any

​
updateDocumentType

documentTypes.updateDocumentType Tool to update a document type by its identifier. Use when you need to modify the name or description of an existing document type. Risk: write
Input
Output: any

​
Extractors

​
createExtractor

extractors.createExtractor Tool 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. Risk: write
Input
Output: any

​
deleteExtractor

extractors.deleteExtractor Permanently delete an extractor from Affinda by its identifier. This is a destructive operation that cannot be undone. Use Get Extractors first to verify the extractor ID before deletion. Note: This action is deprecated by the API. Risk: destructive · Irreversible
Input
Output: any

​
getExtractor

extractors.getExtractor Tool 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. Risk: read
Input
Output: any

​
getExtractors

extractors.getExtractors Retrieve 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 (resumes, invoices, etc.) and any custom extractors created for the organization. Use this action to: - List available extractors before creating a collection - Find the identifier of a specific extractor type - Check if custom extractors exist for the organization Risk: read
Input
Output: any

​
updateExtractor

extractors.updateExtractor Tool 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. Risk: write
Input
Output: any

​
Indexes

​
createIndex

indexes.createIndex Tool 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. Risk: write
Input
Output: any

​
deleteIndex

indexes.deleteIndex Tool 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. Risk: destructive · Irreversible
Input
Output: any

​
getIndexDocuments

indexes.getIndexDocuments Tool 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. Risk: read
Input
Output: any

​
listIndexes

indexes.listIndexes Tool to retrieve a list of all search indexes. Use when you need to view available indexes for searching and matching documents in Affinda. Risk: read
Input
Output: any

​
updateIndex

indexes.updateIndex Tool to update the name of an existing search index. Use when you need to rename an index after creation. Risk: write
Input
Output: any

​
Invitations

​
createInvitation

invitations.createInvitation Tool to create a new organization invitation. Use when you need to invite a user to join an organization with a specific role. Risk: write
Input
Output: any

​
deleteInvitation

invitations.deleteInvitation Tool to delete an invitation by its identifier. Use when you need to remove or revoke an invitation after confirming the invitation identifier. Risk: destructive · Irreversible
Input
Output: any

​
getAllInvitations

invitations.getAllInvitations Tool 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. Risk: read
Input
Output: any

​
getInvitation

invitations.getInvitation Tool to retrieve details of a specific organization invitation by its identifier. Use when you need to check invitation status or get invitation metadata. Risk: read
Input
Output: any

​
updateInvitation

invitations.updateInvitation Tool to update an organization invitation’s role. Use when you need to change the role assigned to an invitation before it is accepted. Risk: write
Input
Output: any

​
createJobDescriptionSearch

jobDescriptionSearch.createJobDescriptionSearch Search 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, location, education, or to find jobs matching a candidate’s resume. Returns ranked results with detailed match scores. Risk: write
Input
Output: any

​
createJobDescriptionSearchEmbedUrl

jobDescriptionSearch.createJobDescriptionSearchEmbedUrl Tool 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 functionality. Optionally pass config_override to customize display settings, field weights, and theme. Risk: write
Input
Output: any

​
getJobDescriptionSearchConfig

jobDescriptionSearch.getJobDescriptionSearchConfig Tool to get the configuration for the logged in user’s embeddable job description search tool. Returns display settings, field weights, and maximum results limits. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | data | string | Yes | Data from the action execution | | error | string | No | Error if any occurred during the execution of the action | | successful | boolean | Yes | Whether or not the action execution was successful or not | Risk: read
Input
Output: any

​
updateJobDescriptionSearchConfig

jobDescriptionSearch.updateJobDescriptionSearchConfig Tool 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. Risk: write
Input
Output: any

​
Mappings

​
createMapping

mappings.createMapping Tool to create a custom mapping for a data source. Use when you need to configure specific lookup settings for a MappingDataSource. Note: This endpoint is deprecated. Risk: write
Input
Output: any

​
deleteMapping

mappings.deleteMapping Tool to delete a specific mapping by its identifier. Use when you need to remove an unused or incorrect mapping from the database. Note: This endpoint is deprecated. Risk: destructive · Irreversible
Input
Output: any

​
getMapping

mappings.getMapping Tool to retrieve a specific mapping by its identifier. Use when you need to fetch mapping configuration details for a lookup against a MappingDataSource. Risk: read
Input
Output: any

​
listMappings

mappings.listMappings Tool to retrieve the list of all custom data mappings. Use when you need to list mappings for a specific data source. Risk: read
Input
Output: any

​
updateMapping

mappings.updateMapping Tool to update a specific mapping’s settings. Use when you need to adjust score cutoff or ordering for a lookup against a MappingDataSource. Risk: write
Input
Output: any

​
Occupation Groups

​
listOccupationGroups

occupationGroups.listOccupationGroups Tool to retrieve the list of searchable occupation groups. Use when you need to get available occupation categories for job matching or classification. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | data | string | Yes | Data from the action execution | | error | string | No | Error if any occurred during the execution of the action | | successful | boolean | Yes | Whether or not the action execution was successful or not | Risk: read
Input
Output: any

​
Organization Memberships

​
getAllOrganizationMemberships

organizationMemberships.getAllOrganizationMemberships Retrieve 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 memberships. Risk: read
Input
Output: any

​
getOrganizationMembership

organizationMemberships.getOrganizationMembership Tool 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. Risk: read
Input
Output: any

​
updateOrganizationMembership

organizationMemberships.updateOrganizationMembership Tool to update an organization membership’s role. Use when you need to change a user’s role within an organization. Risk: write
Input
Output: any

​
Organizations

​
createOrganization

organizations.createOrganization Tool to create a new organization. Use when you have a unique organization name and want to group resources under it. Risk: write
Input
Output: any

​
deleteOrganization

organizations.deleteOrganization Permanently 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 the get_organizations action first to confirm the organization identifier before deletion. Risk: destructive · Irreversible
Input
Output: any

​
getOrganization

organizations.getOrganization 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. Risk: read
Input
Output: any

​
getOrganizations

organizations.getOrganizations Retrieves 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 ‘identifier’ field from the response when calling other organization-related endpoints. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | data | string | Yes | Data from the action execution | | error | string | No | Error if any occurred during the execution of the action | | successful | boolean | Yes | Whether or not the action execution was successful or not | Risk: read
Input
Output: any

​
updateOrganization

organizations.updateOrganization 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. Risk: write
Input
Output: any

​
Resthooks

​
createResthookSubscription

resthooks.createResthookSubscription Tool to create a new RESTHook subscription. Use after confirming your webhook endpoint is ready to receive document event notifications. Risk: write
Input
Output: any

​
deleteResthookSubscription

resthooks.deleteResthookSubscription Tool to delete a specific resthook subscription by ID. Use after confirming the subscription identifier when the webhook is no longer needed. Risk: destructive · Irreversible
Input
Output: any

​
getResthookSubscription

resthooks.getResthookSubscription Tool to retrieve details of a specific resthook subscription by its ID. Use after confirming its creation to verify its settings. Risk: read
Input
Output: any

​
getResthookSubscriptions

resthooks.getResthookSubscriptions Tool to retrieve a list of all RESTHook subscriptions. Use after authenticating to list all webhook subscriptions associated with your account. Risk: read
Input
Output: any

​
updateResthookSubscription

resthooks.updateResthookSubscription Tool to update an existing RESTHook subscription. Use after confirming the subscription identifier to modify its URL, event, or activation status. Risk: write
Input
Output: any

​
createResumeSearch

resumeSearch.createResumeSearch Tool 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. Risk: write
Input
Output: any

​
createResumeSearchEmbedUrl

resumeSearch.createResumeSearchEmbedUrl Tool 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. Optionally pass config_override to customize display settings, field weights, and theme. Risk: write
Input
Output: any

​
listResumeSearchConfig

resumeSearch.listResumeSearchConfig Tool 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 the resume search interface. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | data | string | Yes | Data from the action execution | | error | string | No | Error if any occurred during the execution of the action | | successful | boolean | Yes | Whether or not the action execution was successful or not | Risk: read
Input
Output: any

​
listResumeSearchJobTitleSuggestions

resumeSearch.listResumeSearchJobTitleSuggestions Tool to get job title suggestions based on provided job title(s). Use when you need to find related job titles for resume search. Risk: read
Input
Output: any

​
listResumeSearchSkillSuggestions

resumeSearch.listResumeSearchSkillSuggestions Tool to get skill suggestions based on provided skills. Use when you need to find related skills to expand or refine resume search queries. Risk: read
Input
Output: any

​
updateResumeSearchConfig

resumeSearch.updateResumeSearchConfig Tool 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, custom actions, and theme settings. Risk: write
Input
Output: any

​
Tags

​
createTag

tags.createTag Creates 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 tag with its ID and metadata. Risk: write
Input
Output: any

​
deleteTag

tags.deleteTag Permanently 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. Risk: destructive · Irreversible
Input
Output: any

​
getAllTags

tags.getAllTags Tool to list all tags. Use after confirming authentication to fetch tags across workspaces. Risk: read
Input
Output: any

​
getTag

tags.getTag Tool to retrieve details of a specific tag by its ID. Use when you need to fetch information about a particular tag. Risk: read
Input
Output: any

​
updateTag

tags.updateTag Tool 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. Risk: write
Input
Output: any

​
Validation

​
splitDocumentPages

validation.splitDocumentPages Split 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 document identifier from create_document or get_document actions - Use get_document to retrieve page IDs for the pages you want to split Important notes: - Each page can only be assigned to one split - All pages should be accounted for across all splits - One split can optionally use the original document identifier to maintain the root document Risk: write
Input
Output: any

​
Validation Results

​
createValidationResult

validationResults.createValidationResult Create 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 data fields) pass or fail business rules. Prerequisites: 1. Get a document identifier from Get Documents or Create Document 2. Get annotation IDs from Get Annotations for that document 3. Define a kebab-case rule slug that identifies your validation rule Example use cases: - Recording that an invoice total matches the sum of line items - Marking that a required field is present and valid - Logging validation failures for review workflows Risk: write
Input
Output: any

​
createValidationResultsBatch

validationResults.createValidationResultsBatch Batch 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 making individual create requests for each validation result. This is particularly useful for bulk validation workflows or when validating multiple rules across many documents. Prerequisites: - Obtain document identifiers from Get Documents or Create Document actions - Get annotation IDs from Get Annotations for those documents - Define kebab-case rule slugs that identify your validation rules Common use cases: - Bulk recording of validation results across multiple documents - Validating multiple business rules on the same document - Automated validation workflows for large document batches Risk: write
Input
Output: any

​
deleteValidationResults

validationResults.deleteValidationResults Delete 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 result. Prerequisites: - Obtain validation result IDs using the ‘Get All Validation Results’ action Common use cases: - Removing obsolete validation results in bulk - Cleaning up validation results after reprocessing documents - Deleting validation results for specific documents programmatically Risk: destructive · Irreversible
Input
Output: any

​
getAllValidationResults

validationResults.getAllValidationResults Tool to list validation results for documents. Use after processing documents to inspect validation outcomes. Risk: read
Input
Output: any

​
Workspace Memberships

​
createWorkspaceMembership

workspaceMemberships.createWorkspaceMembership Tool to add a user to a workspace by creating a membership. Use when you need to grant a user access to a specific workspace. Risk: write
Input
Output: any

​
deleteWorkspaceMembership

workspaceMemberships.deleteWorkspaceMembership Tool to remove a user from a workspace by membership ID. Use after confirming the workspace membership ID to revoke access. Risk: destructive · Irreversible
Input
Output: any

​
getAllWorkspaceMemberships

workspaceMemberships.getAllWorkspaceMemberships Retrieve 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. Risk: read
Input
Output: any

​
getWorkspaceMembership

workspaceMemberships.getWorkspaceMembership 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. Risk: read
Input
Output: any

​
Workspaces

​
createWorkspace

workspaces.createWorkspace Tool to create a new workspace. Use when you need to programmatically create a workspace container within an organization. Risk: write
Input
Output: any

​
deleteWorkspace

workspaces.deleteWorkspace Tool to delete a specific workspace by its ID. Use when you need to remove an unused workspace after confirming the workspace ID. Risk: destructive · Irreversible
Input
Output: any

​
getUsageByWorkspace

workspaces.getUsageByWorkspace Retrieves 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 activity, monitor consumption trends, or generate usage reports. Risk: read
Input
Output: any

​
getWorkspace

workspaces.getWorkspace Tool to retrieve details of a specific workspace by its ID. Use when you need full workspace metadata after confirming its identifier. Risk: read
Input
Output: any

​
getWorkspaces

workspaces.getWorkspaces Tool to retrieve a list of all workspaces. Use when you need to list workspaces filtered by organization and optional name. Risk: read
Input
Output: any

​
updateWorkspace

workspaces.updateWorkspace Tool 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; other fields will remain unchanged. Risk: write
Input
Output: any