Affinda

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.

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.

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

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

Tool to delete a specific collection by its id. use when you need to remove an unused collection. use after verifying the collection id.

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.

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

Tool to delete a specific workspace by its id. use when you need to remove an unused workspace after confirming the workspace id.

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

Tool to list all workspace memberships for the authenticated user. use when you need to see roles and access across all workspaces.

Tool to retrieve details of a specific collection by its id. use when you need full metadata about a collection after confirming its identifier.

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

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.

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

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.

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

Tool to retrieve details of a specific workspace by its id. use when you need full workspace metadata after confirming its identifier.

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

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.

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

Tool to update specific fields of a document. use when you need to rename, reassign, or adjust expiry and storage settings after document creation.

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.

Tool to update multiple annotations in one request. use when you need to modify parsed values or other fields across many annotations at once.

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

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

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

Tool to delete a specific resthook subscription by id. use after confirming the subscription identifier when the webhook is no longer needed.

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

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

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

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.

Tool to retrieve a list of all document types. use when you need to display or filter documents by type before processing.

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

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

Tool to retrieve a list of all resthook subscriptions. use after authenticating to list all webhook subscriptions associated with your account.

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

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.

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.

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