Autocomplete Skills🔗︎
HTTP Verb | Path |
---|---|
POST | /v10/skills/autocomplete |
Returns normalized skills that begin with a given prefix, based on the chosen language(s). Each skill is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the skill is included in the results.
Info
- You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )
- To minimize the number of requests, it is recommended to set a delay between each keystroke before sending a new request.
Scope of use🔗︎
The purpose of this endpoint is to provide real-time autocompletions for user input based on our Taxonomy. 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🔗︎
Prefix 🔗︎ string
required
Prefix🔗︎
The skill prefix to be completed. Must contain at least 1 character.
Languages 🔗︎ string[]
Languages🔗︎
The language(s) used to search for matching skills (the language of the provided Prefix). A maximum of 5 languages can be provided. Must be one of the supported ISO codes.
Types 🔗︎ string[]
Types🔗︎
If specified, only these types of skills will be returned. The following values are acceptable: Professional
, IT
, Language
, Soft
, All
.
Limit 🔗︎ int
Limit🔗︎
The maximum number of returned skills. The default is 10 and the maximum is 100.
OutputLanguage 🔗︎ string
OutputLanguage🔗︎
The language to ouput the found skill descriptions in (default is en
). Must be one of the supported ISO codes.
Sample JSON
Response Body🔗︎
Info 🔗︎ object
Info🔗︎
Information explaining the outcome of the transaction.
Info properties
Code 🔗︎ string
Code🔗︎
Code | Description |
---|---|
Success |
Successful transaction |
MissingParameter |
A required parameter wasn't provided |
InvalidParameter |
A parameter was incorrectly specified |
AuthenticationError |
An error occurred with the credentials provided |
Message 🔗︎ string
Message🔗︎
This message further describes the code providing additional detail.
TransactionId 🔗︎ string
TransactionId🔗︎
The (GUID) id for a specific API transaction. Use this when contacting support@textkernel.com about issues.
EngineVersion 🔗︎ string
EngineVersion🔗︎
The version of the parsing/matching engine running under-the-hood.
TotalElapsedMilliseconds 🔗︎ integer
TotalElapsedMilliseconds🔗︎
How long the transaction took on Textkernel's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.
TransactionCost 🔗︎ decimal
TransactionCost🔗︎
How many credits the transaction costs.How many credits the transaction costs.
CustomerDetails 🔗︎ object
CustomerDetails🔗︎
Information about the customer who made the API call.
CustomerDetails properties
CreditsRemaining 🔗︎ decimal
CreditsRemaining🔗︎
The number of credits remaining to be used by the account.
Value 🔗︎ object
Value🔗︎
Contains response data for the transaction.
Value properties
Sample JSON
{
"Info": {
"Code": "string",
"Message": "string",
"TransactionId": "string",
"EngineVersion": "string",
"ApiVersion": "string",
"TotalElapsedMilliseconds": 0,
"TransactionCost": 0,
"CustomerDetails": {
"AccountId": "string",
"Name": "string",
"IPAddress": "string",
"Region": "string",
"CreditsRemaining": 0,
"CreditsUsed": 0,
"ExpirationDate": "2021-12-31",
"MaximumConcurrentRequests": 0
}
},
"Value": {
"Skills": [
{
"Id": "string",
"Type": "string",
"Description": "string"
}
]
}
}