Knowledge Base
Authorization: Bearer
The request ID for tracking.
The request was invalid or could not be completed.
An unexpected internal error occurred.
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"
}Authorization: Bearer
The ID of the knowledge base.
The request ID for tracking.
The request was invalid or could not be completed.
An unexpected internal error occurred.
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"
}Authorization: Bearer
The ID of the knowledge base
The request ID for tracking.
The request was invalid or could not be completed.
An unexpected internal error occurred.
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"
],
"visibility": "public"
}
}
],
"request_id": "text"
}Authorization: Bearer
The ID of the knowledge base the article is being added to.
Description of the collection.
The ID of the parent collection.
The slug of the collection. Defaults to a slug based on the title.
The title of the collection.
The request ID for tracking.
The request was invalid or could not be completed.
An unexpected internal error occurred.
POST /knowledge-bases/{id}/collections HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 182
{
"description": "text",
"parent_collection_id": "text",
"slug": "text",
"title": "text",
"visibility_config": {
"ai_agent_access": "inherit",
"allowed_agent_ids": [
"text"
],
"visibility": "public"
}
}{
"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"
],
"visibility": "public"
}
},
"request_id": "text"
}Authorization: Bearer
The ID of the knowledge base that the collection belongs to.
The ID of the collection to update.
The description of the collection.
The slug of the collection.
The title of the collection.
The request ID for tracking.
The request was invalid or could not be completed.
An unexpected internal error occurred.
PATCH /knowledge-bases/{id}/collections/{collection_id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 152
{
"description": "text",
"slug": "text",
"title": "text",
"visibility_config": {
"ai_agent_access": "inherit",
"allowed_agent_ids": [
"text"
],
"visibility": "public"
}
}{
"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"
],
"visibility": "public"
}
},
"request_id": "text"
}Authorization: Bearer
The ID of the knowledge base that the collection belongs to.
The ID of the collection to delete.
The request ID for tracking.
The request was invalid or could not be completed.
An unexpected internal error occurred.
DELETE /knowledge-bases/{id}/collections/{collection_id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"request_id": "text"
}Authorization: Bearer
The ID of the knowledge base the articles are being fetched from.
The cursor to use for pagination.
The number of articles to fetch. Defaults to 100. Must be greater than 0 and less than 1000.
The language code to fetch articles in. If not provided, returns the default language.
Controls whether embedded media is included in article HTML. Valid values are all (default) and none. When set to none, embedded images, video, audio, and inline media are removed while descriptive text and standard links are preserved.
allPossible values: The request ID for tracking.
The request was invalid or could not be completed.
An unexpected internal error occurred.
GET /knowledge-bases/{id}/articles HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": [
{
"approval_info": {
"requested_at": "text",
"reviewed_at": "text",
"reviewed_by_user_id": "text",
"status": "text"
},
"author_user_id": "text",
"collection_id": "text",
"created_at": "text",
"current_draft_content_html": "text",
"current_published_content_html": "text",
"id": "text",
"identifier": "text",
"is_published": true,
"is_unlisted": true,
"last_edited_at": "text",
"last_published_at": "text",
"slug": "text",
"tags": [
{
"hex_color": "text",
"id": "text",
"object_type": "issue",
"value": "text"
}
],
"title": "text",
"url": "text",
"visibility_config": {
"ai_agent_access": "inherit",
"allowed_agent_ids": [
"text"
],
"customer_visibility_condition": {
"field": "text",
"operator": "equals",
"subfilters": [
{
"field": "state",
"operator": "equals",
"value": "new"
}
],
"value": "text",
"values": [
"text"
]
},
"visibility": "public"
}
}
],
"pagination": {
"cursor": "text",
"has_next_page": true
},
"request_id": "text"
}Authorization: Bearer
The ID of the knowledge base the article is being added to.
The ID of the user attributed as the author of the article.
The HTML body of the article.
The ID of the collection containing the article.
Whether the article should be published. Defaults to false.
Whether the article is accessible only via a direct link. Defaults to false.
The slug of the article. Defaults to a slug based on the title.
The title of the article.
The request ID for tracking.
The request was invalid or could not be completed.
An unexpected internal error occurred.
POST /knowledge-bases/{id}/articles HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 476
{
"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": "state",
"operator": "equals",
"value": "new"
}
],
"value": "text",
"values": [
"text"
]
},
"visibility": "public"
}
}{
"data": {
"approval_info": {
"requested_at": "text",
"reviewed_at": "text",
"reviewed_by_user_id": "text",
"status": "text"
},
"author_user_id": "text",
"collection_id": "text",
"created_at": "text",
"current_draft_content_html": "text",
"current_published_content_html": "text",
"id": "text",
"identifier": "text",
"is_published": true,
"is_unlisted": true,
"last_edited_at": "text",
"last_published_at": "text",
"slug": "text",
"tags": [
{
"hex_color": "text",
"id": "text",
"object_type": "issue",
"value": "text"
}
],
"title": "text",
"url": "text",
"visibility_config": {
"ai_agent_access": "inherit",
"allowed_agent_ids": [
"text"
],
"customer_visibility_condition": {
"field": "text",
"operator": "equals",
"subfilters": [
{
"field": "state",
"operator": "equals",
"value": "new"
}
],
"value": "text",
"values": [
"text"
]
},
"visibility": "public"
}
},
"request_id": "text"
}Authorization: Bearer
The KnowledgeBaseID of the article to fetch.
The ID of the article to fetch.
The language code to fetch the article in. If not provided, returns the default language.
The request ID for tracking.
The request was invalid or could not be completed.
An unexpected internal error occurred.
GET /knowledge-bases/{id}/articles/{article_id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": {
"approval_info": {
"requested_at": "text",
"reviewed_at": "text",
"reviewed_by_user_id": "text",
"status": "text"
},
"author_user_id": "text",
"collection_id": "text",
"created_at": "text",
"current_draft_content_html": "text",
"current_published_content_html": "text",
"id": "text",
"identifier": "text",
"is_published": true,
"is_unlisted": true,
"last_edited_at": "text",
"last_published_at": "text",
"slug": "text",
"tags": [
{
"hex_color": "text",
"id": "text",
"object_type": "issue",
"value": "text"
}
],
"title": "text",
"url": "text",
"visibility_config": {
"ai_agent_access": "inherit",
"allowed_agent_ids": [
"text"
],
"customer_visibility_condition": {
"field": "text",
"operator": "equals",
"subfilters": [
{
"field": "state",
"operator": "equals",
"value": "new"
}
],
"value": "text",
"values": [
"text"
]
},
"visibility": "public"
}
},
"request_id": "text"
}Authorization: Bearer
The KnowledgeBaseID of the article to update.
The ID of the article to update.
The HTML body of the article.
Whether the article should be published or unpublished.
Whether the article is accessible only via a direct link.
The language code of the translation to update. If not provided, the default language (original article) will be updated.
Whether the changes to the article should be published. Defaults to false.
IDs of article tags to assign. If provided, replaces all tags currently assigned to the article.
The title of the article.
The request ID for tracking.
The request was invalid or could not be completed.
An unexpected internal error occurred.
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: 414
{
"body_html": "text",
"is_published": true,
"is_unlisted": true,
"language": "text",
"publish_updated_body_html": true,
"tag_ids": [
"text"
],
"title": "text",
"visibility_config": {
"ai_agent_access": "inherit",
"allowed_agent_ids": [
"text"
],
"customer_visibility_condition": {
"field": "text",
"operator": "equals",
"subfilters": [
{
"field": "state",
"operator": "equals",
"value": "new"
}
],
"value": "text",
"values": [
"text"
]
},
"visibility": "public"
}
}{
"data": {
"approval_info": {
"requested_at": "text",
"reviewed_at": "text",
"reviewed_by_user_id": "text",
"status": "text"
},
"author_user_id": "text",
"collection_id": "text",
"created_at": "text",
"current_draft_content_html": "text",
"current_published_content_html": "text",
"id": "text",
"identifier": "text",
"is_published": true,
"is_unlisted": true,
"last_edited_at": "text",
"last_published_at": "text",
"slug": "text",
"tags": [
{
"hex_color": "text",
"id": "text",
"object_type": "issue",
"value": "text"
}
],
"title": "text",
"url": "text",
"visibility_config": {
"ai_agent_access": "inherit",
"allowed_agent_ids": [
"text"
],
"customer_visibility_condition": {
"field": "text",
"operator": "equals",
"subfilters": [
{
"field": "state",
"operator": "equals",
"value": "new"
}
],
"value": "text",
"values": [
"text"
]
},
"visibility": "public"
}
},
"request_id": "text"
}Authorization: Bearer
The KnowledgeBaseID of the article to delete.
The ID of the article to delete.
The request ID for tracking.
The request was invalid or could not be completed.
An unexpected internal error occurred.
DELETE /knowledge-bases/{id}/articles/{article_id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"request_id": "text"
}Authorization: Bearer
The ID of the knowledge base the route redirect is being added to.
The path to redirect from.
Language of the object to redirect to. If not specified, the default language of the knowledge base will be used.
The ID of the object to redirect to.
The type of the object to redirect to. Must be "article" or "collection".
The request ID for tracking.
The request was invalid or could not be completed.
An unexpected internal error occurred.
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"
}Authorization: Bearer
The ID of the knowledge base the article belongs to.
The ID of the article to request review for.
When true, also queue an AI review. Requires the organization to have AI article review enabled.
IDs of users to request a human review from. Each user must already be a configured reviewer for the article's knowledge base.
The request ID for tracking.
The request was invalid or could not be completed.
The authenticated caller or organization is not allowed to access this endpoint or operation.
An unexpected internal error occurred.
POST /knowledge-bases/{id}/articles/{article_id}/request-review HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55
{
"request_ai_review": true,
"reviewer_user_ids": [
"text"
]
}{
"data": {
"approval_status": "text",
"article_id": "text",
"article_version_id": "text"
},
"request_id": "text"
}Last updated
Was this helpful?