Skip to main content
API docs by Redocly

Geneea Media Assistant (0.163.0)

Download OpenAPI specification:Download

editorial-tags-controller

retrieve

Authorizations:
X-API-Key
path Parameters
gkbId
required
string

Responses

update

Authorizations:
X-API-Key
path Parameters
gkbId
required
string
Request Body schema: application/json
required
gkbId
required
string

Unique identifier of the Tag in Geneea knowledge-base

name
required
string

The name of the Tag, used as default standard form

externalId
string

The ID of the Tag in the external system

forbidden
required
boolean

If true, the Tag will be ignored

object

The Tag standard forms by language

object

The Tag descriptions by language

categories
Array of strings

Any categories that the Tag belongs to

Responses

Request samples

Content type
application/json
{
  • "gkbId": "string",
  • "name": "string",
  • "externalId": "string",
  • "forbidden": true,
  • "stdForms": {
    },
  • "descriptions": {
    },
  • "categories": [
    ]
}

delete

Authorizations:
X-API-Key
path Parameters
gkbId
required
string

Responses

create

Authorizations:
X-API-Key
Request Body schema: application/json
required
gkbId
required
string

Unique identifier of the Tag in Geneea knowledge-base

name
required
string

The name of the Tag, used as default standard form

externalId
string

The ID of the Tag in the external system

forbidden
required
boolean

If true, the Tag will be ignored

object

The Tag standard forms by language

object

The Tag descriptions by language

categories
Array of strings

Any categories that the Tag belongs to

Responses

Request samples

Content type
application/json
{
  • "gkbId": "string",
  • "name": "string",
  • "externalId": "string",
  • "forbidden": true,
  • "stdForms": {
    },
  • "descriptions": {
    },
  • "categories": [
    ]
}

search_1

Authorizations:
X-API-Key
query Parameters
name
string

The name of the Tag

externalId
string

The ID of the Tag in the external system

Responses

list

Authorizations:
X-API-Key
query Parameters
returnObjects
string

If true, the full Tag objects will be returned; otherwise, just GKB IDs are returned

Responses

article-matcher-controller

getArticle

Get existing article from the index

Authorizations:
X-API-Key
path Parameters
dataset
required
string
articleId
required
string

Responses

putArticle

Add new article to the index (or update existing article)

Authorizations:
X-API-Key
path Parameters
dataset
required
string
articleId
required
string
Request Body schema: application/json
required
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

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "lead": "string",
  • "text": "string",
  • "paraSpecs": [
    ],
  • "language": "string",
  • "publishDate": "string",
  • "categories": [
    ],
  • "recommendation": {
    },
  • "metadata": {
    }
}

deleteArticle

Delete existing article from the index

Authorizations:
X-API-Key
path Parameters
dataset
required
string
articleId
required
string

Responses

recommend_1

Get a recommendation for related articles

Authorizations:
X-API-Key
path Parameters
dataset
required
string
Request Body schema: application/json
required
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.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "lead": "string",
  • "text": "string",
  • "paraSpecs": [
    ],
  • "language": "string",
  • "publishDate": "string",
  • "categories": [
    ],
  • "recommendationCount": 0,
  • "constraints": {
    },
  • "returnObjects": true,
  • "returnObjectFields": [
    ]
}

feedback_2

Submit a feedback on the recommendation results

Authorizations:
X-API-Key
path Parameters
dataset
required
string
Request Body schema: application/json
required
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

Responses

Request samples

Content type
application/json
{
  • "docId": "string",
  • "referenceKey": "string",
  • "photos": [
    ],
  • "articles": [
    ]
}

datasets_1

Get available article datasets

Authorizations:
X-API-Key

Responses

photo-matcher-controller

recommend

Authorizations:
X-API-Key
path Parameters
dataset
required
string
Request Body schema: application/json
required
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.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "lead": "string",
  • "text": "string",
  • "paraSpecs": [
    ],
  • "categories": [
    ],
  • "referenceDate": "string",
  • "language": "string",
  • "presentationLanguage": "string",
  • "recommendationCount": 0,
  • "altPhotosCount": 0,
  • "constraints": {
    },
  • "returnAltPhotos": false,
  • "returnObjects": false,
  • "returnObjectFields": [
    ],
  • "cursor": "string"
}

feedback

Authorizations:
X-API-Key
path Parameters
dataset
required
string
Request Body schema: application/json
required
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

Responses

Request samples

Content type
application/json
{
  • "docId": "string",
  • "referenceKey": "string",
  • "photos": [
    ],
  • "articles": [
    ]
}

datasets

Authorizations:
X-API-Key

Responses

nlp-controller

analyze

https://api.geneea.com/#!/geneea-api-v3/analysisPost
Authorizations:
X-API-Key
Request Body schema: application/json
required

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

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "title": "string",
  • "lead": "string",
  • "text": "string",
  • "paraSpecs": [
    ],
  • "domicile": "string",
  • "analyses": "all",
  • "language": "string",
  • "langDetectPrior": "string",
  • "presentationLanguage": "string",
  • "categories": [
    ],
  • "referenceDate": "string",
  • "returnMentions": true,
  • "returnItemSentiment": true,
  • "returnGkbProperties": true,
  • "metadata": {
    },
  • "recommendation": {
    }
}

feedback_1

Authorizations:
X-API-Key
Request Body schema: application/json
required
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

Responses

Request samples

Content type
application/json
{
  • "docId": "string",
  • "referenceKey": "string",
  • "tags": [
    ],
  • "entities": [
    ],
  • "docSentiment": {
    }
}

analyzeBatch

https://api.geneea.com/#!/geneea-api-v3/analysisBatch
Authorizations:
X-API-Key
Request Body schema: application/json
required

batch G3 request

Array
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

Responses

Request samples

Content type
application/json
[
  • {
    }
]

knowledgebase-controller

stdforms

Authorizations:
X-API-Key
Request Body schema: application/json
required
ids
required
Array of strings
language
required
string
externalSource
string

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "language": "string",
  • "externalSource": "string"
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

search

Authorizations:
X-API-Key
Request Body schema: application/json
required
query
required
string
language
required
string
fallbackLanguages
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "language": "string",
  • "fallbackLanguages": [
    ]
}

Response samples

Content type
application/json
{
  • "query": "string",
  • "hits": 0,
  • "itemDetails": [
    ]
}

redirects

Authorizations:
X-API-Key
Request Body schema: application/json
required
gkbIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "gkbIds": [
    ]
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

infoBoxes

Authorizations:
X-API-Key
Request Body schema: application/json
required
ids
required
Array of strings
language
required
string
fallbackLanguages
required
Array of strings
externalSource
string

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "language": "string",
  • "fallbackLanguages": [
    ],
  • "externalSource": "string"
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

details

Authorizations:
X-API-Key
Request Body schema: application/json
required
ids
required
Array of strings
language
required
string
fallbackLanguages
required
Array of strings
externalSource
string

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "language": "string",
  • "fallbackLanguages": [
    ],
  • "externalSource": "string"
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}