Create an article
Example request
Generated- cURL
- JavaScript
- TypeScript
- Python
- PHP
- Go
- Java
- Ruby
- C#
Responses
Authentication
-
-
ApiKeyBearerhttpbearerAn API key sent as
Authorization: Bearer <key>. A key holds scopes, the same ones OAuth uses, and an operation needs the scope listed for it under OAuth2. A key may also expire, or be revoked or rotated in Settings > API, after which it is refused with a 401.
-
-
-
OAuth2oauth2An OAuth 2.0 access token for an app acting on behalf of a HelpDocs user, sent as
Authorization: Bearer <token>. The authorization code flow requires PKCE (S256). Each operation names the one scope it needs.
-
Query parameters
-
from_filebooleanCreate the article from an uploaded file instead of a JSON body. The body is then a multipart upload rather than the schema below.
Request body Required
The article to create.
application/json
CreateArticleRequest
-
user_idstring -
category_idstring -
show_tocboolean -
is_privateboolean -
is_publishedboolean -
is_featuredboolean -
iconstring -
sourcestring -
permission_groupsarray of string NullableNull is the same as leaving the field out.
-
language_codestring -
titlestring -
descriptionstring -
short_versionstring -
bodystring -
slugstring -
tagsarray of string NullableNull is the same as leaving the field out.
-
is_liveboolean -
editor_typestring -
Null is the same as leaving the field out.
{
"user_id": "string",
"category_id": "string",
"show_toc": true,
"is_private": true,
"is_published": true,
"is_featured": true,
"icon": "string",
"source": "string",
"permission_groups": [
"string"
],
"language_code": "string",
"title": "string",
"description": "string",
"short_version": "string",
"body": "string",
"slug": "string",
"tags": [
"string"
],
"is_live": true,
"editor_type": "string",
"multilingual": [
{
"language_code": "string",
"title": "string",
"description": "string",
"short_version": "string",
"body": "string",
"slug": "string",
"tags": [
"string"
],
"is_live": true,
"editor_type": "string"
}
]
}
Generated from the schema
Responses
The created article.
application/json
ArticleResponse
The request was rejected: a required field is missing from the body, or a value in it is not acceptable.
text/plain
The failure, as a human-readable message.
-
string
The failure, as a human-readable message.
Authentication failed or no API key was supplied.
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.
The account’s billing is past due and writes are locked. Reads keep working; editing resumes once billing is settled.
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.
The key lacks write permission, or the account’s plan does not include API access.
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.
Rate limited. Wait the number of seconds in Retry-After before trying again. X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset say which allowance was spent and when it refills.
-
Retry-Afterinteger -
X-RateLimit-Limitinteger -
X-RateLimit-Remaininginteger -
X-RateLimit-Resetinteger
application/json
Error
An error response.
-
codeinteger RequiredThe HTTP status code.
-
errstring RequiredA human-readable description of the failure.