Get article details

curl --request GET \
  --url https://{your-workspace}.neetokb.com/api/v1/articles/{article_id} \
  --header 'X-Api-Key: <x-api-key>'

{
  "article": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "getting-started",
    "title": "Getting Started Guide",
    "state": "published",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "full_url": "https://example.neetokb.com/articles/getting-started",
    "url": "/articles/getting-started",
    "html_content": "<h1>Welcome</h1><p>This is a getting started guide.</p>",
    "content": "This is the plain text content of the article.",
    "author": {
      "name": "<string>",
      "email": "jsmith@example.com",
      "profile_image_url": "<string>"
    },
    "category": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "slug": "<string>",
      "sequence": 123,
      "parent_id": "<string>",
      "depth": 123,
      "articles_count": 123,
      "categories_count": 123,
      "total_articles_count": 123,
      "url": "<string>",
      "subcategories": [
        {}
      ],
      "ancestors": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "url": "<string>"
        }
      ],
      "children": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "articles": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "url": "<string>",
          "title": "<string>",
          "created_at": "<string>",
          "content": "<string>"
        }
      ]
    },
    "tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "tutorial"
      }
    ],
    "attachments": [
      "<any>"
    ],
    "related_articles": [
      "<any>"
    ],
    "keywords": [
      "<any>"
    ],
    "next_article": {},
    "prev_article": {},
    "table_of_contents": "<string>",
    "show_table_of_contents": true
  },
  "meta": {
    "url": "/articles/getting-started",
    "page_title": "Getting Started - Knowledge Base",
    "keywords": "getting started, tutorial, guide",
    "meta_description": "A comprehensive guide to help you get started with our platform"
  }
}

GET

articles

{article_id}

Get article details

curl --request GET \
  --url https://{your-workspace}.neetokb.com/api/v1/articles/{article_id} \
  --header 'X-Api-Key: <x-api-key>'

{
  "article": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "getting-started",
    "title": "Getting Started Guide",
    "state": "published",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "full_url": "https://example.neetokb.com/articles/getting-started",
    "url": "/articles/getting-started",
    "html_content": "<h1>Welcome</h1><p>This is a getting started guide.</p>",
    "content": "This is the plain text content of the article.",
    "author": {
      "name": "<string>",
      "email": "jsmith@example.com",
      "profile_image_url": "<string>"
    },
    "category": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "slug": "<string>",
      "sequence": 123,
      "parent_id": "<string>",
      "depth": 123,
      "articles_count": 123,
      "categories_count": 123,
      "total_articles_count": 123,
      "url": "<string>",
      "subcategories": [
        {}
      ],
      "ancestors": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "url": "<string>"
        }
      ],
      "children": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "articles": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "url": "<string>",
          "title": "<string>",
          "created_at": "<string>",
          "content": "<string>"
        }
      ]
    },
    "tags": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "tutorial"
      }
    ],
    "attachments": [
      "<any>"
    ],
    "related_articles": [
      "<any>"
    ],
    "keywords": [
      "<any>"
    ],
    "next_article": {},
    "prev_article": {},
    "table_of_contents": "<string>",
    "show_table_of_contents": true
  },
  "meta": {
    "url": "/articles/getting-started",
    "page_title": "Getting Started - Knowledge Base",
    "keywords": "getting started, tutorial, guide",
    "meta_description": "A comprehensive guide to help you get started with our platform"
  }
}

Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

X-Api-Key

string

default:your-api-key

required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Path Parameters

article_id

string

required

Unique identifier of the article. Can be the article's slug, permalink, or ID. Refer to Getting the Article ID section for detailed instructions.

Response

200 - application/json

OK - Request succeeded

article

object

Hide child attributes

article.id

string<uuid>

article.slug

string

Example:

"getting-started"

article.title

string

Example:

"Getting Started Guide"

article.state

enum<string>

Available options:

draft,

published

Example:

"published"

article.created_at

string<date-time>

article.updated_at

string<date-time>

article.full_url

string

Example:

"https://example.neetokb.com/articles/getting-started"

article.url

string

Example:

"/articles/getting-started"

article.html_content

string

Example:

"<h1>Welcome</h1><p>This is a getting started guide.</p>"

article.content

string

Example:

"This is the plain text content of the article."

article.author

object

Hide child attributes

article.author.name

string

article.author.email

string<email>

article.author.profile_image_url

string<uri> | null

article.category

object

Hide child attributes

article.category.id

string<uuid>

article.category.name

string

article.category.description

string | null

article.category.slug

string

article.category.sequence

integer | null

article.category.parent_id

string | null

article.category.depth

integer | null

article.category.articles_count

integer

article.category.categories_count

integer

article.category.total_articles_count

integer

article.category.url

string

article.category.subcategories

object[]

Hide child attributes

string<uuid>

name

string

description

string

slug

string

sequence

integer

parent_id

string

depth

integer

articles_count

integer

categories_count

integer

total_articles_count

integer

url

string

subcategories

any[]

ancestors

any[]

children

any[]

articles

any[]

article.category.ancestors

object[]

Hide child attributes

string<uuid>

name

string

url

string

article.category.children

string<uuid>[]

article.category.articles

object[]

Hide child attributes

string<uuid>

url

string

title

string

created_at

string

content

string

article.tags

object[]

Hide child attributes

string<uuid>

name

string

Example:

"tutorial"

article.attachments

any[]

article.keywords

any[]

article.next_article

object | null

article.prev_article

object | null

article.table_of_contents

string

article.show_table_of_contents

boolean

Getting Started

Articles API

Authors API

Categories API

Recommendations API

Settings API

Team Members API

Get article details

Headers

Path Parameters

Response