Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 699 Bytes

API.md

File metadata and controls

55 lines (42 loc) · 699 Bytes

Tagger

POST API_ENDPOINT/tagger

Generate tags from text using CTRLSum

Input

{
    "source": "text to tag"
}

Output

{
    "success": "true",
    "tags": "tags separated by ;, tags are strictly single-word (may include hyphens)"
}

If error occurred, the success field will be false and the tags field will be replaced by error which contains the detailed error message.

{
    "success": "false",
    "error": "error message"
}

GET API_ENDPOINT/health

Obtain the health status of the service

Input

N/A

Output

healthy:

{
    "health": "true"
}

unhealthy:

{
    "health": "false"
}