POST
/
api
/
search_similar
Search similar articles
curl --request POST \
  --url https://v3-api.newscatcherapi.com/api/search_similar \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '{
  "q": "artificial intelligence",
  "include_similar_documents": true,
  "similar_documents_number": 5
}'
{
  "status": "<string>",
  "total_hits": 123,
  "page": 123,
  "total_pages": 123,
  "page_size": 123,
  "articles": [],
  "user_input": {}
}

Authorizations

​
x-api-token
string
header
required

API Key to authenticate requests.

To access the API, include your API key in the x-api-token header. To obtain your API key, complete the form or contact us directly.

Body

application/json

Request body for searching similar articles based on specified criteria such as query, language, country, source, and more.

The body is of type object.

Response

200
application/json

A successful response containing articles similar to the specified query. If no matches, returns a failed search response according to the defined schema.

The response model for a successful Search similar request. Response field behavior:

  • Required fields are guaranteed to be present and non-null.
  • Optional fields may be null or undefined if the data point is not presented or couldn't be extracted during processing.
  • To access article properties in the articles response array, use array index notation. For example, articles[n].title, where n is the zero-based index of the article object (0, 1, 2, etc.).
  • The nlp property within the article object articles[n].nlp is only available with NLP-enabled subscription plans.

The base response model containing common fields for search operations.