POST : /document/linking

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

post
Post /document/linking
https://api.hrflow.ai/v1/document/linking
Request
Response
Request
Headers
X-API-KEY
required
string
Authentication token.
X-USER-EMAIL
required
string
User's email.
Body Parameters
text
required
string
A text to calculate most similar token
top_n
optional
string
The n most similar word to a given text
( Default value is 5)
Response
200: OK
Top n most similar word for a given text retreived successfully
{
    "code": 200,
    "message": "Linking results",
    "data": [
        [
            "perl",
            0.86659765243530273
        ],
        [
            "bash",
            0.83746224641799927
        ],
        [
            "django",
            0.82120096683502197
        ],
        [
            "java",
            0.82105296850204468
        ]
    ]
}
401: Unauthorized
Invalid secret key.
{
    "code": 401,
    "message": "Unauthorized. Invalid secret key: xxxx for permission: write"
}
404: Not Found
Text can't be null
{
    "code": 400,
    "message": "Bad request. Text cannot be null"
}
Python
Javascript
Python
from hrflow import Hrflow
​
client = Hrflow(api_secret="Your API Key", api_user="Your API user email")
​
​
response = client.document.linking.post(text="python", top_n=20)
Javascript
const client = new Hrflow({ 
    api_secret: 'Your API Key',
    api_user: 'Your API user email'
});
​
client.document.linking.post("python", 20).then(response => {
    console.log(response);
    // ...
});

POST: /document/embedding

Next - API Reference

Webhooks

Last updated 1 month ago

POST : /document/linking

postPost /document/linking

post
Post /document/linking