Skip to main content
POST
Create docs article

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
title
string
required
Minimum string length: 1
content
string
required

Markdown body.

Minimum string length: 1
group_id
string
required
Minimum string length: 1
summary
string
portal_instance_id
string | null

Portal instance id to assign, from GET /docs/portals. Omit to inherit the group's portal; null forces the Main (Root) portal.

published
boolean
visibility
enum<string>

Defaults to public. internal keeps the article off your docs site while the Productlane Agent still answers from it.

Available options:
public,
unlisted
icon
string

Nucleo icon name in PascalCase (e.g. FilePen). Defaults to Page2.

Required string length: 1 - 64
language
string

BCP-47 language code. When set, the article is created with the body on a translation row and the base row stays empty.

Response

Successful response

id
string
required
created_at
string
required
updated_at
string
required
title
string
required
summary
string
required
content
string
required
icon
string
required

Name of a Nucleo icon (PascalCase, e.g. Notepad, Atom). Must be a valid icon from https://nucleoapp.com - unknown names will not render in the dashboard or portal.

url_name
string
required
published
boolean
required
visibility
enum<string>
required

Unlisted articles stay off your docs site and out of portal search. The Productlane Agent answers customers from them, and never links them.

Available options:
public,
unlisted
kind
enum<string>
required

link rows point at a page you host elsewhere: content is empty and external_url holds the address.

Available options:
doc,
link
external_url
string | null
required
archived
boolean
required
show_on_home_page
boolean
required
image_url
string | null
required
group_id
string | null
required
portal_instance_id
string | null
required