Generate Job Description🔗︎

HTTP Verb	Path
POST	/v10/job-description/generate

Generates a job description based on specified parameters.

Info

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center )
Due to the nature of LLMs, the output generated by this endpoint is non-deterministic. This means that the same input may result in different outputs on each request.

Scope of use🔗︎

The purpose of the endpoint is to assist in the creation of unique and tailored job descriptions. You may store, use, and distribute the generated job descriptions. The use of the endpoint must align with the intended purpose of generating job descriptions.

Request Body🔗︎

JobTitle 🔗︎ string required

Job Title🔗︎

The title of the job. There is a 100 character limit.

Skills 🔗︎ object[]

Skills🔗︎

List of skill requirements for the job. There is a limit of 20 skills.

Skills properties

Name 🔗︎ string

Type🔗︎

The name of the skill. There is a 50 character limit.

Priority 🔗︎ string

Id🔗︎

Priority of skill. One of: MustHave or NiceToHave.

Tone 🔗︎ string

Tone🔗︎

The tone of the job description. One of: Professional, Casual, or Funny.

Language 🔗︎ string

Language🔗︎

Language of the job description, in ISO 639-1 code format.

Location 🔗︎ string

Location🔗︎

Location of the job. There is a 100 character limit.

Organization 🔗︎ string

Organization🔗︎

The organization offering the job. There is a 100 character limit.

Sample JSON

{
  "JobTitle": "Software Engineer",
  "Skills": [
    {"Name": "Python", "Priority": "MustHave"},
    {"Name": "Django", "Priority": "NiceToHave"}
  ],
  "Tone": "Professional",
  "Language": "en",
  "Location": "New York",
  "Organization": "Tech Corp"
}

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 service@textkernel.com about issues.

EngineVersion 🔗︎ string

EngineVersion🔗︎

The version of the parsing/matching engine running under-the-hood.

ApiVersion 🔗︎ string

ApiVersion🔗︎

The version of the API.

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

AccountId 🔗︎ string

AccountId🔗︎

The AccountId for the account.

Name 🔗︎ string

Name🔗︎

The customer name on the account.

IPAddress 🔗︎ string

IPAddress🔗︎

The client IP Address where the API call originated.

Region 🔗︎ string

Region🔗︎

The region for the account, also known as the 'Data Center'.

CreditsRemaining 🔗︎ decimal

CreditsRemaining🔗︎

The number of credits remaining to be used by the account.

CreditsUsed 🔗︎ decimal

CreditsUsed🔗︎

The number of credits used by the account.

MaximumConcurrentRequests 🔗︎ integer

MaximumConcurrentRequests🔗︎

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.

ExpirationDate 🔗︎ date

ExpirationDate🔗︎

The date that the current credits expire.

Value 🔗︎ object

Value🔗︎

Contains response data for the transaction.

Value properties

JobDescription 🔗︎ string

JobDescription🔗︎

The generated job description.

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": {
    "JobDescription": "string"
  }
}

Rate limits🔗︎

Accounts have a limited request rate. Exceeding the limit results in 429 Too Many Requests HTTP responses.

Plan	Limit	Units
Standard	100	Minute
Demo	30	Minute