1. Tasks
  2. Create Or Update Article

Tasks

Create Or Update Article

Adds or updates an article in the knowledge library

Libraries, rooms and shelves are used to categorize articles in the knowledge library, and will be automatically created if they do not exist.

Basic usage

Create a new knowledge library article on the demo shelf.

loading...

Parameters

articleuuid
required
string

the uuid of the article to update or create


upsert
boolean

should a new article be created if an article with the provided uuid does not exist.

The task will fail if the article does not exist and upsert is false

Default: true


parent_drivefileuuid
string

the uuid of the folder in which the article should be created


embedding_behavior
skip
sync
async

Embedding/vectorizing behavior:

  • skip - skip the vectorization and embedding step
  • sync - wait for embedding to complete
  • async - embed but dont wait for it to finish

Default: sync


branch
string

the branch to update, if left empty, will update both live and draft.

If the article does not exist, this parameter is ignored


details
Object

the details of the article

Show child attributes
name
string

the name of the article.

required
when creating a new article

description
string

the description of the article

archived
boolean

whether the article should be archived


content
Object

the content of the article

Show child attributes
text
string

the full text of the article, typically in markdown


categorization
Object

the categorization of the article

Show child attributes
knowledge_library
Object
Show child attributes
library
string

the library the article belongs to

Default: _org

room
string

the room the article belongs to

Default: _org

shelf
string

the shelf the article belongs to.

required
when creating a new article


settings
Object

the settings of the article

Show child attributes
snippet
Object

the settings for the snippets that will be generated from the article

Show child attributes
chunking
Object

the settings for how snippets will be chunked

Show child attributes
methods
Object

the methods to use for chunking

Show child attributes
md_headings
Object

settings for the md_headings chunking method, this is the default method

Show child attributes
enabled
boolean

whether the md_headings chunking method is enabled

chunk_size
number

the size of each chunk in tokens, max: 8191

chunk_overlap
number

the overlap between chunks in tokens


data
Object

Any custom data to be stored with the article


Result

loading...

Properties

article
Object

the create or updated article

Show child attributes
articleuuid
string

the uuid of the article

details
Object

the details of the article

Show child attributes
name
string

the name of the article

description
string

the description of the article

archived
boolean

whether the article is archived

branches
Object

the branches of the article


Examples

Updating the content and name of an existing article.

loading...

Result

loading...

Archive an article.

loading...

Result

loading...