articles

Create Article

POST
Article is an object which can contain a URL or artifacts in the resource. It also contains the data regarding the owner, author, status and published date of the object. This call creates an article.

Request

This endpoint expects an object.
applies_to_parts
list of stringsRequired
The parts that the article applies to.
owned_by
list of stringsRequired
The users that own the article.
resource
objectRequired
title
stringRequired
Name of the article.
access_level
enumOptional
Allowed values: externalinternalprivatepublicrestricted
authored_by
list of stringsOptional
The authors of the article.
description
stringOptional
Description for the article.
extracted_content
list of stringsOptional
ID of the extracted content artifact.
language
stringOptional
Language of the article.
parent
stringOptional
The parent directory of the article.
published_at
datetimeOptional
The published date of the article.
shared_with
list of maps from strings to anyOptional
Information about the role the member receives due to the share.
status
enumOptional
Status of the article.
Allowed values: archiveddraftpublishedreview_needed
tags
list of objectsOptional
Tags associated with the article.

Response

This endpoint returns an object
article
object
POST
1curl -X POST https://api.devrev.ai/articles.create \
2 -H "Authorization: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "applies_to_parts": [
6 "PROD-12345"
7 ],
8 "owned_by": [
9 "DEVU-12345"
10 ],
11 "resource": {},
12 "title": "title"
13}'
200Successful
1{
2 "article": {
3 "applies_to_parts": [],
4 "id": "id",
5 "created_date": "2023-01-01T12:00:00Z",
6 "description": "description",
7 "display_id": "display_id",
8 "extracted_content": [
9 {
10 "id": "id"
11 }
12 ],
13 "modified_date": "2023-01-01T12:00:00Z",
14 "num_downvotes": 1,
15 "num_upvotes": 1,
16 "parent": {
17 "id": "id",
18 "display_id": "display_id"
19 },
20 "rank": "rank",
21 "resource": {
22 "artifacts": [
23 {
24 "id": "id"
25 }
26 ],
27 "url": "url"
28 },
29 "title": "title"
30 }
31}