Affinda
AI · AI
Resumes, invoices and contracts parsed into structured fields in their own workspace.
Acts as the person, not as itself
Each user connects their own account. Every call carries both identities — the agent and the person it is acting for — so the agent can never reach past what that individual can already do.
Credentials never touch the agent
Tokens live in the vault and attach server-side at call time. The agent holds a session, not a secret, and revoking access does not mean rotating a key.
Every call on the record
Who asked, which agent acted, which action ran, and the verdict that let it through — one audit trail across every integration, not one per vendor.
What an agent can do
Each action is granted on its own. An agent allowed to read is not thereby allowed to write, and the scope beside each row is what the acting user must have connected for it to run at all.
affinda_delete_v3_annotations_by_idWRITEDelete an annotation -- Deletes the specified annotation from the database.
affinda_delete_v3_api_users_by_idWRITEDEPRECATED by Affinda ("Deprecated End Points" tag); live today, no end-of-life date published. Delete an API user -- Deletes the specified API user from the database.
affinda_delete_v3_collections_by_identifierWRITEDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Delete a collection -- Deletes the specified collection from the database.
affinda_delete_v3_data_point_choices_by_idWRITEDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Delete a data point choice -- Deletes the specified data point choice from the database.
affinda_delete_v3_data_points_by_identifierWRITEDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Delete a data point -- Deletes the specified data point from the database.
affinda_delete_v3_document_types_by_identifierWRITEDelete a document type -- Delete a document type.
affinda_delete_v3_documents_by_identifierWRITEDelete a document -- Deletes the specified document from the database.
affinda_delete_v3_extractors_by_identifierWRITEDEPRECATED by Affinda (`deprecated: true`); live today, no end-of-life date published. Delete an extractor -- Deletes the specified extractor from the database.
affinda_delete_v3_index_by_nameWRITEDelete an index -- Deletes the specified index from the database
affinda_delete_v3_index_by_name_documents_by_identifierWRITEDelete an indexed document -- Delete the specified indexed document from the database
affinda_delete_v3_invitations_by_identifierWRITEDelete an invitation -- Delete the specified invitation from the database.
affinda_delete_v3_mapping_data_sources_by_identifierWRITEDelete specific data source -- Delete the specified mapping data source from the database.
affinda_delete_v3_mapping_data_sources_by_identifier_values_by_valueWRITEDelete specific data source value -- Delete the specified mapping data source value from the database.
affinda_delete_v3_mappings_by_identifierWRITEDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Delete specific mapping -- Delete the specified mapping from the database.
affinda_delete_v3_organization_memberships_by_identifierWRITEDelete 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.
affinda_delete_v3_organizations_by_identifierWRITEDelete an organization -- Delete the specified organization from the database.
affinda_delete_v3_resthook_subscriptions_by_idWRITEDelete a resthook subscription -- Deletes the specified resthook subscription from the database.
affinda_delete_v3_tags_by_idWRITEDelete an tag -- Deletes the specified tag from the database.
affinda_delete_v3_validation_results_by_idWRITEDelete a validation result -- Remove validation result.
affinda_delete_v3_workspace_memberships_by_identifierWRITEDelete a workspace membership -- Remove an user from a workspace.
affinda_delete_v3_workspaces_by_identifierWRITEDelete a workspace -- Deletes the specified workspace from the database.
affinda_get_v3_annotationsREADGet list of all annotations -- Returns your annotations.
affinda_get_v3_annotations_by_idREADGet specific annotation -- Return a specific annotation.
affinda_get_v3_api_usersREADDEPRECATED by Affinda ("Deprecated End Points" tag); live today, no end-of-life date published. Get list of all API users -- Returns your API users.
affinda_get_v3_api_users_by_idREADDEPRECATED by Affinda ("Deprecated End Points" tag); live today, no end-of-life date published. Get specific API user -- Return a specific API user.
affinda_get_v3_collectionsREADDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Get list of all collections -- Returns your collections.
affinda_get_v3_collections_by_identifierREADDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Get specific collection -- Return a specific collection.
affinda_get_v3_collections_by_identifier_fields_by_datapoint_identifierREADDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Get data field for a collection assosciated with a data point. -- Get a data field for a collection assosciated with a data point
affinda_get_v3_collections_by_identifier_usageREADDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Get usage by collection -- Return monthly credits consumption of a collection. Deprecated: use `GET /v3/usage?organization={id}&document_type={id}` instead.
affinda_get_v3_data_point_choicesREADDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Get list of data point choices -- Returns available choices for a specific enum data point.
affinda_get_v3_data_point_choices_by_idREADDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Get specific data point choice -- Return a specific data point choice.
affinda_get_v3_data_pointsREADDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Get list of all data points -- Returns your custom data points as well as Affinda's off-the-shelf data points.
affinda_get_v3_data_points_by_identifierREADDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Get specific data point -- Return a specific data point.
affinda_get_v3_document_splittersREADDEPRECATED by Affinda (`deprecated: true`); live today, no end-of-life date published. Get list of all document splitters -- Returns all the document splitters visible to the user.
affinda_get_v3_document_splitters_by_identifierREADDEPRECATED by Affinda (`deprecated: true`); live today, no end-of-life date published. Get specific document splitter -- Return a specific document splitter.
affinda_get_v3_document_typesREADList document types -- Returns a list of document types that the user has access to.
affinda_get_v3_document_types_by_identifierREADGet a document type -- Returns the details of a specific document type.
affinda_get_v3_document_types_by_identifier_json_schemaREADGenerate JSON schema from a document type -- Generate JSON schema from a document type.
affinda_get_v3_document_types_by_identifier_pydantic_modelsREADGenerate Pydantic models from a document type -- Generate Pydantic models from a document type.
affinda_get_v3_documentsREADGet list of all documents -- Returns all the document summaries for that user, limited to 300 per page.
affinda_get_v3_documents_by_identifierREADGet specific document -- Return a specific document. This is the POLL endpoint for an upload sent with `wait: false`: re-read it until `meta.ready` is true, or until `meta.failed` is true, which is terminal and carries `meta.errorCode` / `meta.errorDetail`.
affinda_get_v3_extractorsREADDEPRECATED by Affinda (`deprecated: true`); live today, no end-of-life date published. Get list of all extractors -- Returns your custom extractors as well as Affinda's off-the-shelf extractors.
affinda_get_v3_extractors_by_identifierREADDEPRECATED by Affinda (`deprecated: true`); live today, no end-of-life date published. Get specific extractor -- Return a specific extractor.
affinda_get_v3_indexREADGet list of all indexes -- Returns all the indexes
affinda_get_v3_index_by_name_documentsREADGet indexed documents for a specific index -- Returns all the indexed documents for that index
affinda_get_v3_invitationsREADGet list of all invitations -- Get list of all invitations you created or sent to you.
affinda_get_v3_invitations_by_identifierREADGet detail of an invitation -- Get detail of an invitation.
affinda_get_v3_invitations_token_by_tokenREADGet 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.
affinda_get_v3_job_description_search_configREADGet 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…
affinda_get_v3_mapping_data_sourcesREADList data sources -- Returns the list of all custom mapping data sources.
affinda_get_v3_mapping_data_sources_by_identifierREADGet specific data source -- Return a specific mapping data source.
affinda_get_v3_mapping_data_sources_by_identifier_valuesREADList values for a data source -- Returns the list of all values in a mapping data source
affinda_get_v3_mapping_data_sources_by_identifier_values_by_valueREADGet specific data source value -- Return a specific mapping dta source value.
affinda_get_v3_mappingsREADDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. List mappings -- Returns the list of all custom data mappings.
affinda_get_v3_mappings_by_identifierREADDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Get specific mapping -- Return a specific mapping.
affinda_get_v3_occupation_groupsREADList occupation groups -- Returns the list of searchable occupation groups.
affinda_get_v3_organization_membershipsREADGet list of all organization memberships -- Returns all the organization memberships
affinda_get_v3_organization_memberships_by_identifierREADGet detail of an organization membership -- Get detail of an organization membership.
affinda_get_v3_organizationsREADGet list of all organizations -- Returns all the organizations
affinda_get_v3_organizations_by_identifierREADGet detail of an organization -- Get detail of an organization.
affinda_get_v3_resthook_resultsREADGet list of webhook delivery results for a document -- Returns the webhook (resthook) delivery results recorded for a document.
affinda_get_v3_resthook_subscriptionsREADGet list of all resthook subscriptions -- Returns your resthook subscriptions.
affinda_get_v3_resthook_subscriptions_by_idREADGet specific resthook subscription -- Return a specific resthook subscription.
affinda_get_v3_resume_search_configREADGet 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…
affinda_get_v3_resume_search_matchREADMatch 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.
affinda_get_v3_resume_search_suggestion_job_titleREADGet job title suggestions based on provided job title(s) -- Provided one or more job titles, get related suggestions for your search.
affinda_get_v3_resume_search_suggestion_skillREADGet skill suggestions based on provided skill(s) -- Provided one or more skills, get related suggestions for your search.
affinda_get_v3_tagsREADGet list of all tags -- Returns your tags.
affinda_get_v3_tags_by_idREADGet specific tag -- Return a specific tag.
affinda_get_v3_usageREADGet usage -- Returns daily credits consumption for an organization over a date range.
affinda_get_v3_validation_resultsREADGet list of all validation results -- Returns the validation results of a document.
affinda_get_v3_validation_results_by_idREADGet specific validation result -- Return a specific validation result.
affinda_get_v3_workspace_membershipsREADGet list of all workspace memberships -- Returns the memberships of your workspaces.
affinda_get_v3_workspace_memberships_by_identifierREADGet specific workspace membership -- Return a specific workspace membership.
affinda_get_v3_workspacesREADGet list of all workspaces -- Returns your workspaces.
affinda_get_v3_workspaces_by_identifierREADGet specific workspace -- Return a specific workspace.
affinda_get_v3_workspaces_by_identifier_usageREADDEPRECATED by Affinda (`deprecated: true`); live today, no end-of-life date published. Get usage by workspace -- Return monthly credits consumption of a workspace. Deprecated: use `GET /v3/usage?organization={id}&workspace={id}` instead.
affinda_patch_v3_annotations_by_idWRITEUpdate an annotation -- Update data of an annotation.
affinda_patch_v3_api_users_by_idWRITEDEPRECATED by Affinda ("Deprecated End Points" tag); live today, no end-of-life date published. Update an API user -- Update data of an API user.
affinda_patch_v3_collections_by_identifierWRITEDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Update a collection -- Update data of a collection.
affinda_patch_v3_collections_by_identifier_fields_by_datapoint_identifierWRITEDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Update data field for a collection assosciated with a data point. -- Update data field for a collection assosciated with a data point
affinda_patch_v3_data_point_choices_by_idWRITEDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Update a data point choice -- Update data of a data point choice.
affinda_patch_v3_data_points_by_identifierWRITEDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Update a data point -- Update data of a data point.
affinda_patch_v3_document_types_by_identifierWRITEUpdate a document type -- Update an existing document type.
affinda_patch_v3_documents_by_identifierWRITEUpdate a document -- Update file name, expiry time, or move to another collection, etc.
affinda_patch_v3_extractors_by_identifierWRITEDEPRECATED by Affinda (`deprecated: true`); live today, no end-of-life date published. Update an extractor -- Update data of an extractor.
affinda_patch_v3_index_by_nameWRITEUpdate an index -- Updates the specified index
affinda_patch_v3_invitations_by_identifierWRITEUpdate an invitation -- Update the detail of an invitation.
affinda_patch_v3_invitations_token_by_tokenWRITERespond to an invitation -- Choose to accept or decline an invitation.
affinda_patch_v3_job_description_search_configWRITEUpdate 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…
affinda_patch_v3_mappings_by_identifierWRITEDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Update specific mapping -- Updates a specific mapping.
affinda_patch_v3_organization_memberships_by_identifierWRITEUpdate an organization membership -- The admin users can use this endpoint to update the role of the members within their organization.
affinda_patch_v3_organizations_by_identifierWRITEUpdate an organization -- Update the detail of an organization. NOTE: the `avatar` upload field is NOT available through this tool -- unbounded bytes never enter a tool argument. Set it in the Affinda web app.
affinda_patch_v3_resthook_subscriptions_by_idWRITEUpdate a resthook subscription -- Update data of a resthook subscription.
affinda_patch_v3_resume_search_configWRITEUpdate 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…
affinda_patch_v3_tags_by_idWRITEUpdate a tag -- Update data of an tag.
affinda_patch_v3_validation_results_by_idWRITEUpdate a validation result -- Update a validation result.
affinda_patch_v3_workspaces_by_identifierWRITEUpdate a workspace -- Update a workspace.
affinda_post_v3_annotationsWRITECreate a annotation
affinda_post_v3_annotations_batch_createWRITEBatch create annotations
affinda_post_v3_annotations_batch_deleteWRITEBatch delete annotations
affinda_post_v3_annotations_batch_updateWRITEBatch update annotations
affinda_post_v3_api_usersWRITEDEPRECATED by Affinda ("Deprecated End Points" tag); live today, no end-of-life date published. Create an API user
affinda_post_v3_api_users_by_id_regenerate_api_keyWRITEDEPRECATED by Affinda ("Deprecated End Points" tag); live today, no end-of-life date published. Regenerate API key for an API user -- Regenerate API key for an API user.
affinda_post_v3_collectionsWRITEDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Create a collection
affinda_post_v3_collections_by_identifier_create_data_fieldWRITEDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Create data field for a collection along with a new data point.
affinda_post_v3_data_point_choicesWRITEDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Create a data point choice -- Create a custom data point choice.
affinda_post_v3_data_point_choices_replaceWRITEDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Replace choices of a data point -- Replace choices of a data point. Existing choices and incoming choices are matched base on their `value`.
affinda_post_v3_data_pointsWRITEDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Create a data point -- Create a custom data point.
affinda_post_v3_document_typesWRITECreate a document type -- Create a new document type in the specified organization.
affinda_post_v3_documentsWRITEUpload a document for parsing -- Uploads a document for parsing via file upload or URL. NOTE: the `file` upload field is NOT available through this tool -- unbounded bytes never enter a tool argument. Supply `url` instead (Affinda downloads the document itself), or use affinda_post_v3_documents_create_from_data for structured data. ASYNCHRONOUS: `wait` defaults to true, which holds the request open until parsing completes and will time out on a large document. Send `wait: false` to get an `identifier` back immediately, then poll affinda_get_v3_documents_by_identifier until `meta.ready` is true; `meta.failed` with `meta.errorCode` / `meta.errorDetail` is the failure end state.
affinda_post_v3_documents_batch_add_tagWRITEAdd a tag to documents -- Add a tag to documents. Tags are used to group documents together. Tags can be used to filter documents.
affinda_post_v3_documents_batch_remove_tagWRITERemove a tag from documents -- Remove a tag from documents.
affinda_post_v3_documents_by_identifier_update_dataWRITEUpdate a document's data -- Update data of a document. Only applicable for resumes and job descriptions.
affinda_post_v3_documents_create_from_dataWRITECreate a document from raw data -- Creates a document directly from structured resume or job description data for use in Search & Match functionality. SYNCHRONOUS, unlike the file/URL upload: this operation parses nothing, so it takes no `wait` argument and returns the created document directly. Use affinda_post_v3_documents when you have a file or a URL to parse.
affinda_post_v3_extractorsWRITEDEPRECATED by Affinda (`deprecated: true`); live today, no end-of-life date published. Create an extractor -- Create a custom extractor.
affinda_post_v3_indexWRITECreate a new index -- Create an index for the search tool
affinda_post_v3_index_by_name_documentsWRITEIndex a new document -- Create an indexed document for the search tool
affinda_post_v3_index_by_name_documents_by_identifier_re_indexWRITERe-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.
affinda_post_v3_invitationsWRITECreate a new invitation -- Create a new invitation.
affinda_post_v3_job_description_searchWRITESearch through parsed job descriptions -- Searches through parsed job descriptions. You can search with custom criterias or a resume.
affinda_post_v3_job_description_search_details_by_identifierWRITEGet 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.
affinda_post_v3_job_description_search_embedWRITECreate 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.
affinda_post_v3_mapping_data_sourcesWRITECreate a data source -- Create a custom mapping data source.
affinda_post_v3_mapping_data_sources_by_identifier_valuesWRITEAdd value for a data source -- Adds a value to a mapping data source
affinda_post_v3_mappingsWRITEDEPRECATED by Affinda (`deprecated: true` + tag); live today, no end-of-life date published. Create a mapping -- Create a custom mapping.
affinda_post_v3_organizationsWRITECreate a new organization -- Create a new organization. NOTE: the `avatar` upload field is NOT available through this tool -- unbounded bytes never enter a tool argument. Set it in the Affinda web app.
affinda_post_v3_resthook_results_resendWRITERe-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).
affinda_post_v3_resthook_subscriptionsWRITECreate 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.
affinda_post_v3_resthook_subscriptions_activateWRITEActivate a resthook subscription -- After creating a subscription, we'll send a POST request to your target URL with a `X-Hook-Secret` header.
affinda_post_v3_resume_searchWRITESearch 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.
affinda_post_v3_resume_search_details_by_identifierWRITEGet 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.
affinda_post_v3_resume_search_embedWRITECreate 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.
affinda_post_v3_tagsWRITECreate a tag
affinda_post_v3_validate_by_identifier_splitWRITEDEPRECATED by Affinda (`deprecated: true`); live today, no end-of-life date published. Split pages of a document -- Split / merge / rotate / delete pages of a document. Documents with multiple pages can be splitted into multiple documents, or merged into one document. Each page can also be rotated.
affinda_post_v3_validation_resultsWRITECreate a validation result -- Create a validation result.
affinda_post_v3_validation_results_batch_createWRITEBatch create validation results -- Batch create validation results.
affinda_post_v3_validation_results_batch_deleteWRITEBatch delete validation results
affinda_post_v3_workspace_membershipsWRITECreate a workspace membership -- Create a workspace membership.
affinda_post_v3_workspacesWRITECreate a workspace
affinda_put_v3_mapping_data_sources_by_identifier_valuesWRITEReplace values for a data source -- Replaces the list of all values in a mapping data source Note: For large data sources (e.g.
affinda_put_v3_mapping_data_sources_by_identifier_values_by_valueWRITEUpdate specific data source value -- Update the specified mapping data source value.
Often connected alongside
Put Affinda behind one governed endpoint.
Same permissions, same audit trail, whatever else you connect next.