The related_story API from AYLIEN — 1 operation(s) for related_story.
openapi: 3.0.1
info:
contact:
email: support@aylien.com
name: API support
url: https://newsapi.aylien.com/
description: 'The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client.
'
termsOfService: https://newsapi.aylien.com/tos
title: AYLIEN News Absa related_story API
version: '3.0'
servers:
- url: https://api.aylien.com/news
tags:
- name: related_story
paths:
/related_stories:
description: 'This endpoint is used for finding semantically similar stories based on the parameters you provide as inputs. For example, if you want to find stories similar to a Tweet or any text extract you input, the related stories endpoint will analyze the entities present and the meaning of the text, and find stories with a similar meaning. The maximum number of related stories returned is 100.
'
summary: List related stories
parameters:
- $ref: '#/components/parameters/id'
- $ref: '#/components/parameters/notid'
- $ref: '#/components/parameters/title'
- $ref: '#/components/parameters/body'
- $ref: '#/components/parameters/text'
- $ref: '#/components/parameters/translations_en_title'
- $ref: '#/components/parameters/translations_en_body'
- $ref: '#/components/parameters/translations_en_text'
- $ref: '#/components/parameters/links_permalink'
- $ref: '#/components/parameters/notlinks_permalink'
- $ref: '#/components/parameters/language'
- $ref: '#/components/parameters/notlanguage'
- $ref: '#/components/parameters/published_at_start'
- $ref: '#/components/parameters/published_at_end'
- $ref: '#/components/parameters/categories_taxonomy'
- $ref: '#/components/parameters/categories_confident'
- $ref: '#/components/parameters/categories_id'
- $ref: '#/components/parameters/notcategories_id'
- $ref: '#/components/parameters/categories_label'
- $ref: '#/components/parameters/notcategories_label'
- $ref: '#/components/parameters/categories_level'
- $ref: '#/components/parameters/notcategories_level'
- $ref: '#/components/parameters/entities_title_id'
- $ref: '#/components/parameters/notentities_title_id'
- $ref: '#/components/parameters/entities_title_surface_forms_text'
- $ref: '#/components/parameters/notentities_title_surface_forms_text'
- $ref: '#/components/parameters/entities_title_text'
- $ref: '#/components/parameters/notentities_title_text'
- $ref: '#/components/parameters/entities_title_type'
- $ref: '#/components/parameters/notentities_title_type'
- $ref: '#/components/parameters/entities_title_stock_ticker'
- $ref: '#/components/parameters/notentities_title_stock_ticker'
- $ref: '#/components/parameters/entities_title_links_dbpedia'
- $ref: '#/components/parameters/notentities_title_links_dbpedia'
- $ref: '#/components/parameters/entities_title_links_wikipedia'
- $ref: '#/components/parameters/notentities_title_links_wikipedia'
- $ref: '#/components/parameters/entities_title_links_wikidata'
- $ref: '#/components/parameters/notentities_title_links_wikidata'
- $ref: '#/components/parameters/entities_body_id'
- $ref: '#/components/parameters/notentities_body_id'
- $ref: '#/components/parameters/entities_body_surface_forms_text'
- $ref: '#/components/parameters/notentities_body_surface_forms_text'
- $ref: '#/components/parameters/entities_body_text'
- $ref: '#/components/parameters/notentities_body_text'
- $ref: '#/components/parameters/entities_body_type'
- $ref: '#/components/parameters/notentities_body_type'
- $ref: '#/components/parameters/entities_body_stock_ticker'
- $ref: '#/components/parameters/notentities_body_stock_ticker'
- $ref: '#/components/parameters/entities_body_links_dbpedia'
- $ref: '#/components/parameters/notentities_body_links_dbpedia'
- $ref: '#/components/parameters/entities_body_links_wikipedia'
- $ref: '#/components/parameters/notentities_body_links_wikipedia'
- $ref: '#/components/parameters/entities_body_links_wikidata'
- $ref: '#/components/parameters/notentities_body_links_wikidata'
- $ref: '#/components/parameters/sentiment_title_polarity'
- $ref: '#/components/parameters/notsentiment_title_polarity'
- $ref: '#/components/parameters/sentiment_body_polarity'
- $ref: '#/components/parameters/notsentiment_body_polarity'
- $ref: '#/components/parameters/media_images_count_min'
- $ref: '#/components/parameters/media_images_count_max'
- $ref: '#/components/parameters/media_images_width_min'
- $ref: '#/components/parameters/media_images_width_max'
- $ref: '#/components/parameters/media_images_height_min'
- $ref: '#/components/parameters/media_images_height_max'
- $ref: '#/components/parameters/media_images_content_length_min'
- $ref: '#/components/parameters/media_images_content_length_max'
- $ref: '#/components/parameters/media_images_format'
- $ref: '#/components/parameters/notmedia_images_format'
- $ref: '#/components/parameters/media_videos_count_min'
- $ref: '#/components/parameters/media_videos_count_max'
- $ref: '#/components/parameters/author_id'
- $ref: '#/components/parameters/notauthor_id'
- $ref: '#/components/parameters/author_name'
- $ref: '#/components/parameters/notauthor_name'
- $ref: '#/components/parameters/source_id'
- $ref: '#/components/parameters/notsource_id'
- $ref: '#/components/parameters/source_name'
- $ref: '#/components/parameters/notsource_name'
- $ref: '#/components/parameters/source_domain'
- $ref: '#/components/parameters/notsource_domain'
- $ref: '#/components/parameters/source_locations_country'
- $ref: '#/components/parameters/notsource_locations_country'
- $ref: '#/components/parameters/source_locations_state'
- $ref: '#/components/parameters/notsource_locations_state'
- $ref: '#/components/parameters/source_locations_city'
- $ref: '#/components/parameters/notsource_locations_city'
- $ref: '#/components/parameters/source_scopes_country'
- $ref: '#/components/parameters/notsource_scopes_country'
- $ref: '#/components/parameters/source_scopes_state'
- $ref: '#/components/parameters/notsource_scopes_state'
- $ref: '#/components/parameters/source_scopes_city'
- $ref: '#/components/parameters/notsource_scopes_city'
- $ref: '#/components/parameters/source_scopes_level'
- $ref: '#/components/parameters/notsource_scopes_level'
- $ref: '#/components/parameters/source_links_in_count_min'
- $ref: '#/components/parameters/source_links_in_count_max'
- $ref: '#/components/parameters/source_rankings_alexa_rank_min'
- $ref: '#/components/parameters/source_rankings_alexa_rank_max'
- $ref: '#/components/parameters/source_rankings_alexa_country'
- $ref: '#/components/parameters/social_shares_count_facebook_min'
- $ref: '#/components/parameters/social_shares_count_facebook_max'
- $ref: '#/components/parameters/social_shares_count_google_plus_min'
- $ref: '#/components/parameters/social_shares_count_google_plus_max'
- $ref: '#/components/parameters/social_shares_count_linkedin_min'
- $ref: '#/components/parameters/social_shares_count_linkedin_max'
- $ref: '#/components/parameters/social_shares_count_reddit_min'
- $ref: '#/components/parameters/social_shares_count_reddit_max'
- $ref: '#/components/parameters/clusters'
- $ref: '#/components/parameters/return'
- $ref: '#/components/parameters/story_id'
- $ref: '#/components/parameters/story_url'
- $ref: '#/components/parameters/story_title'
- $ref: '#/components/parameters/story_body'
- description: 'This parameter is used for boosting the result by the specified value.
'
in: query
name: boost_by
schema:
enum:
- recency
- popularity
nullable: true
type: string
- $ref: '#/components/parameters/story_language'
- $ref: '#/components/parameters/per_page'
post:
tags:
- related_story
operationId: listRelatedStoriesPost
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RelatedStories'
text/xml:
schema:
$ref: '#/components/schemas/RelatedStories'
description: An object including an array of related stories
headers:
X-RateLimit-Limit:
description: The number of allowed requests in the current period.
schema:
format: int32
type: integer
X-RateLimit-Remaining:
description: The number of remaining requests in the current period.
schema:
format: int32
type: integer
X-RateLimit-Reset:
description: 'The remaining window before the rate limit resets in UTC [epoch seconds](https://en.wikipedia.org/wiki/Unix_time).
'
schema:
format: int64
type: integer
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
text/xml:
schema:
$ref: '#/components/schemas/Errors'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
text/xml:
schema:
$ref: '#/components/schemas/Errors'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
text/xml:
schema:
$ref: '#/components/schemas/Errors'
description: Unprocessable Entity
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
text/xml:
schema:
$ref: '#/components/schemas/Errors'
description: Too Many Requests
headers:
X-RateLimit-Limit:
description: The number of allowed requests in the current period.
schema:
format: int32
type: integer
X-RateLimit-Remaining:
description: The number of remaining requests in the current period.
schema:
format: int32
type: integer
X-RateLimit-Reset:
description: 'The remaining window before the rate limit resets in UTC [epoch seconds](https://en.wikipedia.org/wiki/Unix_time).
'
schema:
format: int64
type: integer
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
text/xml:
schema:
$ref: '#/components/schemas/Errors'
description: Internal Server Error
security:
- app_id: []
- app_key: []
get:
tags:
- related_story
operationId: listRelatedStoriesGet
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RelatedStories'
text/xml:
schema:
$ref: '#/components/schemas/RelatedStories'
description: An object including an array of related stories
headers:
X-RateLimit-Limit:
description: The number of allowed requests in the current period.
schema:
format: int32
type: integer
X-RateLimit-Remaining:
description: The number of remaining requests in the current period.
schema:
format: int32
type: integer
X-RateLimit-Reset:
description: 'The remaining window before the rate limit resets in UTC [epoch seconds](https://en.wikipedia.org/wiki/Unix_time).
'
schema:
format: int64
type: integer
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
text/xml:
schema:
$ref: '#/components/schemas/Errors'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
text/xml:
schema:
$ref: '#/components/schemas/Errors'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
text/xml:
schema:
$ref: '#/components/schemas/Errors'
description: Unprocessable Entity
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
text/xml:
schema:
$ref: '#/components/schemas/Errors'
description: Too Many Requests
headers:
X-RateLimit-Limit:
description: The number of allowed requests in the current period.
schema:
format: int32
type: integer
X-RateLimit-Remaining:
description: The number of remaining requests in the current period.
schema:
format: int32
type: integer
X-RateLimit-Reset:
description: 'The remaining window before the rate limit resets in UTC [epoch seconds](https://en.wikipedia.org/wiki/Unix_time).
'
schema:
format: int64
type: integer
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/Errors'
text/xml:
schema:
$ref: '#/components/schemas/Errors'
description: Internal Server Error
security:
- app_id: []
- app_key: []
components:
parameters:
source_locations_state:
description: 'This parameter is used for finding stories whose source state/province is the specified value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
'
explode: true
in: query
name: source.locations.state[]
schema:
items:
type: string
nullable: true
type: array
style: form
entities_title_surface_forms_text:
description: 'This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
'
explode: true
in: query
name: entities.title.surface_forms.text[]
schema:
items:
type: string
nullable: true
type: array
style: form
social_shares_count_linkedin_max:
description: 'This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
'
in: query
name: social_shares_count.linkedin.max
schema:
exclusiveMinimum: true
format: int32
minimum: 0
nullable: true
type: integer
notmedia_images_format:
description: 'This parameter is used for excluding stories whose images format are the specified value.
'
explode: true
in: query
name: '!media.images.format[]'
schema:
items:
enum:
- BMP
- GIF
- JPEG
- PNG
- TIFF
- PSD
- ICO
- CUR
- WEBP
- SVG
type: string
nullable: true
type: array
style: form
social_shares_count_linkedin_min:
description: 'This parameter is used for finding stories whose LinkedIn social shares count is greater than or equal to the specified value.
'
in: query
name: social_shares_count.linkedin.min
schema:
exclusiveMinimum: true
format: int32
minimum: 0
nullable: true
type: integer
social_shares_count_facebook_max:
description: 'This parameter is used for finding stories whose Facebook social shares count is less than or equal to the specified value.
'
in: query
name: social_shares_count.facebook.max
schema:
exclusiveMinimum: true
format: int32
minimum: 0
nullable: true
type: integer
entities_title_stock_ticker:
description: 'This parameter is used to find stories based on the specified entities `stock_ticker` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
'
explode: true
in: query
name: entities.title.stock_ticker[]
schema:
items:
type: string
nullable: true
type: array
style: form
source_scopes_city:
description: 'This parameter is used for finding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
'
explode: true
in: query
name: source.scopes.city[]
schema:
items:
type: string
nullable: true
type: array
style: form
notcategories_level:
description: 'This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
'
explode: true
in: query
name: '!categories.level[]'
schema:
items:
type: integer
nullable: true
type: array
style: form
notentities_title_text:
description: 'This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
'
explode: true
in: query
name: '!entities.title.text[]'
schema:
items:
type: string
nullable: true
type: array
style: form
story_language:
description: 'This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
'
in: query
name: story_language
schema:
default: auto
enum:
- auto
- en
- de
- fr
- it
- es
- pt
nullable: true
type: string
notlinks_permalink:
description: 'This parameter is used to exclude stories based on their url.
'
explode: true
in: query
name: '!links.permalink[]'
schema:
items:
type: string
nullable: true
type: array
style: form
translations_en_body:
description: 'This parameter is used for finding stories whose translation body contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
'
in: query
name: translations.en.body
schema:
nullable: true
type: string
social_shares_count_facebook_min:
description: 'This parameter is used for finding stories whose Facebook social shares count is greater than or equal to the specified value.
'
in: query
name: social_shares_count.facebook.min
schema:
exclusiveMinimum: true
format: int32
minimum: 0
nullable: true
type: integer
categories_id:
description: 'This parameter is used for finding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
'
explode: true
in: query
name: categories.id[]
schema:
items:
type: string
nullable: true
type: array
style: form
notentities_body_type:
description: 'This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
'
explode: true
in: query
name: '!entities.body.type[]'
schema:
items:
type: string
nullable: true
type: array
style: form
media_images_format:
description: 'This parameter is used for finding stories whose images format are the specified value.
'
explode: true
in: query
name: media.images.format[]
schema:
items:
enum:
- BMP
- GIF
- JPEG
- PNG
- TIFF
- PSD
- ICO
- CUR
- WEBP
- SVG
type: string
nullable: true
type: array
style: form
source_rankings_alexa_rank_min:
description: 'This parameter is used for finding stories from sources whose Alexa rank is greater than or equal to the specified value. You can read more about working with Alexa ranks [here](https://newsapi.aylien.com/docs/working-with-alexa-ranks).
'
in: query
name: source.rankings.alexa.rank.min
schema:
exclusiveMinimum: true
format: int32
minimum: 0
nullable: true
type: integer
author_name:
description: 'This parameter is used for finding stories whose author full name contains the specified value.
'
in: query
name: author.name
schema:
nullable: true
type: string
categories_label:
description: 'This parameter is used for finding stories by categories label. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
'
explode: true
in: query
name: categories.label[]
schema:
items:
type: string
nullable: true
type: array
style: form
translations_en_title:
description: 'This parameter is used for finding stories whose translation title contains a specific keyword. It supports [boolean operators](https://newsapi.aylien.com/docs/boolean-operators).
'
in: query
name: translations.en.title
schema:
nullable: true
type: string
sentiment_body_polarity:
description: 'This parameter is used for finding stories whose body sentiment is the specified value.
'
in: query
name: sentiment.body.polarity
schema:
enum:
- positive
- neutral
- negative
nullable: true
type: string
per_page:
description: 'This parameter is used for specifying number of items in each page.
'
in: query
name: per_page
schema:
default: 3
format: int32
maximum: 100
minimum: 1
nullable: true
type: integer
notentities_body_links_wikidata:
description: 'This parameter is used to exclude stories based on the specified entities Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
'
explode: true
in: query
name: '!entities.body.links.wikidata[]'
schema:
items:
type: string
nullable: true
type: array
style: form
links_permalink:
description: 'This parameter is used to find stories based on their url.
'
explode: true
in: query
name: links.permalink[]
schema:
items:
type: string
nullable: true
type: array
style: form
notentities_body_stock_ticker:
description: 'This parameter is used to exclude stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
'
explode: true
in: query
name: '!entities.body.stock_ticker[]'
schema:
items:
type: string
nullable: true
type: array
style: form
social_shares_count_google_plus_max:
description: 'This parameter is used for finding stories whose Google+ social shares count is less than or equal to the specified value.
'
in: query
name: social_shares_count.google_plus.max
schema:
exclusiveMinimum: true
format: int32
minimum: 0
nullable: true
type: integer
source_scopes_state:
description: 'This parameter is used for finding stories whose source scopes is the specified state/province value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
'
explode: true
in: query
name: source.scopes.state[]
schema:
items:
type: string
nullable: true
type: array
style: form
notentities_title_links_wikidata:
description: 'This parameter is used to exclude stories based on the specified entities Wikidata URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
'
explode: true
in: query
name: '!entities.title.links.wikidata[]'
schema:
items:
type: string
nullable: true
type: array
style: form
story_body:
description: Body of the article
in: query
name: story_body
schema:
nullable: true
type: string
notsource_scopes_city:
description: 'This parameter is used for excluding stories whose source scopes is the specified city value. [Here](https://newsapi.aylien.com/docs/working-with-locations) you can find more information about how [to work with locations](https://newsapi.aylien.com/docs/working-with-locations).
'
explode: true
in: query
name: '!source.scopes.city[]'
schema:
items:
type: string
nullable: true
type: array
style: form
notcategories_id:
description: 'This parameter is used for excluding stories by categories id. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
'
explode: true
in: query
name: '!categories.id[]'
schema:
items:
type: string
nullable: true
type: array
style: form
entities_body_links_wikipedia:
description: 'This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
'
explode: true
in: query
name: entities.body.links.wikipedia[]
schema:
items:
type: string
nullable: true
type: array
style: form
media_images_height_min:
description: 'This parameter is used for finding stories whose height of images are greater than or equal to the specified value.
'
in: query
name: media.images.height.min
schema:
exclusiveMinimum: true
format: int32
minimum: 0
nullable: true
type: integer
clusters:
description: 'This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
'
explode: true
in: query
name: clusters[]
schema:
items:
type: string
nullable: true
type: array
style: form
media_videos_count_max:
description: 'This parameter is used for finding stories whose number of videos is less than or equal to the specified value.
'
in: query
name: media.videos.count.max
schema:
exclusiveMinimum: true
format: int32
minimum: 0
nullable: true
type: integer
notlanguage:
description: 'This parameter is used for excluding stories whose language is the specified value. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
'
explode: true
in: query
name: '!language[]'
schema:
items:
enum:
- en
- de
- fr
- it
- es
- pt
type: string
nullable: true
type: array
style: form
source_links_in_count_min:
description: 'This parameter is used for finding stories from sources whose Links in count is greater than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
'
in: query
name: source.links_in_count.min
schema:
exclusiveMinimum: true
format: int32
minimum: 0
nullable: true
type: integer
source_links_in_count_max:
description: 'This parameter is used for finding stories from sources whose Links in count is less than or equal to the specified value. You can read more about working with Links in count [here](https://newsapi.aylien.com/docs/working-with-links-in-count).
'
in: query
name: source.links_in_count.max
schema:
exclusiveMinimum: true
format: int32
minimum: 0
nullable: true
type: integer
notsentiment_title_polarity:
description: 'This parameter is used for excluding stories whose title sentiment is the specified value.
'
in: query
name: '!sentiment.title.polarity'
schema:
enum:
- positive
- neutral
- negative
nullable: true
type: string
notentities_body_surface_forms_text:
description: 'This parameter is used to exclude stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
'
explode: true
in: query
name: '!entities.body.surface_forms.text[]'
schema:
items:
type: string
nullable: true
type: array
style: form
entities_body_id:
description: 'This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
'
explode: true
in: query
name: entities.body.id[]
schema:
items:
type: string
nullable: true
type: array
style: form
media_images_count_min:
description: 'This parameter is used for finding stories whose number of images is greater than or equal to the specified value.
'
in: query
name: media.images.count.min
schema:
exclusiveMinimum: true
format: int32
minimum: 0
nullable: true
type: integer
notentities_title_type:
description: 'This parameter is used to exclude stories based on the specified entities `type` in story titles. Yo
# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aylien/refs/heads/main/openapi/aylien-related-story-api-openapi.yml