Articles

An article is a single page of content in your knowledge base. For fields and response details, see the API reference. Every command that takes an article ID accepts the article’s slug, its permalink identifier (a-XXXXXXXX), or its UUID. See Getting an article ID.

List articles

This command lists published articles by default; pass --state all to include drafts. Use this when you want to review what exists, filter by category or state, or collect IDs for another command.

neetokb articles list
neetokb articles list --state draft
neetokb articles list --state all --sort-by updated_at --order-by asc
neetokb articles list --category-id b7e91c2a-8f43-4d0e-9a15-6c2d8e7f1b3a

Flag	Type	Default	Description
`--category-id`	`string`		Filter by category ID
`--order-by`	`string`		Sort order: asc or desc
`--page`	`int`	`0`	Page number
`--page-size`	`int`	`0`	Items per page (max 100)
`--search-term`	`string`		Search term
`--sort-by`	`string`		Sort field: title, slug, state, category_name, views_count, created_at, updated_at
`--state`	`string`		Filter by state: draft, published, archived or all (default: published)

Sample output (--json)

{
  "data": [
    {
      "id": "a1b2c3d4-1111-2222-3333-444455556666",
      "slug": "getting-started",
      "title": "Getting Started Guide",
      "state": "published",
      "permalink_identifier": "a-84af178b",
      "author": {
        "id": "aaaabbbb-cccc-dddd-eeee-ffff00001111",
        "name": "Oliver Smith",
        "email": "oliver@example.com"
      },
      "tags": ["tutorial"],
      "url": "https://spinkart.neetokb.com/articles/getting-started",
      "draft_url": null,
      "permalink": "https://spinkart.neetokb.com/p/a-84af178b",
      "published_at": "2026-08-01T10:00:00.000Z",
      "created_at": "2026-07-30T09:00:00.000Z",
      "updated_at": "2026-08-01T10:00:00.000Z",
      "unique_views_count": 42,
      "is_archived": false,
      "category": {
        "id": "b7e91c2a-8f43-4d0e-9a15-6c2d8e7f1b3a",
        "name": "Getting Started",
        "is_private": false
      }
    }
  ],
  "breadcrumbs": [
    { "label": "Show", "command": "neetokb articles show <id>" },
    { "label": "Update", "command": "neetokb articles update <id>" }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page_number": 1,
    "page_size": 30
  }
}

--state takes draft, published, archived or all. --search-term is a partial, case-insensitive match on title, slug and body; with --state draft or all it also matches unpublished draft revisions. It is not relevance ranked, so use search for that. --sort-by takes title, slug, state, category_name, views_count, created_at or updated_at, and --order-by takes asc or desc.

Search articles

This command runs a full-text search across your published articles, ranked by relevance. Use this when you know roughly what an article says but not where it lives; articles list --search-term filters the same corpus but returns the full list shape. For fields and response details, see the API reference.

neetokb search --search-term "billing"

Flag	Type	Required	Default	Description
`--page`	`int`		`0`	Page number
`--page-size`	`int`		`0`	Items per page (max 100)
`--search-term`	`string`	Yes		Search query

The table shows the article ID, the matched snippet and the article URL. The snippet is flattened to plain text, so the highlight markup and the article’s own line breaks never break the column alignment. --json and --toon carry every field the API returns, including title, category, category_url, matched_title and matched_category.

Sample output (--json)

{
  "data": [
    {
      "id": "a1b2c3d4-1111-2222-3333-444455556666",
      "url": "https://spinkart.neetokb.com/articles/billing-and-invoices",
      "title": "Billing and invoices",
      "category": "Getting Started",
      "category_url": "https://spinkart.neetokb.com/folders/getting-started",
      "matched_title": "<span class=article-matched-tag>Billing</span> and invoices",
      "matched_content": "Your <span class=article-matched-tag>billing</span> cycle starts on the day you subscribe.",
      "matched_category": null
    }
  ],
  "breadcrumbs": [
    { "label": "Show article", "command": "neetokb articles show <id>" }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page_number": 1,
    "page_size": 30
  }
}

Show an article

This command shows the full record for one article, including its HTML body, author, category, and tags. Use this when you want to read or export an article after finding its ID from articles list or search.

neetokb articles show getting-started
neetokb articles show a-84af178b

Required arguments:

<id> - Article slug, permalink identifier (a-XXXXXXXX), or UUID

Sample output (--json)

{
  "data": {
    "article": {
      "id": "a1b2c3d4-1111-2222-3333-444455556666",
      "slug": "getting-started",
      "title": "Getting Started Guide",
      "state": "published",
      "full_url": "https://spinkart.neetokb.com/articles/getting-started",
      "url": "/articles/getting-started",
      "html_content": "<h1>Welcome</h1><p>This is a getting started guide.</p>",
      "author": {
        "name": "Oliver Smith",
        "email": "oliver@example.com",
        "profile_image_url": null
      },
      "category": {
        "id": "b7e91c2a-8f43-4d0e-9a15-6c2d8e7f1b3a",
        "name": "Getting Started"
      }
    },
    "meta": {
      "url": "/articles/getting-started",
      "page_title": "Getting Started - Knowledge Base",
      "meta_description": "A comprehensive guide to help you get started with our platform"
    }
  }
}

Create an article

This command creates an article in a category. Use this when you want to publish content from a script or a content pipeline instead of the editor.

neetokb articles create \
  --title "Getting Started" \
  --slug getting-started \
  --category "Installation,Getting Started" \
  --html-content "<h1>Welcome</h1><p>Example content</p>" \
  --state draft

Flag	Type	Required	Description
`--category`	`string`	Yes	Category path, most specific first (comma-separated, e.g. ‘Installation,Getting Started’)
`--html-content`	`string`		Article HTML content
`--note`	`string`		Internal note
`--related-articles`	`string`		Related article IDs, slugs or permalink identifiers (comma-separated)
`--slug`	`string`		Article slug
`--state`	`string`		Article state (draft/published)
`--tags`	`string`		Tag names (comma-separated); missing tags are created
`--title`	`string`		Article title

--category is the category path, most specific first: "Installation,Getting Started" places the article in Installation, whose parent is Getting Started. Names are matched, not IDs or slugs. --tags takes comma-separated tag names, and tags that do not exist are created. Omit --state and the article is created as a draft. Creating with --state published needs the Manage articles permission.

Sample output (--json)

{
  "data": {
    "article": {
      "id": "a1b2c3d4-1111-2222-3333-444455556666",
      "slug": "getting-started",
      "permalink": "a-84af178b"
    }
  },
  "breadcrumbs": [
    { "label": "Show", "command": "neetokb articles show <id>" }
  ]
}

With --quiet, this prints only the new article’s ID.

Update an article

This command updates an existing article’s title, body, slug, state, or category. Use this to publish a draft, correct content, rename an article’s URL, or move an article to another category.

neetokb articles update a-84af178b --title "Getting Started Guide"
neetokb articles update a-84af178b --state published
neetokb articles update a-84af178b --category "Installation,Getting Started"

Required arguments:

<id> - Article slug, permalink identifier (a-XXXXXXXX), or UUID

Flag	Type	Description
`--category`	`string`	New category path, most specific first, comma-separated; missing categories are created
`--html-content`	`string`	Article HTML content
`--note`	`string`	Internal note; an empty value deletes it
`--related-articles`	`string`	Related article IDs, slugs or permalink identifiers (comma-separated) that replace all related articles; an empty value removes all
`--slug`	`string`	Article slug
`--state`	`string`	Article state (draft/published)
`--tags`	`string`	Tag names (comma-separated) that replace all tags; missing tags are created, an empty value removes all
`--title`	`string`	Article title

Only the flags you pass are changed. --tags replaces all tags, and an empty value removes them all. --related-articles replaces all related articles with the given IDs, slugs or permalink identifiers, and an empty value removes them all; an unknown article changes nothing. --note sets the internal note, and an empty value deletes it. --slug can be modified only while the article is published. --category is the category path, most specific first, and moves the article; categories that do not exist are created. Drafts need the Modify articles permission. Publishing, and any change to an already published article, also needs the Manage articles permission.

Sample output (--json)

{
  "data": {
    "article": {
      "id": "a1b2c3d4-1111-2222-3333-444455556666",
      "slug": "getting-started",
      "title": "Getting Started Guide",
      "state": "published",
      "permalink": "a-84af178b"
    }
  }
}

Unlisted links

An unlisted link is a secret URL that lets anyone view a published article without signing in. For fields and response details, see the API reference.

Get an unlisted link

This command shows the unlisted link an article already has. It never creates a link, so it fails when the article has none or the link has expired. Use this when you want to share a published article outside your knowledge base.

neetokb articles unlisted-links get getting-started

Required arguments:

<article-id> - Article slug, permalink identifier (a-XXXXXXXX), or UUID

Sample output (--json)

{
  "data": {
    "unlisted_link": {
      "url": "https://spinkart.neetokb.com/public/p-1a2b3c4d5e",
      "enabled": true,
      "expiration_type": "never",
      "expiration_date": null
    }
  },
  "breadcrumbs": [
    {
      "label": "Regenerate",
      "command": "neetokb articles unlisted-links regenerate <article-id>"
    }
  ]
}

To create the first link, or to replace an expired one, use regenerate. The article must be published; a draft returns an error.

Regenerate an unlisted link

This command issues a new unlisted link and invalidates the old URL immediately. Use this when a link has been shared too widely, or when you want the link to expire.

neetokb articles unlisted-links regenerate getting-started
neetokb articles unlisted-links regenerate getting-started --expiration-type seven_days
neetokb articles unlisted-links regenerate getting-started \
  --expiration-type custom --expiration-date 2026-08-21T10:00:00Z

Required arguments:

<article-id> - Article slug, permalink identifier (a-XXXXXXXX), or UUID

Flag	Type	Required	Default	Description
`--expiration-date`	`string`			Exact expiry datetime (ISO8601, future). Required with —expiration-type custom; implies custom when —expiration-type is omitted; rejected alongside presets or never
`--expiration-type`	`string`			Expiration preset: never (default, no expiration), one_day, seven_days, thirty_days, or custom; preset dates are computed server-side and reject —expiration-date

The presets one_day, seven_days, and thirty_days compute the expiry on the server and reject --expiration-date. Use custom together with --expiration-date for an exact time; passing --expiration-date alone is treated as custom.

Sample output (--json)

{
  "data": {
    "unlisted_link": {
      "url": "https://spinkart.neetokb.com/public/p-9f8e7d6c5b",
      "enabled": true,
      "expiration_type": "seven_days",
      "expiration_date": "2026-08-07T10:00:00.000Z"
    }
  },
  "breadcrumbs": [
    {
      "label": "Get",
      "command": "neetokb articles unlisted-links get <article-id>"
    }
  ]
}

Trash an article

This command moves an article to the trash. It stays there for 30 days before it is deleted for good. Needs the Manage articles permission. Use neetokb trash to restore it. A synced article cannot be trashed.

neetokb articles trash getting-started

Required arguments:

<id> - Article slug, permalink identifier (a-XXXXXXXX), or UUID

Trash articles in bulk

This command moves up to 100 articles to the trash. If one cannot be trashed, none are.

neetokb articles bulk-trash --ids getting-started,a-84af178b

Flag	Type	Required	Default	Description
`--ids`	`string`	Yes		Article IDs, slugs or permalink identifiers (comma-separated, up to 100)

Archive and unarchive an article

Archiving turns an article into a draft and keeps it out of the public knowledge base. Unarchiving brings it back as a draft. List archived articles with neetokb articles list --state archived.

neetokb articles archive getting-started
neetokb articles unarchive getting-started

Required arguments:

<id> - Article slug, permalink identifier (a-XXXXXXXX), or UUID

Discard a draft

This command throws away the unpublished draft changes of a published article. The live version stays. An article that is not published has no live version to keep, so the command is refused; trash the article instead.

neetokb articles discard-draft getting-started

Required arguments:

<id> - Article slug, permalink identifier (a-XXXXXXXX), or UUID

Clone an article

This command copies an article into a new draft titled <title> - CLONED - <timestamp>.

neetokb articles clone getting-started

Required arguments:

<id> - Article slug, permalink identifier (a-XXXXXXXX), or UUID

Update articles in bulk

This command changes up to 100 articles at once. Give exactly one of --category-id, --state or --status. The change is all-or-nothing. --state also needs the Manage articles permission.

neetokb articles bulk-update --ids getting-started,a-84af178b --category-id b7e91c2a-8f43-4d0e-9a15-6c2d8e7f1b3a
neetokb articles bulk-update --ids getting-started --status archive

Flag	Type	Required	Description
`--category-id`	`string`		Move the articles to this category ID
`--ids`	`string`	Yes	Article IDs, slugs or permalink identifiers (comma-separated, up to 100)
`--state`	`string`		Set the state: draft or published
`--status`	`string`		Set the status: archive or active

--state takes draft or published. --status takes archive or active.

Create articles in a batch

This command creates 1 to 25 articles from a JSON file, each with its own content. The file holds an array of articles, or an object with an articles array. Each article takes the same fields as create. The articles are saved in order, so a later article can name an earlier article’s slug in related_article_ids. The change is all-or-nothing: if one article fails, nothing is saved and the error names that article, counting from 1. Publishing also needs the Manage articles permission.

neetokb articles batch-create --json-file articles.json

articles.json

[
  { "title": "Packing list", "html_content": "<p>What to bring.</p>", "category": ["Before camp"] },
  { "title": "Drop-off day", "html_content": "<p>Arrive by 9 AM.</p>", "category": ["Before camp"], "related_article_ids": ["packing-list"] }
]

Flag	Type	Required	Default	Description
`--json-file`	`string`	Yes		JSON file holding an array of articles or `{"articles":[{"title":"...","html_content":"<p>...</p>","category":["Guides","Setup"]}]}`

Update articles in a batch

This command updates 1 to 25 articles from a JSON file, each with its own changes. Each item names the article in article_id and gives at least one of title, html_content, slug, state, category, tags, related_article_ids or note. An article may appear only once. The change is all-or-nothing, like batch create. Use bulk update instead to apply one change to many articles.

neetokb articles batch-update --json-file changes.json

changes.json

{
  "articles": [
    { "article_id": "packing-list", "title": "Packing list for next summer" },
    { "article_id": "a-84af178b", "tags": ["arrival"], "note": "Check the bus times" }
  ]
}

Flag	Type	Required	Default	Description
`--json-file`	`string`	Yes		JSON file holding an array of changes or `{"articles":[{"article_id":"my-slug","title":"New title"}]}`

Schedules

A schedule publishes or unpublishes an article at a future time. Creating a publish schedule also needs the Manage articles permission.

neetokb articles schedules list getting-started

Required arguments:

<article-id> - Article slug, permalink identifier (a-XXXXXXXX), or UUID

Create a schedule

This command schedules a publish or unpublish.

neetokb articles schedules create getting-started \
  --kind publish --datetime 2026-12-01T10:00:00 --time-zone Asia/Kolkata

Required arguments:

<article-id> - Article slug, permalink identifier (a-XXXXXXXX), or UUID

Flag	Type	Required	Description
`--datetime`	`string`	Yes	Future date and time (ISO 8601); read in —time-zone when it has no offset
`--kind`	`string`	Yes	What happens at the time: publish or unpublish
`--publish-note`	`string`		Note saved with the publication
`--time-zone`	`string`	Yes	IANA time zone name, for example Asia/Kolkata

The date must be in the future. When it has no offset, it is read in --time-zone. An article can have one schedule of each kind, and when it has both, the unpublish time must not come after the publish time.

Delete a schedule

This command deletes a schedule.

neetokb articles schedules delete getting-started 8e1f3a60-b2c7-4d95-8a04-5c7d9e2b6f13

Required arguments:

<article-id> - Article slug, permalink identifier (a-XXXXXXXX), or UUID
<schedule-id> - Schedule ID from schedules list

Article SEO settings

These commands show and change the SEO settings of one article. For the whole knowledge base, see neetokb workspace seo.

neetokb articles seo show getting-started

Required arguments:

<article-id> - Article slug, permalink identifier (a-XXXXXXXX), or UUID

Update article SEO settings

Only the flags you pass change.

neetokb articles seo update getting-started --title "Get started" --keywords setup,install

Required arguments:

<article-id> - Article slug, permalink identifier (a-XXXXXXXX), or UUID

Flag	Type	Default	Description
`--allow-search-engine-crawl`	`bool`	`false`	Let search engines crawl the article (—allow-search-engine-crawl=false blocks them)
`--description`	`string`		Meta description
`--keywords`	`string`		Keywords (comma-separated); replaces the current list
`--title`	`string`		Page title
`--title-suffix`	`string`		Text added after the page title

--keywords replaces the whole list. The cover image and the Google Analytics ID are not available here.

Revisions

A revision is a saved earlier version of an article.

neetokb articles revisions list getting-started

Required arguments:

<article-id> - Article slug, permalink identifier (a-XXXXXXXX), or UUID

Flag	Type	Required	Default	Description
`--page`	`int`		`0`	Page number
`--page-size`	`int`		`0`	Items per page (max 100)

Show a revision

This command shows a revision with its title and HTML content.

neetokb articles revisions show getting-started 2a6d8c14-9e03-4b57-b8f1-d4c7e0a35962

Required arguments:

<article-id> - Article slug, permalink identifier (a-XXXXXXXX), or UUID
<revision-id> - Revision ID from revisions list

Restore a revision

This command copies a revision into the draft of an article. The live content does not change until you publish the draft. A synced article cannot be restored.

neetokb articles revisions restore getting-started 2a6d8c14-9e03-4b57-b8f1-d4c7e0a35962

Required arguments:

<article-id> - Article slug, permalink identifier (a-XXXXXXXX), or UUID
<revision-id> - Revision ID from revisions list

Getting started

Commands

List articles

Search articles

Show an article

Create an article

Update an article

Unlisted links

Get an unlisted link

Regenerate an unlisted link

Trash an article

Trash articles in bulk

Archive and unarchive an article

Discard a draft

Clone an article

Update articles in bulk

Create articles in a batch

Update articles in a batch

Schedules

Create a schedule

Delete a schedule

Article SEO settings

Update article SEO settings

Revisions

Show a revision

Restore a revision

​List articles

​Search articles

​Show an article

​Create an article

​Update an article

​Unlisted links

​Get an unlisted link

​Regenerate an unlisted link

​Trash an article

​Trash articles in bulk

​Archive and unarchive an article

​Discard a draft

​Clone an article

​Update articles in bulk

​Create articles in a batch

​Update articles in a batch

​Schedules

​Create a schedule

​Delete a schedule

​Article SEO settings

​Update article SEO settings

​Revisions

​Show a revision

​Restore a revision

List articles

Search articles

Show an article

Create an article

Update an article

Unlisted links

Get an unlisted link

Regenerate an unlisted link

Trash an article

Trash articles in bulk

Archive and unarchive an article

Discard a draft

Clone an article

Update articles in bulk

Create articles in a batch

Update articles in a batch

Schedules

Create a schedule

Delete a schedule

Article SEO settings

Update article SEO settings

Revisions

Show a revision

Restore a revision