Get Skills Taxonomy🔗︎
HTTP Verb | Path |
---|---|
GET | /v10/skills/taxonomy?format={json|csv} |
Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.
Info
- This is an add-on feature. Reach out to sales@textkernel.com for more information.
- This endpoint should not be called frequently. See Standard Transaction Cost
Scope of use🔗︎
The purpose of this endpoint is to look up information in our Taxonomy. You must cache or store the response to limit the number of requests. When discontinuing use of our Services, you are required to delete all copies of the Taxonomy.
Query Parameters🔗︎
Parameter | Data Type | Description |
---|---|---|
format | string | The datatype to return the taxonomy in. Can be either json or csv . |
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
Skills 🔗︎ object[]
Skills🔗︎
An array of skills objects.
Skills properties
IsoCode 🔗︎ string
IsoCode🔗︎
The language ISO 639-1 code. This will only appear for language skills (Type = Language
).
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",
"IsoCode": "string",
"Descriptions": [
{
"IsoCode": "string",
"Description": "string"
}
]
}
]
}
}