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 61–90 of 119 actions
AFFINDA_GET_DATA_SOURCE_VALUE
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.
Untrusted display-only summary
AFFINDA_GET_DATA_SOURCE_VALUES
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.
Untrusted display-only summary
AFFINDA_GET_DOCUMENT
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…
Untrusted display-only summary
AFFINDA_GET_DOCUMENT_REDACTED
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.
Untrusted display-only summary
AFFINDA_GET_DOCUMENTS
Tool to retrieve a list of all documents. Use when you need to list documents in your Affinda workspace after authentication.
Untrusted display-only summary
AFFINDA_GET_DOCUMENT_SPLITTER
Tool to retrieve details of a specific document splitter by its identifier. Use when you need to fetch metadata about a document splitter configuration.
Untrusted display-only summary
AFFINDA_GET_DOCUMENT_TYPE
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.
Untrusted display-only summary
AFFINDA_GET_DOCUMENT_TYPE_JSON_SCHEMA
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.
Untrusted display-only summary
AFFINDA_GET_DOCUMENT_TYPE_PYDANTIC_MODELS
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.
Untrusted display-only summary
AFFINDA_GET_DOCUMENT_TYPES
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.
Untrusted display-only summary
AFFINDA_GET_EXTRACTOR
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.
Untrusted display-only summary
AFFINDA_GET_EXTRACTORS
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…
Untrusted display-only summary
AFFINDA_GET_INDEX_DOCUMENTS
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.
Untrusted display-only summary
AFFINDA_GET_INVITATION
Tool to retrieve details of a specific organization invitation by its identifier. Use when you need to check invitation status or get invitation metadata.
Untrusted display-only summary
AFFINDA_GET_JOB_DESCRIPTION_SEARCH_CONFIG
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.
Untrusted display-only summary
AFFINDA_GET_MAPPING
Tool to retrieve a specific mapping by its identifier. Use when you need to fetch mapping configuration details for a lookup against a MappingDataSource.
Untrusted display-only summary
AFFINDA_GET_ORGANIZATION
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.
Untrusted display-only summary
AFFINDA_GET_ORGANIZATION_MEMBERSHIP
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.
Untrusted display-only summary
AFFINDA_GET_ORGANIZATIONS
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.
Untrusted display-only summary
AFFINDA_GET_RESTHOOK_SUBSCRIPTION
Tool to retrieve details of a specific resthook subscription by its ID. Use after confirming its creation to verify its settings.
Untrusted display-only summary
AFFINDA_GET_RESTHOOK_SUBSCRIPTIONS
Tool to retrieve a list of all RESTHook subscriptions. Use after authenticating to list all webhook subscriptions associated with your account.
Untrusted display-only summary
AFFINDA_GET_TAG
Tool to retrieve details of a specific tag by its ID. Use when you need to fetch information about a particular tag.
Untrusted display-only summary
AFFINDA_GET_USAGE_BY_WORKSPACE
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.
Untrusted display-only summary
AFFINDA_GET_WORKSPACE
Tool to retrieve details of a specific workspace by its ID. Use when you need full workspace metadata after confirming its identifier.
Untrusted display-only summary
AFFINDA_GET_WORKSPACE_MEMBERSHIP
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.
Untrusted display-only summary
AFFINDA_GET_WORKSPACES
Tool to retrieve a list of all workspaces. Use when you need to list workspaces filtered by organization and optional name.
Untrusted display-only summary
AFFINDA_LIST_DATA_POINT_CHOICES
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.
Untrusted display-only summary
AFFINDA_LIST_DATA_POINTS
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.
Untrusted display-only summary
AFFINDA_LIST_DATA_SOURCES
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.
Untrusted display-only summary
AFFINDA_LIST_INDEXES
Tool to retrieve a list of all search indexes. Use when you need to view available indexes for searching and matching documents in Affinda.
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.