About this endpoint
What it does
Extracts keyword groups from the article URLs you provide and returns them in a ranked list. You send a set of publicly accessible article URLs, and the response contains grouped keywords derived from those articles.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| urls | String Array | Yes | Publicly accessible article URLs to analyse. Maximum 10; extras are ignored. Each item must be a URI. |
| article_length | Integer | No | Expected article character length hint (optional; helps the parser tune extraction). |
| return_results_top | Integer | No | Maximum number of keyword groups to return. Allowed range: 5–50. Omit to return all groups. |
Response
Returns a JSON object with a data object field. data contains a keyword_groups array of objects, where each item includes a score number and a keywords string array. The schema does not declare a status code.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object | Yes | Response wrapper object. |
| data.keyword_groups | Object Array | No | Ranked keyword groups extracted from the provided articles. Each item contains a score number and a keywords string array. |
| data.keyword_groups[].score | Number | No | Ranking score for the keyword group. |
| data.keyword_groups[].keywords | String Array | No | Keywords included in the group. |