Status Page
API Reference

Inspect title normalization

post
https://api.lightcast.io/titles/versions//normalize/inspect

Normalize a raw job title string to a list of the top matching Lightcast titles

Supported document types and their expected Content-Type (Document must be UTF-8 encoded.):

  • JSON – application/json
  • Plain text – text/plain

Raw title size is limited to 1kB.

Note that this endpoint has a base tier yearly quota of 50 requests. Contact us if you'd like this increased or made unlimited. Responses from this endpoint will include two headers, RateLimit-Remaining and RateLimit-Reset, which indicate how many requests you have remaining in your current quota period and when that quota will reset, respectively.

Requesting title mappings requires additional permissions, please contact us if you'd like access to mappings.

Path Params
string
required

The title version.

Query Params
number
0 to 1
Defaults to 0.5

Filter out titles with a confidence value lower than this threshold (this query param does not apply for JSON requests).

integer
0 to 100
Defaults to 5

Limit the number of normalized titles for the given term (this query param does not apply for JSON requests).

string
Defaults to id,name

List of fields to return per title. See /versions/{version} for available fields (this query param does not apply for JSON requests).
Mappings require additional permissions, please contact us if you'd like access to mappings.

Body Params
string
required
length ≥ 1
fields
array of strings
length ≥ 1
Defaults to id,name

See /versions/{version} for available fields.

mappings require additional permissions, please contact us if you'd like access to mappings.

List of fields to return per title
number
0 to 1
Defaults to 0.5
integer
0 to 100
Defaults to 5
Responses

Updated 9 months ago

Language
Credentials
OAuth2
Missing 1 required scope
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 9 months ago