API_KEY
affinda_api_key
Developer setup
No fields declared in this snapshot.
User connection
- Affinda API Keygeneric_api_key · stringRequired
- Workspace IDworkspace_id · stringRequired
AFFINDA
Affinda provides an AI-powered document processing platform that automates data extraction from various document types.
Description is untrusted, display-only upstream metadata. It never becomes policy, OAuth scope authority, or an agent instruction.
Pakkawork boundary
Research catalogue metadata only. No Pakkawork OAuth, credential, host, quota, executor, or verifier is enabled.
119
Action summaries
Display-only definitions
0
Trigger types
Not installed instances
1
Auth modes
Field names, never values
No
Execution
No runtime adapter
Authentication map
API_KEY
No fields declared in this snapshot.
Capability index
Showing 91–119 of 119 actions
AFFINDA_LIST_MAPPINGS
Tool to retrieve the list of all custom data mappings. Use when you need to list mappings for a specific data source.
Untrusted display-only summary
AFFINDA_LIST_OCCUPATION_GROUPS
Tool to retrieve the list of searchable occupation groups. Use when you need to get available occupation categories for job matching or classification.
Untrusted display-only summary
AFFINDA_LIST_RESUME_SEARCH_CONFIG
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.
Untrusted display-only summary
AFFINDA_LIST_RESUME_SEARCH_JOB_TITLE_SUGGESTIONS
Tool to get job title suggestions based on provided job title(s). Use when you need to find related job titles for resume search.
Untrusted display-only summary
AFFINDA_LIST_RESUME_SEARCH_SKILL_SUGGESTIONS
Tool to get skill suggestions based on provided skills. Use when you need to find related skills to expand or refine resume search queries.
Untrusted display-only summary
AFFINDA_REMOVE_TAG_FROM_DOCUMENTS
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.
Untrusted display-only summary
AFFINDA_REPLACE_DATA_POINT_CHOICES
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 collecti…
Untrusted display-only summary
AFFINDA_REPLACE_DATA_SOURCE_VALUES
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.
Untrusted display-only summary
AFFINDA_SPLIT_DOCUMENT_PAGES
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 wan…
Untrusted display-only summary
AFFINDA_UPDATE_ANNOTATION
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 th…
Untrusted display-only summary
AFFINDA_UPDATE_COLLECTION
Tool to update specific fields of a collection. Use when you need to rename or reassign a collection after creation.
Untrusted display-only summary
AFFINDA_UPDATE_DATA_FIELD_FOR_COLLECTION
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.
Untrusted display-only summary
AFFINDA_UPDATE_DATA_POINT
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.
Untrusted display-only summary
AFFINDA_UPDATE_DATA_POINT_CHOICE
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.
Untrusted display-only summary
AFFINDA_UPDATE_DATA_SOURCE_VALUE
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.
Untrusted display-only summary
AFFINDA_UPDATE_DOCUMENT
Tool to update specific fields of a document. Use when you need to rename, reassign, or adjust expiry and storage settings after document creation.
Untrusted display-only summary
AFFINDA_UPDATE_DOCUMENT_DATA
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 parse…
Untrusted display-only summary
AFFINDA_UPDATE_DOCUMENT_TYPE
Tool to update a document type by its identifier. Use when you need to modify the name or description of an existing document type.
Untrusted display-only summary
AFFINDA_UPDATE_EXTRACTOR
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.
Untrusted display-only summary
AFFINDA_UPDATE_INDEX
Tool to update the name of an existing search index. Use when you need to rename an index after creation.
Untrusted display-only summary
AFFINDA_UPDATE_INVITATION
Tool to update an organization invitation's role. Use when you need to change the role assigned to an invitation before it is accepted.
Untrusted display-only summary
AFFINDA_UPDATE_JOB_DESCRIPTION_SEARCH_CONFIG
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.
Untrusted display-only summary
AFFINDA_UPDATE_MAPPING
Tool to update a specific mapping's settings. Use when you need to adjust score cutoff or ordering for a lookup against a MappingDataSource.
Untrusted display-only summary
AFFINDA_UPDATE_ORGANIZATION
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.
Untrusted display-only summary
AFFINDA_UPDATE_ORGANIZATION_MEMBERSHIP
Tool to update an organization membership's role. Use when you need to change a user's role within an organization.
Untrusted display-only summary
AFFINDA_UPDATE_RESTHOOK_SUBSCRIPTION
Tool to update an existing RESTHook subscription. Use after confirming the subscription identifier to modify its URL, event, or activation status.
Untrusted display-only summary
AFFINDA_UPDATE_RESUME_SEARCH_CONFIG
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.
Untrusted display-only summary
AFFINDA_UPDATE_TAG
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.
Untrusted display-only summary
AFFINDA_UPDATE_WORKSPACE
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.
Untrusted display-only summary
Provenance
The detail snapshot comes from an attributed MIT-licensed repository revision. Safe local icons use exact-match CC0 Simple Icons symbols; unmatched brands use monograms.
Remote text is plain display metadata only. It must never become an agent prompt, execution policy, OAuth grant, or executable instruction.