Skip to main
Group
Free TrialCTA Arrow
Why Sovren?
Products
Group 15
Resume Parser
Parse resume and job orders with control, accuracy and speed.
Group 15
+AI Matching
Match with an engine that mimics your thinking.
PricingResourcesCompany

API Technical Specs

Learn how to configure and leverage our services to achieve your toughest recruiting needs.
Group 6
SaaS     |
Getting Started
First Steps
Sovren SDK
Code Samples
Standard Transaction Cost
Endpoints
Authentication
Versioning
HTTP Status Codes
Resume Parser Overview
Document Last Modified Date
Batch Parsing Concurrency
How Does Resume Parsing Work
Documents That Can Cause Problems
Entry Level
Australia
Config String Builder
Parser Output Settings
Additional Settings
Searching
Sort Order
Matching
Scores
Filtering
Semantic Filter
Full-text Filter
Boolean Syntax
Special Operators
Semantic Expressions
Feature Comparison
UI Overview
Authentication
UI Customization
Hooks
Getting Started
Rate Limits
Skills
Supported Languages
About the Skills Taxonomy
Professions
Supported Taxonomies
Supported Languages
Ontology
Supported Languages
API Technical SpecsPoliciesFAQsDocumentsRelease Notes

Extract Skills

POST /v10/skills/extract

Extracts known skills from the given text.

Notes

Scope of use

The purpose of this endpoint is to enrich data records using our Taxonomy. You may store the parts of the response that are relevant to individual data records - such as candidate or employee profiles - within these records. It is not permitted to cache, store, or utilize responses from this endpoint for the purpose of limiting request volume, or to create replicas or derivatives of the Service and the Taxonomy.

Request Body

Textrequiredstring
The text to extract skills from. There is a 24,000 character limit.
Languagerequiredstring
The language of the input text. Must be one of the supported ISO codes.
OutputLanguagestring
The language to use for the output skill descriptions. If not provided, defaults to the input language. Must be one of the supported ISO codes.
Thresholdfloat
A value from [0 - 1] for the minimum confidence threshold for extracted skills. Lower values will return more skills, but also increase the likelihood of ambiguity-related errors. The recommended and default value is 0.5.

Sample Request

{ ... 
"Text" :  "","Language" :  "","OutputLanguage" :  "","Threshold" :  0.5}

Response Body

Infoobject
Information explaining the outcome of the transaction.
Info.Codestring
A response code elaborating on the HTTP status code.
The following is a list of codes that can be returned by the service:

Success – Successful transaction

MissingParameter - A required parameter wasn't provided

InvalidParameter - A parameter was incorrectly specified

AuthenticationError - An error occurred with the credentials provided
Info.Messagestring
This message further describes the code providing additional detail.
Info.TransactionIdstring
The (GUID) id for a specific API transaction. Use this when contacting support@sovren.com about issues.
Info.EngineVersionstring
The version of the parsing/matching engine running under-the-hood.
Info.ApiVersionstring
The version of the API.
Info.TotalElapsedMillisecondsinteger
How long the transaction took on Sovren's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.
Info.TransactionCostdecimal
How many credits the transaction costs.How many credits the transaction costs.
Info.CustomerDetailsobject
Information about the customer who made the API call.
Value.CustomerDetails.AccountIdstring
The AccountId for the account.
Value.CustomerDetails.Namestring
The customer name on the account.
Value.CustomerDetails.IPAddressstring
The client IP Address where the API call originated.
Value.CustomerDetails.Regionstring
The region for the account, also known as the 'Data Center'.
Value.CustomerDetails.CreditsRemainingdecimal
The number of credits remaining to be used by the account.
Value.CustomerDetails.CreditsUseddecimal
The number of credits used by the account.
Value.CustomerDetails.MaximumConcurrentRequestsinteger
The number of requests that can be made at one time. If using sub-accounts, this is the maximum number of concurent requests across all accounts, not just this single sub-account.
Value.CustomerDetails.ExpirationDatedate
The date that the current credits expire.
Valueobject
Contains response data for the transaction.
Value.Truncatedboolean
Whether the input text was truncated or not due to length.
Value.Skillsobject[]
A list of extracted skills.
Value.Skills[i].Typestring
Type of skill. Possible values are Professional, IT, Language, or Soft.
Value.Skills[i].Idstring
The ID for the skill in the skills taxonomy.
Value.Skills[i].Confidencefloat
A value from [0 - 1] indicating the overall confidence that the extracted term actually refers to a skill in the context of the text (the average value of the 'likelihood' values of the individual match scores).
Value.Skills[i].Descriptionstring
The description of the normalized skill concept in the requested language.
Value.Skills[i].IsoCodestring
The language ISO 639-1 code. This will only appear for language skills (Type = Language).
Value.Skills[i].Matchesobject[]
A list of matches where this skill was found in the text.
Value.Skills[i].Matches[j].BeginSpanint
The index of the first character of the match (0-based)
Value.Skills[i].Matches[j].EndSpanint
The index of the last character of the match (0-based).
Value.Skills[i].Matches[j].Likelihoodfloat
Likelihood that the matched term actually refers to a skill in the context of the text.
Value.Skills[i].Matches[j].RawTextstring
The actual term that was found as evidence of this skill (the substring from BeginSpan to EndSpan).

Sample Response

{ ... 
{ ... 
"Code" :  "string","Message" :  "string","TransactionId" :  "string","EngineVersion" :  "string","ApiVersion" :  "string","TotalElapsedMilliseconds" :  0,"TransactionCost" :  0,{ ... 
"AccountId" :  "string","Name" :  "string","IPAddress" :  "string","Region" :  "string","CreditsRemaining" :  0,"CreditsUsed" :  0,"ExpirationDate" :  "2021-12-31","MaximumConcurrentRequests" :  0}},{ ... 
"Truncated" :  false,[ ... 
{
"Type" :  "string","Id" :  "string","Confidence" :  1,"Description" :  "string","IsoCode" :  "string",[ ... 
{
"BeginSpan" :  0,"EndSpan" :  1,"Likelihood" :  1,"RawText" :  "string"}]}]}}
SOC II Type 2
Compliant
Why Sovren?
Company
Pricing
Account Login
Have questions? We can help.
© 2023 Textkernel US LLC. All rights reserved.
Privacy Policy | Terms of Service | GDPR