Download OpenAPI specification:Download
Add new article to the index (or update existing article)
| dataset required | string |
| articleId required | string |
| id required | string Unique identifier of the article. |
| title | string The title or subject of the article, when available; mutually exclusive with the 'paraSpecs' parameter |
| lead | string The lead or abstract of the article, when available; mutually exclusive with the 'paraSpecs' parameter |
| text | string The main text or body of the article; mutually exclusive with the 'paraSpecs' parameter |
Array of objects (ParaSpec) The article paragraphs; mutually exclusive with 'title', 'lead', and 'text' parameters | |
| language | string The language of the article as ISO 639-1 |
| publishDate | string Date when the article was published, in ISO format, e.g. "2025-01-01T12:00:00Z" |
Array of objects (Category) The categories of the article | |
object (Recommendation) Recommendation info for the document | |
object Any additional metadata for the article |
{- "id": "string",
- "title": "string",
- "lead": "string",
- "text": "string",
- "paraSpecs": [
- {
- "type": "string",
- "text": "string"
}
], - "language": "string",
- "publishDate": "string",
- "categories": [
- {
- "taxonomy": "SubjectCode",
- "code": "string"
}
], - "recommendation": {
- "published": true,
- "status": "ALWAYS",
- "url": "string",
- "imageUrl": "string",
- "publishDate": "string",
- "expireDate": "string",
- "type": "string",
- "importance": 0,
- "breakingNews": true
}, - "metadata": {
- "property1": "string",
- "property2": "string"
}
}Get a recommendation for related articles
| dataset required | string |
| id required | string Unique identifier of the article. |
| title | string The title or subject of the article, when available; mutually exclusive with the 'paraSpecs' parameter |
| lead | string The lead or abstract of the article, when available; mutually exclusive with the 'paraSpecs' parameter |
| text | string The main text or body of the article; mutually exclusive with the 'paraSpecs' parameter |
Array of objects (ParaSpec) The article paragraphs; mutually exclusive with 'title', 'lead', and 'text' parameters | |
| language | string The language of the article as ISO 639-1 |
| publishDate | string Date when the article was published, in ISO format, e.g. "2025-01-01T12:00:00Z" |
Array of objects (Category) The categories of the article | |
| recommendationCount | integer <int32> The number of articles to recommend. |
object (ArticleConstraints) The constraints on the article properties to narrow down the recommendation results. | |
| returnObjects | boolean Return article objects in addition to the article IDs in the recommendation results. |
| returnObjectFields | Array of strings The list of article fields that should be returned in the article object. This is ignored if 'returnObjects' is not set to true. The article ID field is always returned, even if it is not mentioned in 'returnObjectFields'. If 'returnObjectFields' is not specified then all article fields are returned. |
{- "id": "string",
- "title": "string",
- "lead": "string",
- "text": "string",
- "paraSpecs": [
- {
- "type": "string",
- "text": "string"
}
], - "language": "string",
- "publishDate": "string",
- "categories": [
- {
- "taxonomy": "SubjectCode",
- "code": "string"
}
], - "recommendationCount": 0,
- "constraints": {
- "dateStartAt": "string",
- "dateEndAt": "string",
- "categoriesAnyOf": [
- {
- "taxonomy": "SubjectCode",
- "code": "string"
}
], - "categoriesNoneOf": [
- {
- "taxonomy": "SubjectCode",
- "code": "string"
}
]
}, - "returnObjects": true,
- "returnObjectFields": [
- "string"
]
}Submit a feedback on the recommendation results
| dataset required | string |
| docId required | string Unique identifier of the document |
| referenceKey | string A reference key to identify a particular recommendation result |
Array of objects (RecommendFeedbackItem) Feedback on the results for recommended Photos | |
Array of objects (RecommendFeedbackItem) Feedback on the results for recommended Articles |
{- "docId": "string",
- "referenceKey": "string",
- "photos": [
- {
- "id": "string",
- "status": "string",
- "author": "string",
- "comment": "string"
}
], - "articles": [
- {
- "id": "string",
- "status": "string",
- "author": "string",
- "comment": "string"
}
]
}| dataset required | string |
| id required | string Unique identifier of the article. |
| title | string The title or subject of the article, when available; mutually exclusive with the 'paraSpecs' parameter |
| lead | string The lead or abstract of the article, when available; mutually exclusive with the 'paraSpecs' parameter |
| text | string The main text or body of the article; mutually exclusive with the 'paraSpecs' parameter |
Array of objects (ParaSpec) The article paragraphs; mutually exclusive with 'title', 'lead' and 'text' parameters | |
Array of objects (Category) The categories of the article | |
| referenceDate | string Date to be used for the analysis as a reference; values: "NOW" or in format YYYY-MM-DD |
| language | string The language of the article |
| presentationLanguage | string The presentation language of the results |
| recommendationCount | integer <int32> The number of photographs to recommend. |
| altPhotosCount | integer <int32> Maximum number of photo alternatives to return per recommended photograph. |
object (PhotoConstraints) The constraints and restrictions on the photo properties to narrow down the photos recommendation results. | |
| returnAltPhotos | boolean Default: false Return photo alternatives, when available, for the recommended photographs. |
| returnObjects | boolean Default: false Return PhotoData objects in addition to the photo IDs for the recommended photographs. |
| returnObjectFields | Array of strings The list of photo fields that should be returned in the 'PhototData' object. This is ignored if 'returnObjects' is not set to true. The photo ID field is always returned, even if it is not mentioned in 'returnObjectFields'. If 'returnObjectFields' is not specified then all photo fields are returned. |
| cursor | string Enables pagination. If cursor parameter is missing the pagination is disabled. To enable pagination set the value to '*'. To retrieve the next page use nextCursor from the previous result. Make sure to not change other parameters in pagination request. |
{- "id": "string",
- "title": "string",
- "lead": "string",
- "text": "string",
- "paraSpecs": [
- {
- "type": "string",
- "text": "string"
}
], - "categories": [
- {
- "taxonomy": "SubjectCode",
- "code": "string"
}
], - "referenceDate": "string",
- "language": "string",
- "presentationLanguage": "string",
- "recommendationCount": 0,
- "altPhotosCount": 0,
- "constraints": {
- "likePhotoId": "string",
- "dateBefore": "string",
- "dateAfter": "string",
- "tags": {
- "anyOf": [
- {
- "type": "Geneea",
- "value": "G213"
}
], - "allOf": [
- {
- "type": "Geneea",
- "value": "G213"
}
], - "noneOf": [
- {
- "type": "Geneea",
- "value": "G213"
}
], - "ignore": [
- {
- "type": "Geneea",
- "value": "G213"
}
]
}, - "category": {
- "anyOf": [
- {
- "taxonomy": "SubjectCode",
- "code": "string"
}
], - "allOf": [
- {
- "taxonomy": "SubjectCode",
- "code": "string"
}
], - "noneOf": [
- {
- "taxonomy": "SubjectCode",
- "code": "string"
}
], - "ignore": [
- {
- "taxonomy": "SubjectCode",
- "code": "string"
}
]
}, - "orientation": {
- "anyOf": [
- "string"
], - "allOf": [
- "string"
], - "noneOf": [
- "string"
], - "ignore": [
- "string"
]
}
}, - "returnAltPhotos": false,
- "returnObjects": false,
- "returnObjectFields": [
- "string"
], - "cursor": "string"
}| dataset required | string |
| docId required | string Unique identifier of the document |
| referenceKey | string A reference key to identify a particular recommendation result |
Array of objects (RecommendFeedbackItem) Feedback on the results for recommended Photos | |
Array of objects (RecommendFeedbackItem) Feedback on the results for recommended Articles |
{- "docId": "string",
- "referenceKey": "string",
- "photos": [
- {
- "id": "string",
- "status": "string",
- "author": "string",
- "comment": "string"
}
], - "articles": [
- {
- "id": "string",
- "status": "string",
- "author": "string",
- "comment": "string"
}
]
}G3 request
| id required | string Unique identifier of the document |
| title | string The title or subject of the document, when available; mutually exclusive with the 'paraSpecs' parameter |
| lead | string The lead or abstract of the document, when available; mutually exclusive with the 'paraSpecs' parameter |
| text | string The main text or body of the document; mutually exclusive with the 'paraSpecs' parameter |
Array of objects (ParaSpec) The document paragraphs; mutually exclusive with 'title', 'lead' and 'text' parameters | |
| domicile | string A domicile indicating the origin location of the document |
| analyses | Array of strings Items Enum: "all" "entities" "tags" "relations" "sentiment" "language" [option] What analysis to return. Default: all |
| language | string [option] The language of the document as ISO 639-1; auto-detection will be used if omitted |
| langDetectPrior | string [option] The language detection prior; e.g. 'de,en' |
| presentationLanguage | string [option] The presentation language of the results |
Array of objects (Category) [option] The categories of the article | |
| referenceDate | string [option] Date to be used for the analysis as a reference, optionally with time; values: "NOW" or in ISO format |
| returnMentions | boolean [option] Should entity/tag/relation mentions be returned? Default: false |
| returnItemSentiment | boolean [option] Should entity/mention/tag/relation etc. sentiment be returned? Default: false |
| returnGkbProperties | boolean [option] Should entity/tag GKB properties be returned? Default: false |
object Any additional metadata for the document, e.g. domicile or URL | |
object (Recommendation) Recommendation info for the document |
{- "id": "string",
- "title": "string",
- "lead": "string",
- "text": "string",
- "paraSpecs": [
- {
- "type": "string",
- "text": "string"
}
], - "domicile": "string",
- "analyses": "all",
- "language": "string",
- "langDetectPrior": "string",
- "presentationLanguage": "string",
- "categories": [
- {
- "taxonomy": "SubjectCode",
- "code": "string"
}
], - "referenceDate": "string",
- "returnMentions": true,
- "returnItemSentiment": true,
- "returnGkbProperties": true,
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "recommendation": {
- "published": true,
- "status": "ALWAYS",
- "url": "string",
- "imageUrl": "string",
- "publishDate": "string",
- "expireDate": "string",
- "type": "string",
- "importance": 0,
- "breakingNews": true
}
}| docId required | string Unique identifier of the document |
| referenceKey | string A reference key to identify a particular NLP analysis result (i.e. the value from '.metadata.referenceKey') |
Array of objects (AnalyzeFeedbackItem) Feedback on the results for Tags | |
Array of objects (AnalyzeFeedbackItem) Feedback on the results for Entities | |
object (AnalyzeFeedbackSentiment) Feedback for sentiment analysis |
{- "docId": "string",
- "referenceKey": "string",
- "tags": [
- {
- "gkbId": "string",
- "stdForm": "string",
- "status": "string",
- "author": "string",
- "comment": "string"
}
], - "entities": [
- {
- "gkbId": "string",
- "stdForm": "string",
- "status": "string",
- "author": "string",
- "comment": "string"
}
], - "docSentiment": {
- "label": "string",
- "status": "string",
- "author": "string",
- "comment": "string"
}
}batch G3 request
| id required | string Unique identifier of the document |
| title | string The title or subject of the document, when available; mutually exclusive with the 'paraSpecs' parameter |
| lead | string The lead or abstract of the document, when available; mutually exclusive with the 'paraSpecs' parameter |
| text | string The main text or body of the document; mutually exclusive with the 'paraSpecs' parameter |
Array of objects (ParaSpec) The document paragraphs; mutually exclusive with 'title', 'lead' and 'text' parameters | |
| domicile | string A domicile indicating the origin location of the document |
| analyses | Array of strings Items Enum: "all" "entities" "tags" "relations" "sentiment" "language" [option] What analysis to return. Default: all |
| language | string [option] The language of the document as ISO 639-1; auto-detection will be used if omitted |
| langDetectPrior | string [option] The language detection prior; e.g. 'de,en' |
| presentationLanguage | string [option] The presentation language of the results |
Array of objects (Category) [option] The categories of the article | |
| referenceDate | string [option] Date to be used for the analysis as a reference, optionally with time; values: "NOW" or in ISO format |
| returnMentions | boolean [option] Should entity/tag/relation mentions be returned? Default: false |
| returnItemSentiment | boolean [option] Should entity/mention/tag/relation etc. sentiment be returned? Default: false |
| returnGkbProperties | boolean [option] Should entity/tag GKB properties be returned? Default: false |
object Any additional metadata for the document, e.g. domicile or URL | |
object (Recommendation) Recommendation info for the document |
[- {
- "id": "string",
- "title": "string",
- "lead": "string",
- "text": "string",
- "paraSpecs": [
- {
- "type": "string",
- "text": "string"
}
], - "domicile": "string",
- "analyses": "all",
- "language": "string",
- "langDetectPrior": "string",
- "presentationLanguage": "string",
- "categories": [
- {
- "taxonomy": "SubjectCode",
- "code": "string"
}
], - "referenceDate": "string",
- "returnMentions": true,
- "returnItemSentiment": true,
- "returnGkbProperties": true,
- "metadata": {
- "property1": "string",
- "property2": "string"
}, - "recommendation": {
- "published": true,
- "status": "ALWAYS",
- "url": "string",
- "imageUrl": "string",
- "publishDate": "string",
- "expireDate": "string",
- "type": "string",
- "importance": 0,
- "breakingNews": true
}
}
]| ids required | Array of strings |
| language required | string |
| externalSource | string |
{- "ids": [
- "string"
], - "language": "string",
- "externalSource": "string"
}{- "property1": {
- "value": "string",
- "language": "string"
}, - "property2": {
- "value": "string",
- "language": "string"
}
}| query required | string |
| language required | string |
| fallbackLanguages required | Array of strings |
{- "query": "string",
- "language": "string",
- "fallbackLanguages": [
- "string"
]
}{- "query": "string",
- "hits": 0,
- "itemDetails": [
- {
- "gkbId": "string",
- "stdForm": {
- "value": "string",
- "language": "string"
}, - "description": {
- "value": "string",
- "language": "string"
}, - "type": "string",
- "subtypes": [
- "string"
], - "externalIds": {
- "property1": "string",
- "property2": "string"
}, - "externalLinks": {
- "property1": "string",
- "property2": "string"
}
}
]
}| gkbIds required | Array of strings |
{- "gkbIds": [
- "string"
]
}{- "property1": {
- "status": "string",
- "replacedBy": "string",
- "replaces": [
- "string"
]
}, - "property2": {
- "status": "string",
- "replacedBy": "string",
- "replaces": [
- "string"
]
}
}| ids required | Array of strings |
| language required | string |
| fallbackLanguages required | Array of strings |
| externalSource | string |
{- "ids": [
- "string"
], - "language": "string",
- "fallbackLanguages": [
- "string"
], - "externalSource": "string"
}{- "property1": {
- "value": {
- "title": "string",
- "header": "string",
- "body": "string",
- "footer": {
- "property1": "string",
- "property2": "string"
}
}, - "language": "string"
}, - "property2": {
- "value": {
- "title": "string",
- "header": "string",
- "body": "string",
- "footer": {
- "property1": "string",
- "property2": "string"
}
}, - "language": "string"
}
}| ids required | Array of strings |
| language required | string |
| fallbackLanguages required | Array of strings |
| externalSource | string |
{- "ids": [
- "string"
], - "language": "string",
- "fallbackLanguages": [
- "string"
], - "externalSource": "string"
}{- "property1": {
- "gkbId": "string",
- "stdForm": {
- "value": "string",
- "language": "string"
}, - "description": {
- "value": "string",
- "language": "string"
}, - "type": "string",
- "subtypes": [
- "string"
], - "externalIds": {
- "property1": "string",
- "property2": "string"
}, - "externalLinks": {
- "property1": "string",
- "property2": "string"
}
}, - "property2": {
- "gkbId": "string",
- "stdForm": {
- "value": "string",
- "language": "string"
}, - "description": {
- "value": "string",
- "language": "string"
}, - "type": "string",
- "subtypes": [
- "string"
], - "externalIds": {
- "property1": "string",
- "property2": "string"
}, - "externalLinks": {
- "property1": "string",
- "property2": "string"
}
}
}Usage reporting.
| metric | string Value: "nlp-analyze-requests" Metric to get the usage for |
| granularity | string Enum: "month" "day" Granularity for the usage metric. |
| sinceDate | string Time range start, date in ISO format, e.g. "2025-01-01". |
| untilDate | string Time range end, date in ISO format, e.g. "2025-12-31". |
{- "metric": "nlp-analyze-requests",
- "granularity": "month",
- "sinceDate": "string",
- "untilDate": "string",
- "totalUsage": 0,
- "usageByPeriod": [
- {
- "period": "string",
- "usage": 0
}
]
}