Resume search, job description search, and matching across parsed-document indexes. Score candidates against a job description (or vice versa), retrieve match details, configure search and embed parameters, and request job-title and skill suggestions. Includes index management for organizing parsed documents and embeddable UI configuration for resume and JD search components.
Affinda Search and Match API is one of 16 APIs that Affinda publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Search, Matching, Resume Search, Job Description Search, and Recruitment. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.
This API exposes
24 operations
across 19 paths,
and defines 98 schemas.
It is described by OpenAPI 3.0.3, at version 3.0.0.
Requests are made against a single base URL, https://{region}.affinda.com.
24 operations19 paths98 schemas2 DELETE8 GET3 PATCH11 POST
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.0.3
API Version
3.0.0
Server
https://{region}.affinda.com
Authentication
HTTP Bearer
Resource Areas
1
Authentication & Security 1
Affinda Search and Match API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth — Basic authentication using an API key, e.g. {Authorization: Bearer aff0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings pag…
Paths & Operations 24
Across 19 paths, the API surfaces 24 operations — 2 DELETE, 8 GET, 3 PATCH, 11 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 98 schemas that model the data the API accepts and returns. The most detailed are DocumentMeta (39 properties), ResumeSearchParameters (39 properties), ResumeSearchConfig (30 properties), JobDescriptionSearchConfig (30 properties). Each schema is shown below with its type and property counts.
Annotation
object
16 properties13 required
JobDescriptionSearchParameters
object
30 properties1 required
ResumeSearchMatch
object
2 properties
ManagementLevel
string
Rectangle
object
5 properties4 required
IndexUpdate
object
1 property
LocationAnnotation
object
ResumeSearchParametersCustomData
object
Tag
object
4 properties4 required
properties-id
integer
Uniquely identify a user.
ResumeSkill
object
5 properties
Identifier
string
A random string that uniquely identify the resource.
SkillAnnotationUpdate
object
PaginatedResponse
object
3 properties1 required
identifier
string
Uniquely identify a workspace.
OccupationGroupSearchScoreComponent
object
3 properties1 required
email
string
ResumeSearchResult
object
14 properties13 required
FileName
string
Optional filename of the file
PageMeta
object
7 properties6 required
IndexCreate
object
2 properties1 required
name
string
User
object
5 properties
LocationAnnotationUpdate
object
Extractor_properties-identifier
string
Uniquely identify an extractor.
SkillAnnotation
object
TextAnnotationUpdate
object
DocumentCreateFromData
object
1 property1 required
UserNullable
object
5 properties
DateAnnotation
object
JobDescriptionData
object
A JSON-encoded string of the JobDescriptionData object.
18 properties
CustomDataSearchScoreComponent
object
docType
string
ThemeConfig
object
4 properties
RequestError
object
2 properties2 required
DocumentMeta_properties-identifier
string
Unique identifier for the document
JobDescriptionSearchConfig
object
30 properties
SkillsSearchScoreComponent
object
3 properties1 required
JobTitleAnnotationUpdate
object
JobTitleParsed
object
1 property
ExperienceSearchScoreComponent
object
3 properties1 required
ExpectedRemunerationAnnotation
object
ManagementLevelSearchScoreComponent
object
3 properties1 required
properties-identifier
string
Uniquely identify a collection.
Accreditation
object
4 properties
OccupationGroup
object
3 properties3 required
errorCode
string
DocumentWarning
object
2 properties
SearchParametersCustomData
object
6 properties2 required
ResumeSearchParametersLocation
object
4 properties
IndexUser
object
The user who created this index
4 properties4 required
AnnotationBase
object
13 properties
PaletteColorOptions
object
4 properties1 required
User_properties-name
string
LocationSearchScoreComponent
object
3 properties1 required
EducationSearchScoreComponent
object
3 properties1 required
JobTitleSearchScoreComponent
object
3 properties1 required
JobDescriptionSearchDetail
object
9 properties
Document
object
5 properties2 required
DateAnnotationUpdate
object
ResumeData
object
A JSON-encoded string of the ResumeData object.
25 properties
AnnotationContentType
string
The different data types of annotations
LanguagesSearchScoreComponent
object
3 properties1 required
JobDescriptionDataUpdate
object
A JSON-encoded string of the JobDescriptionData object.
17 properties
properties-avatar
string
URL of the user's avatar.
DocumentError
object
2 properties
ValidationRule
object
A validation rule for a collection
2 properties2 required
Index_properties-name
string
Unique index name
ResumeSearchParametersSkill
object
2 properties
ResumeSearch
object
5 properties
JobDescriptionSearch
object
5 properties
ResumeSearchEmbed
object
1 property
Education
object
6 properties
validatable
boolean
SearchConfigAction
object
2 properties2 required
CustomFieldConfig
object
2 properties2 required
Index
object
3 properties3 required
RegionBias
object
4 properties
OccupationGroupSearchResult
object
5 properties2 required
TextAnnotation
object
customIdentifier
string
Optional identifier for the document that you can set to track the document in the Affinda system. Is not required to be unique.
DocumentMeta
object
39 properties3 required
errorDetail
string
LanguageAnnotation
object
ResumeSearchDetail
object
9 properties
JobDescriptionSearchResult
object
14 properties13 required
ResumeSearchParameters
object
39 properties1 required
Location
object
14 properties1 required
YearsExperienceAnnotation
object
EducationLevel
string
JobTitleAnnotation
object
ExpiryTime
string
The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.
ExpectedRemunerationAnnotationUpdate
object
JobDescriptionSearchEmbed
object
1 property
LanguageAnnotationUpdate
object
YearsExperienceAnnotationUpdate
object
SearchExpressionSearchScoreComponent
object
3 properties1 required
ResumeSearchConfig
object
30 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
