Extract the key words and phrases from a text

Extracts the most relevant keywords and key phrases, best first, each with a relevance from 0 to 1 (higher is more relevant).

Request

POSThttps://text-analysis.p.apihiver.com/v1/keywords

JSON object. Required: text.

Request Body

Edit the values below to test different scenarios.

Parameters and body structure are inherited from this endpoint's definition. Changes here only apply to this test run.

Language
Client
1curl --request POST \
2  --url https://text-analysis.p.apihiver.com/v1/keywords \
3  --header 'Accept: application/json' \
4  --header 'Content-Type: application/json' \
5  --header 'X-API-Key: YOUR_API_KEY' \
6  --data '{
7  "text": "APIHiver is a marketplace where developers discover, test and subscribe to APIs. Providers publish their APIs with documentation and pricing plans. The platform handles keys, billing and analytics so that developers can focus on building great products. Many teams love how simple it is."
8}'

Extract the key words and phrases from a text: Text Analysis API reference

Extracts the most relevant keywords and key phrases, best first, each with a `relevance` from 0 to 1 (higher is more relevant). This endpoint is part of the Text Analysis API: Sentiment, keywords, extractive summaries, readability scores and text statistics for English text — one simple JSON call each.

Example response (200, application/json)

Success.

1{
2  "keywords": [
3    {
4      "keyword": "test and subscribe",
5      "relevance": 1
6    },
7    {
8      "keyword": "developers discover",
9      "relevance": 0.4243
10    },
11    {
12      "keyword": "APIHiver",
13      "relevance": 0.2161
14    }
15  ]
16}

Errors

  • 400 — A required parameter is missing or a value has the wrong format.
    1{
    2  "error": {
    3    "code": "INVALID_INPUT",
    4    "message": "text: Field required"
    5  }
    6}

Gateway errors (missing key, no subscription, rate limits) are listed in Error codes.