Skip to content

Get a knowledge base and its languages

GET
/knowledge-bases/{kbId}
curl --request GET \
--url https://api.motenya.app/v1/knowledge-bases/example \
--header 'Authorization: Bearer <token>'
kbId
required
string
>= 1 characters <= 64 characters

The knowledge base

Media typeapplication/json
object
id
required
string
>= 1 characters <= 64 characters
slug
required
string
defaultLanguage
required
string
languages
required
Array<object>
object
code
required
string
name
required
string
description
required
string | null
position
required
integer
enabled
required

Disabled languages are hidden on the public site; content is kept.

boolean
categoryCount
required
integer | null
articleCount
required
integer | null

Example generated

{
"id": "example",
"slug": "example",
"defaultLanguage": "example",
"languages": [
{
"code": "example",
"name": "example",
"description": "example",
"position": 1,
"enabled": true,
"categoryCount": 1,
"articleCount": 1
}
]
}

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Missing, invalid, revoked or expired API key

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Missing scope, API turned off, published article without publish scope, or account suspended

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Not found, or outside the knowledge bases this key may use

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Slug or translation already exists

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Rejected by validation (e.g. unknown language or category)

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Rate limited; see Retry-After

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Internal error