API Reference

Authorization

All requests to the REST API need to have an X-API-Key header.

Functions

The Media API V2 offers several types of endpoints:

• NLP: Semantic analysis of articles
• Knowledge base: Endpoints returning real-world information about tags and entities
• Editorial Tags: Configuration of customer-specific topic tags
• Article Recommender: Endpoints recommending related articles for articles
• Photo Recommender: Endpoints recommending photos for articles

The table below summarizes individual endpoints for each category.

Endpoint	Description
	Request	200 Response
NLP: Semantic analysis of articles
POST /v2/nlp/analyze	Semantic analysis of an article returning tags, entities, sentiment, etc.
	NlpRequest	Analysis (same as G3 response)
POST /v2/nlp/analyze/feedback	Feedback on a particular analysis
	AnalyzeFeedback
Knowledge base: Endpoints returning real-world information about tags and entities
POST /v2/knowledgebase/details	Information about tags and entities
	GkbItemsInfoRequest	Map[string, Details]
POST /v2/knowledgebase/infoboxes	Information about tags and entities optimized for UI display
	GkbItemsInfoRequest	Map[string, LangValueInfoBox]
POST /v2/knowledgebase/redirects	Replacements for deprecated knowledge base entities
	GkbItemsRedirectsRequest	List[Redirects]
POST /v2/knowledgebase/search	Searching knowledge base for entities
	GkbItemsSearchRequest	List[SearchResults]
POST /v2/knowledgebase/stdforms	Standard forms of tags and entities in a particular language
	GkbItemsStdFormRequest	Map[string, LangValueString]
Editorial Tags: Configuration of customer-specific topic tags
POST /v2/customize/editorial_tag/create	Creating a new editorial tag
	EditorialTag	EditorialTag
GET /v2/customize/editorial_tag/list	List of all existing editorial tags
		EditorialTagListResponse
GET /v2/customize/editorial_tag/search	Searching for editorial tags by their name or ID
		EditorialTagSearchResponse
GET /v2/customize/editorial_tag/{gkbId}	Get, update or delete a particular editorial tag
		EditorialTag
PUT /v2/customize/editorial_tag/{gkbId}	Get, update or delete a particular editorial tag
	EditorialTag	EditorialTag
DELETE /v2/customize/editorial_tag/{gkbId}	Get, update or delete a particular editorial tag
Article Recommender: Endpoints recommending related articles for articles
GET /v2/articles	Available article datasets
		List[string]
GET /v2/articles/{dataset}/{art_id}	Adding, getting, or deleting an article to/from an index
		Article
PUT /v2/articles/{dataset}/{art_id}	Adding, getting, or deleting an article to/from an index
	Article	Message
DELETE /v2/articles/{dataset}/{art_id}	Adding, getting, or deleting an article to/from an index
		Message
POST /v2/articles/{dataset}/recommend	Recommend articles for an article
	RecommendArticles	ArticlesResponse
POST /v2/articles/{dataset}/recommend/feedback	Feedback on a particular recommendation
	RecommendArticlesFeedback	Message
Photo Recommender: Endpoints recommending photos for articles
GET /v2/photos	Supported photo banks
		List[string]
POST /v2/photos/{dataset}/recommend	Recommend photos for an article
	PhotosRequest	PhotosRecommendation
POST /v2/photos/{dataset}/recommend/feedback	Feedback on a particular recommendation
	RecommendFeedback

See Swagger documentation for more technical info.