Create Article
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.
All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request.
How do I find my token?
In: header
"external" | "internal" | "private" | "public" | "restricted"The aliases of the article.
items <= 5The parts that the article applies to.
Type of the article.
"article" | "content_block" | "page"The authors of the article.
The brand associated with the article.
idContent format of the article.
"drdfv2" | "rt"Application-defined custom fields.
Empty Object
Custom schemas described using identifiers. Each custom field in the request must have the corresponding schema specified; omission results in a Bad Request error. If a custom schema is not included in the specifier, it remains unchanged. For surfaces with human interactors, it is recommended to provide tenant_fragment: true and validate_required_fields: true.
Data sources provide the backing data for the article.
Description for the article.
textID of the extracted content artifact.
Language of the article.
textWhether to notify the users when the article is published.
The users that own the article.
The parent directory of the article.
idThe published date of the article.
date-timeThe release notes of the article.
textThe scope of the article.
int64Information about the role the member receives due to the share.
Status of the article.
"archived" | "draft" | "published" | "review_needed"Tags associated with the article.
Name of the article.
textResponse Body
curl -X POST "https://api.devrev.ai/articles.create" \ -H "Content-Type: application/json" \ -d '{ "owned_by": [ "DEVU-12345" ], "resource": {}, "title": "string" }'{
"article": {
"created_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"created_date": "2023-01-01T12:00:00.000Z",
"display_id": "string",
"id": "string",
"modified_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"modified_date": "2023-01-01T12:00:00.000Z",
"applies_to_parts": [
{
"type": "capability",
"display_id": "string",
"id": "string",
"name": "string",
"owned_by": [
{
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
}
]
}
],
"article_type": "article",
"authored_by": [
{
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
}
],
"description": "string",
"extracted_content": [
{
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
}
],
"num_downvotes": 0,
"num_upvotes": 0,
"owned_by": [
{
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
}
],
"parent": {
"display_id": "string",
"id": "string"
},
"rank": "string",
"resource": {
"artifacts": [
{
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
}
],
"url": "string"
},
"scope": {
"id": 0,
"label": "string",
"ordinal": 0,
"value": null
},
"title": "string"
}
}{
"detail": "string",
"message": "string",
"type": "artifact_already_attached_to_a_parent",
"existing_parent": "string",
"is_same": true
}{
"detail": "string",
"message": "string",
"type": "unauthenticated"
}{
"detail": "string",
"message": "string",
"type": "forbidden"
}{
"detail": "string",
"message": "string",
"type": "too_many_requests",
"retry_after": 0
}{
"detail": "string",
"message": "string",
"type": "internal_error",
"reference_id": "string"
}{
"detail": "string",
"message": "string",
"type": "service_unavailable"
}