Knowledge Base

Get all knowledge bases.

GEThttps://api.usepylon.com/knowledge-bases

Response

Body

dataarray of KnowledgeBase (object)

The data payload of the response.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

const response = await fetch('https://api.usepylon.com/knowledge-bases', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "id": "text",
      "slug": "text",
      "title": "text"
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": false
  },
  "request_id": "text"
}

Get a knowledge base by its ID.

GEThttps://api.usepylon.com/knowledge-bases/{id}

Path parameters

id*string

The ID of the knowledge base.

Response

Body

dataKnowledgeBase (object)

request_idstring

The request ID for tracking.

Request

const response = await fetch('https://api.usepylon.com/knowledge-bases/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": {
    "id": "text",
    "slug": "text",
    "title": "text"
  },
  "request_id": "text"
}

List all collections in a knowledge base.

GEThttps://api.usepylon.com/knowledge-bases/{id}/collections

Path parameters

id*string

The ID of the knowledge base

Response

Body

dataarray of Collection (object)

The data payload of the response.

request_idstring

The request ID for tracking.

Request

const response = await fetch('https://api.usepylon.com/knowledge-bases/{id}/collections', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "created_at": "text",
      "description": "text",
      "id": "text",
      "parent_collection_id": "text",
      "slug": "text",
      "title": "text"
    }
  ],
  "request_id": "text"
}

Create a new article.

POSThttps://api.usepylon.com/knowledge-bases/{id}/articles

Path parameters

id*string

The ID of the knowledge base the article is being added to.

Body

author_user_id*string

The ID of the user attributed as the author of the article.

body_html*string

The HTML body of the article.

collection_idstring

The id of the collection associated to the article

is_publishedboolean

Whether the article should be published. Defaults to false.

is_unlistedboolean

Whether the article can only be accessible only via direct link. Defaults to false.

slugstring

The slug of the article. Defaults to a slug based on the title.

title*string

The title of the article.

visibility_configVisibilityConfig (object)

Response

Body

dataArticle (object)

request_idstring

The request ID for tracking.

Request

const response = await fetch('https://api.usepylon.com/knowledge-bases/{id}/articles', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "author_user_id": "text",
      "body_html": "text",
      "title": "text"
    }),
});
const data = await response.json();

Response

{
  "data": {
    "current_published_content_html": "text",
    "id": "text",
    "identifier": "text",
    "is_published": false,
    "slug": "text",
    "title": "text"
  },
  "request_id": "text"
}

Update an existing article.

PATCHhttps://api.usepylon.com/knowledge-bases/{id}/articles/{article_id}

Path parameters

id*string

The KnowledgeBaseID of the article to update.

article_id*string

The ID of the article to update.

Body

body_htmlstring

The HTML body of the article.

publish_updated_body_htmlboolean

Whether the changes to the article should be published. Defaults to false.

titlestring

The title of the article.

Response

Body

dataArticle (object)

request_idstring

The request ID for tracking.

Request

const response = await fetch('https://api.usepylon.com/knowledge-bases/{id}/articles/{article_id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "data": {
    "current_published_content_html": "text",
    "id": "text",
    "identifier": "text",
    "is_published": false,
    "slug": "text",
    "title": "text"
  },
  "request_id": "text"
}

Create a new collection.

POSThttps://api.usepylon.com/knowledge-bases/{id}/collections

Path parameters

id*string

The ID of the knowledge base the article is being added to.

Body

descriptionstring

Description of the collection.

parent_collection_idstring

The id of the collection associated to the article

slugstring

The slug of the collection. Defaults to a slug based on the title.

title*string

The title of the collection.

Response

Body

dataCollection (object)

request_idstring

The request ID for tracking.

Request

const response = await fetch('https://api.usepylon.com/knowledge-bases/{id}/collections', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text"
    }),
});
const data = await response.json();

Response

{
  "data": {
    "created_at": "text",
    "description": "text",
    "id": "text",
    "parent_collection_id": "text",
    "slug": "text",
    "title": "text"
  },
  "request_id": "text"
}

Create a new route redirect.

POSThttps://api.usepylon.com/knowledge-bases/{id}/route-redirects

Path parameters

id*string

The ID of the knowledge base the route redirect is being added to.

Body

from_path*string

The path to redirect from.

object_id*string

The ID of the object to redirect to.

object_type*string

The type of the object to redirect to. This must be "article".

Response

Body

dataRouteRedirect (object)

request_idstring

The request ID for tracking.

Request

const response = await fetch('https://api.usepylon.com/knowledge-bases/{id}/route-redirects', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "from_path": "text",
      "object_id": "text",
      "object_type": "text"
    }),
});
const data = await response.json();

Response

{
  "data": {
    "created_at": "text",
    "from_path": "text",
    "id": "text",
    "object_id": "text",
    "object_type": "text"
  },
  "request_id": "text"
}

PreviousIssues NextMe

Last updated 4 days ago