Articles

Get an Article by ID and language

Property	Description
Method	`GET`
Path	`/open/v1/spaces/$me/articles/{articleId}`
Accept	-
Content-Type	`application/json`
Description	Retrieves an article from its current revision in the requested language by article ID and language.

Request
- Query
  
  Param Required? Default Type Description Example
  language O - string Requested language ko
- Body
```
// (empty)
```

Param	Required?	Default	Type	Description	Example
language	O	-	string	Requested language	ko

Response

type ArticleView = {
  article: Article
  articleCategory?: {
    articleId: string
    category: Category
  }
  author: Author
  topics: Topic[]
}

Get an Article by Slug and language

Property	Description
Method	`GET`
Path	`/open/v1/spaces/$me/articles/${slug}`
Accept	-
Content-Type	`application/json`
Description	Retrieves an article from its current revision in the requested language by article slug and language.

Request
- Query
  
  Param Required? Default Type Description Example
  language O - string Requested language ko
- Body
```
// (empty)
```

Param	Required?	Default	Type	Description	Example
language	O	-	string	Requested language	ko

Response

type ArticleView = {
  article: Article
  articleCategory?: {
    articleId: string
    category: Category
  }
  author: Author
  topics: Topic[]
}

Batch Get Articles by IDs and language

Property	Description
Method	`GET`
Path	`/open/v1/spaces/$me/articles/batch`
Accept	-
Content-Type	`application/json`
Description	Retrieves multiple articles and its current revision in the requested language by article IDs and a language. Can fetch up to 25 articles.

Request
- Query
  
  Param Required? Default Type Description Example
  ids[] O - string[] IDs of articles to fetch. ?ids[]=42&ids[]=37
  language O - string Requested language ko
- Body
```
// (empty)
```

Param	Required?	Default	Type	Description	Example
ids[]	O	-	string[]	IDs of articles to fetch.	?ids[]=42&ids[]=37
language	O	-	string	Requested language	ko

Response

type ArticlesView = {
  articles: Article[]
  articleCategory: {
    articleId: string
    category: Category
  }[]
  authors: Author[]
  topics: Topic[]
}

List Articles of a Space

Property	Description
Method	`GET`
Path	`/open/v1/spaces/$me/articles`
Accept	-
Content-Type	`application/json`
Description	Retrieves a paginated list of articles in a space ordered by update timestamp.

Request
- Query
  
  Param Required? Default Type Description Example
  language O - string Requested language ko
  limit X 25 number Used for pagination 25
  since X string Used for pagination 1707017182188
  order X asc ‘asc’ | 'desc' Sort order asc
- Body
```
// (empty)
```

Param	Required?	Default	Type	Description	Example
language	O	-	string	Requested language	ko
limit	X	25	number	Used for pagination	25
since	X		string	Used for pagination	1707017182188
order	X	asc	‘asc’ \| 'desc'	Sort order	asc

Response

type ArticlesListView = {
  articles: Article[]
  articleCategory: {
    articleId: string
    category: Category
  }[]
  authors: Author[]
  topics: Topic[]
  next?: string
}