POST: /document/revealing

This endpoint allows you to generate the revealing output from a full text input.

post
Post /document/revealing

https://api.hrflow.ai/v1/document/revealing
Request
Response
Request
Headers
X-API-KEY
required
string
Authentication token.
X-USER-EMAIL
required
string
User's email
Body Parameters
text
required
string
Text to reveal
Response
200: OK
Revealing successfully generated.
{
"code": 200,
"message": "Revealing results",
"data": [
[
"Financial Reporting",
0.41042819600000002
],
[
"Microsoft Excel",
0.401153237
],
[
"Customer Service",
0.32542374699999999
],
[
"Microsoft Office",
0.32138148
]....
]
}
400: Bad Request
Text can't be null.
{
"code": 400,
"message": "Bad request. Text cannot be null"
}
401: Unauthorized
Invalid secret key.
{
"code": 401,
"message": "Unauthorized. Invalid secret key: xxxx for permission: write"
}

Max limit token is 512, if for a given text, this limit is exceeded, we will consider the first 512 tokens.

Python
Javascript
Python
from hrflow import Hrflow
client = Hrflow(api_secret="Your API Key", api_user="Your API user email")
response = client.document.revealing.post(text="hello")
Javascript
import Hrflow from 'hrflow';
const client = new Hrflow({
api_secret: 'Your API Key',
api_user: 'Your API user email'
});
client.document.revealing.post("text").then(response => {
console.log(response);
// ...
});