Create Knowledge

Create a new knowledge object.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Creates a knowledge object, which indexes and stores a website or a set of files so agents can query that information. For a website, give a url and a max_depth from 1 to 5. For files, give the file_ids returned by Upload files.

When to use it

Use it to give an agent a knowledge base to answer from.

Required parameters

  • name (body): the name of the knowledge object, 1 to 50 characters.
  • knowledge_metadata (body): what to index: a website (type url, with url and max_depth) or files (type file, with file_ids).
  • embedding_model (body): the embedding model to index with: a provider_id and an optional version.

Response

A successful call returns 201 Created with the Knowledge object: id, name, knowledge_metadata, embedding_model, created_by, and timestamps including indexed_at.

Related: Upload files for knowledge, Get a knowledge object, Reindex a knowledge object, List knowledge objects

Body Params
string
required
length between 1 and 50
knowledge_metadata
required
embedding_model
object
required
Responses

422

Unprocessable Entity

500

Internal Server Error

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json