Media API: Reference
Authorization
All requests to the REST API must include an X-API-Key HTTP header with a valid API key.
Functions
The Media API V2 provides multiple categories of endpoints:
- NLP – Semantic analysis of articles: extract tags, entities, sentiment, etc.
- Knowledge Base – Endpoints returning real-world information about tags and entities.
- Editorial Tags – Management of customer-specific topic tags.
- Article Recommender – Endpoints recommending related articles.
- Photo Recommender – Endpoints recommending photos for articles.
The table below lists all endpoints, grouped by category.
| Endpoint | Description | |
|---|---|---|
| Request | 200 Response | |
| NLP: Semantic analysis of articles | ||
POST /v2/nlp/analyze | Analyzes an article and returns tags, entities, sentiment, and more. | |
| NlpRequest | Analysis (same as G3 response) | |
POST /v2/nlp/analyze/feedback | Sends feedback on a specific analysis result. | |
| AnalyzeFeedback | ||
| Knowledge base: Endpoints returning real-world information about tags and entities | ||
POST /v2/knowledgebase/details | Retrieves detailed information about tags and entities. | |
| GkbItemsInfoRequest | Map[string, Details] | |
POST /v2/knowledgebase/infoboxes | Retrieves information about tags and entities optimized for UI display. | |
| GkbItemsInfoRequest | Map[string, LangValueInfoBox] | |
POST /v2/knowledgebase/redirects | Returns replacements for deprecated knowledge base entities. | |
| GkbItemsRedirectsRequest | List[Redirects] | |
POST /v2/knowledgebase/search | Searches the knowledge base for entities. | |
| GkbItemsSearchRequest | List[SearchResults] | |
POST /v2/knowledgebase/stdforms | Retrieves standard forms of tags and entities for a given language. | |
| GkbItemsStdFormRequest | Map[string, LangValueString] | |
| Editorial Tags: Management of customer-specific topic tags | ||
POST /v2/customize/editorial_tag/create | Creates a new editorial tag. | |
| EditorialTag | EditorialTag | |
GET /v2/customize/editorial_tag/list | Returns a list of all existing editorial tags. | |
| EditorialTagListResponse | ||
GET /v2/customize/editorial_tag/search | Searches for editorial tags by name or ID. | |
| EditorialTagSearchResponse | ||
GET /v2/customize/editorial_tag/{gkbId} | Retrieves a specific editorial tag by its GKB ID. | |
| EditorialTag | ||
PUT /v2/customize/editorial_tag/{gkbId} | Updates a specific editorial tag. | |
| EditorialTag | EditorialTag | |
DELETE /v2/customize/editorial_tag/{gkbId} | Deletes a specific editorial tag. | |
| Article Recommender: Endpoints recommending related articles | ||
GET /v2/articles | Lists available article datasets. | |
| List[string] | ||
GET /v2/articles/{dataset}/{art_id} | Retrieves or deletes an article from an index. | |
| Article | ||
PUT /v2/articles/{dataset}/{art_id} | Adds or updates an article in an index. | |
| Article | Message | |
DELETE /v2/articles/{dataset}/{art_id} | Deletes an article from an index. | |
| Message | ||
POST /v2/articles/{dataset}/recommend | Recommends related articles for a given article. | |
| RecommendArticles | ArticlesResponse | |
POST /v2/articles/{dataset}/recommend/feedback | Sends feedback on a specific article recommendation. | |
| RecommendArticlesFeedback | Message | |
| Photo Recommender: Endpoints recommending photos for articles | ||
GET /v2/photos | Lists supported photo banks. | |
| List[string] | ||
POST /v2/photos/{dataset}/recommend | Recommends photos for a given article. | |
| PhotosRequest | PhotosRecommendation | |
POST /v2/photos/{dataset}/recommend/feedback | Sends feedback on a specific photo recommendation. | |
| RecommendFeedback | ||
See the Swagger documentation for full technical details.