Knowledge Base

get

Get all knowledge bases

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

get

/knowledge-bases

HTTPcURLJavaScriptPython

GET /knowledge-bases HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

get

Get a knowledge base by its ID

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the knowledge base.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

get

/knowledge-bases/{id}

HTTPcURLJavaScriptPython

GET /knowledge-bases/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "default_language": "text",
    "id": "text",
    "slug": "text",
    "supported_languages": [
      "text"
    ],
    "title": "text"
  },
  "request_id": "text"
}

get

Returns all collections in a knowledge base

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the knowledge base

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

get

/knowledge-bases/{id}/collections

HTTPcURLJavaScriptPython

GET /knowledge-bases/{id}/collections HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "created_at": "text",
      "description": "text",
      "icon": "text",
      "id": "text",
      "parent_collection_id": "text",
      "slug": "text",
      "title": "text",
      "visibility_config": {
        "ai_agent_access": "inherit",
        "allowed_agent_ids": [
          "text"
        ],
        "customer_visibility_condition": {
          "field": "text",
          "operator": "equals",
          "subfilters": [
            "[Circular Reference]"
          ],
          "value": "text",
          "values": [
            "text"
          ]
        },
        "visibility": "public"
      }
    }
  ],
  "request_id": "text"
}

post

Creates a new collection in a knowledge base

Rate limit: 10 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

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

Body

application/json

descriptionstringOptional

Description of the collection.

parent_collection_idstringOptional

The id of the collection associated to the article

slugstringOptional

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

titlestringRequired

The title of the collection.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

post

/knowledge-bases/{id}/collections

HTTPcURLJavaScriptPython

POST /knowledge-bases/{id}/collections HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "description": "text",
  "parent_collection_id": "text",
  "slug": "text",
  "title": "text"
}

{
  "data": {
    "created_at": "text",
    "description": "text",
    "icon": "text",
    "id": "text",
    "parent_collection_id": "text",
    "slug": "text",
    "title": "text",
    "visibility_config": {
      "ai_agent_access": "inherit",
      "allowed_agent_ids": [
        "text"
      ],
      "customer_visibility_condition": {
        "field": "text",
        "operator": "equals",
        "subfilters": [
          {
            "field": "text",
            "operator": "equals",
            "subfilters": "[Circular Reference]",
            "value": "text",
            "values": [
              "text"
            ]
          }
        ],
        "value": "text",
        "values": [
          "text"
        ]
      },
      "visibility": "public"
    }
  },
  "request_id": "text"
}

get

Returns all articles in a knowledge base with pagination

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The ID of the knowledge base the articles are being fetched from.

Query parameters

cursorstringOptional

The cursor to use for pagination.

limitinteger · int64Optional

The number of articles to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

get

/knowledge-bases/{id}/articles

HTTPcURLJavaScriptPython

GET /knowledge-bases/{id}/articles HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "collection_id": "text",
      "current_published_content_html": "text",
      "id": "text",
      "identifier": "text",
      "is_published": true,
      "last_published_at": "text",
      "slug": "text",
      "title": "text",
      "url": "text",
      "visibility_config": {
        "ai_agent_access": "inherit",
        "allowed_agent_ids": [
          "text"
        ],
        "customer_visibility_condition": {
          "field": "text",
          "operator": "equals",
          "subfilters": [
            "[Circular Reference]"
          ],
          "value": "text",
          "values": [
            "text"
          ]
        },
        "visibility": "public"
      }
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": true
  },
  "request_id": "text"
}

Creates a new article in a knowledge base

post

If translations are provided, they are created and associated with the article. If the article is published, translations are also published.

Rate limit: 10 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

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

Body

application/json

author_user_idstringRequired

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

body_htmlstringRequired

The HTML body of the article.

collection_idstringOptional

The id of the collection associated to the article

is_publishedbooleanOptional

Whether the article should be published. Defaults to false.

is_unlistedbooleanOptional

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

slugstringOptional

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

titlestringRequired

The title of the article.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

post

/knowledge-bases/{id}/articles

HTTPcURLJavaScriptPython

POST /knowledge-bases/{id}/articles HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 532

{
  "author_user_id": "text",
  "body_html": "text",
  "collection_id": "text",
  "is_published": true,
  "is_unlisted": true,
  "slug": "text",
  "title": "text",
  "translations": [
    {
      "body_html": "text",
      "language": "text",
      "title": "text"
    }
  ],
  "visibility_config": {
    "ai_agent_access": "inherit",
    "allowed_agent_ids": [
      "text"
    ],
    "customer_visibility_condition": {
      "field": "text",
      "operator": "equals",
      "subfilters": [
        {
          "field": "text",
          "operator": "equals",
          "subfilters": [
            "[Circular Reference]"
          ],
          "value": "text",
          "values": [
            "text"
          ]
        }
      ],
      "value": "text",
      "values": [
        "text"
      ]
    },
    "visibility": "public"
  }
}

{
  "data": {
    "collection_id": "text",
    "current_published_content_html": "text",
    "id": "text",
    "identifier": "text",
    "is_published": true,
    "last_published_at": "text",
    "slug": "text",
    "title": "text",
    "url": "text",
    "visibility_config": {
      "ai_agent_access": "inherit",
      "allowed_agent_ids": [
        "text"
      ],
      "customer_visibility_condition": {
        "field": "text",
        "operator": "equals",
        "subfilters": [
          {
            "field": "text",
            "operator": "equals",
            "subfilters": "[Circular Reference]",
            "value": "text",
            "values": [
              "text"
            ]
          }
        ],
        "value": "text",
        "values": [
          "text"
        ]
      },
      "visibility": "public"
    }
  },
  "request_id": "text"
}

get

Returns a single knowledge base article by ID

Rate limit: 60 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The KnowledgeBaseID of the article to fetch.

article_idstringRequired

The ID of the article to fetch.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

get

/knowledge-bases/{id}/articles/{article_id}

HTTPcURLJavaScriptPython

GET /knowledge-bases/{id}/articles/{article_id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "collection_id": "text",
    "current_published_content_html": "text",
    "id": "text",
    "identifier": "text",
    "is_published": true,
    "last_published_at": "text",
    "slug": "text",
    "title": "text",
    "url": "text",
    "visibility_config": {
      "ai_agent_access": "inherit",
      "allowed_agent_ids": [
        "text"
      ],
      "customer_visibility_condition": {
        "field": "text",
        "operator": "equals",
        "subfilters": [
          {
            "field": "text",
            "operator": "equals",
            "subfilters": "[Circular Reference]",
            "value": "text",
            "values": [
              "text"
            ]
          }
        ],
        "value": "text",
        "values": [
          "text"
        ]
      },
      "visibility": "public"
    }
  },
  "request_id": "text"
}

patch

Updates an existing knowledge base article

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The KnowledgeBaseID of the article to update.

article_idstringRequired

The ID of the article to update.

Body

application/json

body_htmlstringOptional

The HTML body of the article.

languagestringOptional

The language code of the translation to update. If not provided, the default language (original article) will be updated.

publish_updated_body_htmlbooleanOptional

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

titlestringOptional

The title of the article.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

patch

/knowledge-bases/{id}/articles/{article_id}

HTTPcURLJavaScriptPython

PATCH /knowledge-bases/{id}/articles/{article_id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 412

{
  "body_html": "text",
  "language": "text",
  "publish_updated_body_html": true,
  "title": "text",
  "visibility_config": {
    "ai_agent_access": "inherit",
    "allowed_agent_ids": [
      "text"
    ],
    "customer_visibility_condition": {
      "field": "text",
      "operator": "equals",
      "subfilters": [
        {
          "field": "text",
          "operator": "equals",
          "subfilters": [
            "[Circular Reference]"
          ],
          "value": "text",
          "values": [
            "text"
          ]
        }
      ],
      "value": "text",
      "values": [
        "text"
      ]
    },
    "visibility": "public"
  }
}

{
  "data": {
    "collection_id": "text",
    "current_published_content_html": "text",
    "id": "text",
    "identifier": "text",
    "is_published": true,
    "last_published_at": "text",
    "slug": "text",
    "title": "text",
    "url": "text",
    "visibility_config": {
      "ai_agent_access": "inherit",
      "allowed_agent_ids": [
        "text"
      ],
      "customer_visibility_condition": {
        "field": "text",
        "operator": "equals",
        "subfilters": [
          {
            "field": "text",
            "operator": "equals",
            "subfilters": "[Circular Reference]",
            "value": "text",
            "values": [
              "text"
            ]
          }
        ],
        "value": "text",
        "values": [
          "text"
        ]
      },
      "visibility": "public"
    }
  },
  "request_id": "text"
}

delete

Deletes an existing knowledge base article

Rate limit: 20 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

The KnowledgeBaseID of the article to delete.

article_idstringRequired

The ID of the article to delete.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

delete

/knowledge-bases/{id}/articles/{article_id}

HTTPcURLJavaScriptPython

DELETE /knowledge-bases/{id}/articles/{article_id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "request_id": "text"
}

post

Create a new route redirect

Rate limit: 10 requests per minute

Authorizations

bearerAuth

AuthorizationstringRequired

Authorization: Bearer

Path parameters

idstringRequired

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

Body

application/json

from_pathstringRequired

The path to redirect from.

languagestringOptional

Language of the object to redirect to. If not specified, the default language of the knowledge base will be used.

object_idstringRequired

The ID of the object to redirect to.

object_typestringRequired

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

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

post

/knowledge-bases/{id}/route-redirects

HTTPcURLJavaScriptPython

POST /knowledge-bases/{id}/route-redirects HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "from_path": "text",
  "language": "text",
  "object_id": "text",
  "object_type": "text"
}

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