Affinda integration: operations for AI agents
Affinda connects to Type.com as an integration. This page lists the 109 operations documented for Claude and Codex in Type.com: 46 read, 44 write, 19 destructive.
About Affinda
Affinda provides an AI-powered document processing platform that automates data extraction from various document types.
Categories: Analytics & Data, HR & Recruiting
How to connect Affinda to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
109 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
109 operations listed.
Documents
- Read
Get list of all documents
Returns all the document summaries for that user, limited to 300 per page.
- Read
Get specific document
Return a specific document.
- Read
Get redacted document
Get the redacted version of a document. The original document is not modified.
- Write
Upload a document for parsing
Uploads a document for parsing via file upload or URL. When successful, returns an identifier in the response for subsequent use with the /documents/{identifier} endpoint to check processing status and retrieve results.
- Write
Update a document
Update file name, expiry time, or move to another collection, etc.
- Destructive
Delete a document
Deletes the specified document from the database.
Workspaces
- Read
Get list of all workspaces
Returns your workspaces.
- Read
Get specific workspace
Return a specific workspace.
- Read
Get list of all workspace memberships
Returns the memberships of your workspaces.
- Read
Get specific workspace membership
Return a specific workspace membership.
- Write
Create a workspace
Create a workspace
- Write
Update a workspace
Update a workspace.
- Write
Create a workspace membership
Create a workspace membership.
- Destructive
Delete a workspace
Deletes the specified workspace from the database.
- Destructive
Delete a workspace membership
Remove an user from a workspace.
Document Types
- Read
List document types
Returns a list of document types that the user has access to.
- Read
Get a document type
Returns the details of a specific document type.
- Read
Generate JSON schema from a document type
Generate JSON schema from a document type.
- Read
Generate Pydantic models from a document type
Generate Pydantic models from a document type.
- Write
Create a document type
Create a new document type in the specified organization.
- Write
Update a document type
Update an existing document type.
- Destructive
Delete a document type
Delete a document type.
Data Sources
- Read
List data sources
Returns the list of all custom mapping data sources.
- Read
Get specific data source
Return a specific mapping data source.
- Read
List values for a data source
Returns the list of all values in a mapping data source
- Read
Get specific data source value
Return a specific mapping dta source value.
- Write
Create a data source
Create a custom mapping data source.
- Write
Add value for a data source
Adds a value to a mapping data source
- Destructive
Delete specific data source
Delete the specified mapping data source from the database.
- Destructive
Replace values for a data source
Replaces the list of all values in a mapping data source Note: For large data sources (e.g. 1000 values), it can take a few minutes after the request completes for the new values to be searchable.
- Destructive
Update specific data source value
Update the specified mapping data source value.
- Destructive
Delete specific data source value
Delete the specified mapping data source value from the database.
Validation Results
- Read
Get list of all validation results
Returns the validation results of a document.
- Read
Get specific validation result
Return a specific validation result.
- Write
Create a validation result
Create a validation result.
- Write
Update a validation result
Update a validation result.
- Write
Batch create validation results
Batch create validation results.
- Write
Batch delete validation results
Batch delete validation results
- Destructive
Delete a validation result
Remove validation result.
Organizations
- Read
Get list of all organizations
Returns all the organizations
- Read
Get detail of an organization
Get detail of an organization.
Add x hidden to endpoints
- Read
Get list of all organization memberships
Returns all the organization memberships
- Read
Get detail of an organization membership
Get detail of an organization membership.
- Write
Create a new organization
Create a new organization.
- Write
Update an organization
Update the detail of an organization.
- Write
Update an organization membership
The admin users can use this endpoint to update the role of the members within their organization.
- Destructive
Delete an organization
Delete the specified organization from the database.
- Destructive
Delete an organization membership
The admin users can use this endpoint to remove member from their organization. Other users can also use this to leave their organization.
Usage
- Read
Get usage
Returns daily credits consumption for an organization over a date range. Optionally scope the report to a single workspace, a single document type, or a single (workspace × document type) pair by supplying both workspace and documenttype.
Tags
- Read
Get list of all tags
Returns your tags.
- Read
Get specific tag
Return a specific tag.
- Write
Create a tag
Create a tag
- Write
Update a tag
Update data of an tag.
- Write
Add a tag to documents
Add a tag to documents. Tags are used to group documents together. Tags can be used to filter documents.
- Destructive
Delete an tag
Deletes the specified tag from the database.
- Destructive
Remove a tag from documents
Remove a tag from documents.
Annotations
- Read
Get list of all annotations
Returns your annotations.
- Read
Get specific annotation
Return a specific annotation.
- Write
Create a annotation
Create a annotation
- Write
Update an annotation
Update data of an annotation.
- Write
Batch create annotations
Batch create annotations
- Write
Batch update annotations
Batch update annotations
- Write
Batch delete annotations
Batch delete annotations
- Destructive
Delete an annotation
Deletes the specified annotation from the database.
Webhooks
- Read
Get list of all resthook subscriptions
Returns your resthook subscriptions.
- Read
Get specific resthook subscription
Return a specific resthook subscription.
- Read
Get list of webhook delivery results for a document
Returns the webhook (resthook) delivery results recorded for a document.
- Write
Create a resthook subscription
After a subscription is successfully created, we'll send a POST request to your target URL with a X-Hook-Secret header. You need to response to this request with a 200 status code to confirm your subscribe intention.
- Write
Update a resthook subscription
Update data of a resthook subscription.
- Write
Activate a resthook subscription
After creating a subscription, we'll send a POST request to your target URL with a X-Hook-Secret header. You should response to this with a 200 status code, and use the value of the X-Hook-Secret header that you received to activate the subscription using this endpoint.
- Write
Re-trigger webhooks for a document
Replays an event for a document, re-firing it to every matching v3 webhook subscription (including ones that are currently inactive). The deliveries are queued asynchronously, so a 202 is returned immediately.
- Destructive
Delete a resthook subscription
Deletes the specified resthook subscription from the database.
Search & Match
- Read
List occupation groups
Returns the list of searchable occupation groups.
- Read
Search through parsed resumes
Searches through parsed resumes. Users have 3 options to create a search: 1. Match to a job description - a parsed job description is used to find candidates that suit it 2. Match to a resume - a parsed resume is used to find other candidates that have similar attributes 3.
- Read
Get search result of specific resume
This contains more detailed information about the matching score of the search criteria, or which search criteria is missing in this resume. The identifier is the unique ID returned via the /resumesearch endpoint.
- Read
Get the config for the logged in user's embeddable resume search tool
Return configurations such as which fields can be displayed in the logged in user's embeddable resume search tool, what are their weights, what is the maximum number of results that can be returned, etc.
- Read
Match a single resume and job description
Get the matching score between a resume and a job description. The score ranges between 0 and 1, with 0 being not a match at all, and 1 being perfect match. Note, this score will not directly match the score returned from POST /resumesearch/details/{identifier}.
- Read
Get job title suggestions based on provided job title(s)
Provided one or more job titles, get related suggestions for your search.
- Read
Get skill suggestions based on provided skill(s)
Provided one or more skills, get related suggestions for your search.
- Read
Search through parsed job descriptions
Searches through parsed job descriptions. You can search with custom criterias or a resume.
- Read
Get search result of specific job description
This contains more detailed information about the matching score of the search criteria, or which search criteria is missing in this job description. The identifier is the unique ID returned via the /jobdescriptionsearch endpoint.
- Read
Get the config for the logged in user's embeddable job description search tool
Return configurations such as which fields can be displayed in the logged in user's embeddable job description search tool, what are their weights, what is the maximum number of results that can be returned, etc.
- Read
Get list of all indexes
Returns all the indexes
- Read
Get indexed documents for a specific index
Returns all the indexed documents for that index
- Write
Create a document from raw data
Creates a document directly from structured resume or job description data for use in Search & Match functionality. This endpoint is specifically designed for programmatic document creation without file uploads.
- Write
Update a document's data
Update data of a document. Only applicable for resumes and job descriptions. For other document types, please use the PATCH /annotations/{id} endpoint or the POST /annotations/batchupdate endpoint.
- Write
Update the config for the logged in user's embeddable resume search tool
Update configurations such as which fields can be displayed in the logged in user's embeddable resume search tool, what are their weights, what is the maximum number of results that can be returned, etc.
- Write
Create a signed URL for the embeddable resume search tool
Create and return a signed URL of the resume search tool which then can be embedded on a web page. An optional parameter configoverride can be passed to override the user-level configurations of the embeddable resume search tool.
- Write
Update the config for the logged in user's embeddable job description search tool
Update configurations such as which fields can be displayed in the logged in user's embeddable job description search tool, what are their weights, what is the maximum number of results that can be returned, etc.
- Write
Create a signed URL for the embeddable job description search tool
Create and return a signed URL of the job description search tool which then can be embedded on a web page. An optional parameter configoverride can be passed to override the user-level configurations of the embeddable search tool.
- Write
Create a new index
Create an index for the search tool
- Write
Update an index
Updates the specified index
- Write
Index a new document
Create an indexed document for the search tool
- Write
Re-index a document
Re-index a document. This is relevant if you updated the document's data via the /annotations endpoint, and want to refresh the document's data in the search index.
- Destructive
Delete an index
Deletes the specified index from the database
- Destructive
Delete an indexed document
Delete the specified indexed document from the database
Deprecated End Points
- Read
Get list of all API users
Returns your API users.
- Read
Get specific API user
Return a specific API user.
- Write
Create an API user
Create an API user
- Write
Update an API user
Update data of an API user.
- Write
Regenerate API key for an API user
Regenerate API key for an API user.
- Destructive
Delete an API user
Deletes the specified API user from the database.
Organization API Invitation
- Read
Get list of all invitations
Get list of all invitations you created or sent to you.
- Read
Get detail of an invitation
Get detail of an invitation.
- Read
Get detail of an invitation by token
Get detail of an invitation using a secret token. This allows users who have not registered/logged in to view the invitation.
- Write
Create a new invitation
Create a new invitation.
- Write
Update an invitation
Update the detail of an invitation.
- Write
Respond to an invitation
Choose to accept or decline an invitation.
- Destructive
Delete an invitation
Delete the specified invitation from the database.
No operations match.
See How connections work for access and permissions, or browse all integrations.