Create doc article

Create a new docs article. The content supports markdown format including headings, bulleted lists, numbered lists, and other markdown features. Authentication is required.

POST /docs/articles

Create docs article

cURL

curl --request POST \
  --url https://productlane.com/api/v2/docs/articles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "content": "<string>",
  "group_id": "<string>",
  "summary": "<string>",
  "portal_instance_id": "<string>",
  "published": true,
  "icon": "<string>",
  "language": "<string>"
}
'

200

{
  "id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "title": "<string>",
  "summary": "<string>",
  "content": "<string>",
  "icon": "<string>",
  "url_name": "<string>",
  "published": true,
  "visibility": "public",
  "visibility_tier": "public",
  "kind": "doc",
  "external_url": "<string>",
  "archived": true,
  "show_on_home_page": true,
  "image_url": "<string>",
  "group_id": "<string>",
  "portal_instance_id": "<string>"
}

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. agent keeps the article off your docs site while the Productlane Agent still answers from it; internal restricts it to the AI Assistant.

Available options: public, agent, internal, 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

200

application/json

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

Whether the article is on your docs site. Deprecated: read visibility_tier for the agent and internal split.

Available options: public, unlisted

visibility_tier · enum<string> · required

agent and internal articles both stay off your docs site and out of portal search. The Productlane Agent answers customers from an agent article, and never links it. An internal article is read by the AI Assistant alone.

Available options: public, agent, internal

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