Relevance AI

Relevance AI Knowledge API

The knowledge API from Relevance AI — 20 operation(s) for knowledge.

GitHub OpenAPI
Business capability
Retrieval & Embeddings AE-110.60

Operations 20

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /knowledge/add Add documents to a knowledge set · AddKnowledge #
Ask an LLM
“How do I add new data to a Relevance AI knowledge base?”
“Can I set an expiry date on knowledge I add so it drops off later?”
Tell an agent
Add {data} to knowledge set {knowledge_set}.
Add {data} to knowledge set {knowledge_set}, expiring on {expiry_date}.
POST /knowledge/chunk_and_vectorize Chunk and vectorize uploaded knowledge · ChunkAndVectorizeKnowledge #
Ask an LLM
“I uploaded knowledge with vectorizing turned off, how do I embed it now?”
“Can I chunk and vectorize everything in a knowledge set after the fact?”
Tell an agent
Chunk and vectorize knowledge set {knowledge_set}.
Embed all the rows already uploaded to {knowledge_set}.
POST /knowledge/bulk_update Bulk update rows in a knowledge set · BulkUpdateKnowledge #
Ask an LLM
“How do I edit many existing knowledge rows at once?”
“Can I remove fields from knowledge documents in a bulk update?”
Tell an agent
Apply updates {updates} to knowledge set {knowledge_set}.
Update rows in {knowledge_set} with {updates} and drop fields {fields_to_remove}.
POST /knowledge/list List documents in a knowledge set · ListKnowledge #
Ask an LLM
“What documents are stored in a knowledge set?”
“Can I filter and sort the rows of a knowledge set page by page?”
Tell an agent
List the documents in knowledge set {knowledge_set}.
Show document {document_id} from knowledge set {knowledge_set}.
POST /knowledge/chunk_list Search chunks in a knowledge set · ListKnowledgeChunks #
Ask an LLM
“How do I run a vector search over the chunks of a knowledge set?”
“Can I use exact search instead of approximate when querying knowledge chunks?”
Tell an agent
Search chunks in knowledge set {knowledge_set} for {query}.
List the text chunks of document {document_id} in {knowledge_set}.
POST /knowledge/delete Delete documents from a knowledge set · DeleteKnowledge #
Ask an LLM
“How do I delete specific documents from a knowledge set without removing the set?”
“Can I delete knowledge rows that match a filter?”
Tell an agent destructive · confirm first
Delete document {document_id} from knowledge set {knowledge_set}.
Delete rows in {knowledge_set} matching {filters}.
POST /knowledge/sets/delete Delete an entire knowledge set · DeleteKnowledgeSet #
Ask an LLM
“How do I delete a whole knowledge set?”
“Is removing a knowledge set and everything in it permanent?”
Tell an agent destructive · confirm first
Delete knowledge set {knowledge_set} entirely.
Remove the {knowledge_set} knowledge set and all its data.
POST /knowledge/aggregate Aggregate rows within a knowledge set · AggregateKnowledge #
Ask an LLM
“Can I group and count the rows inside a knowledge set?”
“How do I run an aggregation query over my knowledge data?”
Tell an agent
Aggregate knowledge set {knowledge_set} with {aggregation_query}.
Group rows in {knowledge_set} matching {filters} using {aggregation_query}.
POST /knowledge/chunks/count Count chunks in a knowledge set · CountKnowledgeChunks #
Ask an LLM
“How many chunks does a knowledge set contain?”
“Can I count the chunks of just one document?”
Tell an agent
Count the chunks in knowledge set {knowledge_set}.
Count chunks for document {document_id} in {knowledge_set}.
POST /knowledge/sets/list List knowledge sets · ListKnowledgeSets #
Ask an LLM
“Which knowledge sets exist in my project?”
“Can I include hidden sets and row counts when listing knowledge sets?”
Tell an agent
List my knowledge sets.
Find knowledge sets named like {query}, including counts {include_counts}.
GET /knowledge/sets/taken_names Check which knowledge set names are taken · GetTakenKnowledgeSetNames #
Ask an LLM
“Which knowledge set names are already in use?”
“Is there a way to avoid picking a duplicate knowledge set name?”
Tell an agent
List all knowledge set names that are already taken.
Show me the used knowledge set names so I can pick a new one.
POST /knowledge/sets/aggregate Aggregate across knowledge sets · AggregateKnowledgeSets #
Ask an LLM
“Can I aggregate statistics across all my knowledge sets?”
“How do I group knowledge sets by a field and count them?”
Tell an agent
Aggregate my knowledge sets with {aggregation_query}.
Group knowledge sets matching {filters} using {aggregation_query}.
POST /knowledge/sets/aggregate/conversations Summarize agent conversation task statuses · AggregatedAgentTaskStatuses #
Ask an LLM
“How many agent conversations are in each task status?”
“Can I group agent task statuses by a field?”
Tell an agent
Summarize agent task statuses grouped by {groupby}.
Count agent conversations by status for {filters}.
GET /knowledge/sets/{knowledge_set}/get_metadata Get a knowledge set's metadata · GetKnowledgeSetMetadata #
Ask an LLM
“Where can I see the metadata attached to a knowledge set?”
“What settings are stored on a given knowledge set?”
Tell an agent
Get metadata for knowledge set {knowledge_set}.
Show the settings stored on {knowledge_set}.
POST /knowledge/sets/{knowledge_set}/update_metadata Update a knowledge set's metadata · UpdateKnowledgeSetMetadata #
Ask an LLM
“How do I change the metadata on a knowledge set?”
“Can I remove table metadata fields from a knowledge set?”
Tell an agent
Update metadata of knowledge set {knowledge_set} with {updates}.
Remove metadata fields {fields_to_remove} from {knowledge_set}.
POST /knowledge/sets/{knowledge_set}/mark_rows_for_bulk_run Mark knowledge rows for a bulk run · MarkRowsForBulkRun #
Ask an LLM
“How do I queue rows of a table for a bulk run on one column?”
“Can I choose which rows the bulk run worker processes with a filter?”
Tell an agent
Mark rows in {knowledge_set} for a bulk run of column {column}.
Queue rows matching {filters} in {knowledge_set} for bulk run on {column}.
POST /knowledge/get_file_url Get the file URL for a knowledge set · GetKnowledgeFileUrl #
Ask an LLM
“How do I get a downloadable file link for a knowledge set?”
“Can I choose the file extension of a knowledge set's file URL?”
Tell an agent
Get the file URL for knowledge set {knowledge_set}.
Get the {extension} file link for {knowledge_set}.
POST /knowledge/get_perm_files_urls Get permanent URLs of knowledge files · GetPermKnowledgeFileUrl #
Ask an LLM
“Where can I find permanent links to the original files uploaded to a knowledge set?”
“Do uploaded knowledge files have lasting URLs?”
Tell an agent
List permanent URLs of the uploaded files in {knowledge_set}.
Get lasting links to every source file in knowledge set {knowledge_set}.
POST /knowledge/upload/trigger Upload and process files into knowledge · KnowledgeUploadTrigger #
Ask an LLM
“How do I load a batch of files into a knowledge set from URLs?”
“Can I run OCR on files while uploading them to knowledge?”
Tell an agent
Upload files {file_urls} into dataset {dataset}.
Import {file_urls} into {dataset} with OCR set to {use_ocr}.
POST /knowledge/export/trigger Export a knowledge set to CSV · KnowledgeExportTrigger #
Ask an LLM
“Can I export a knowledge set to a CSV file?”
“How do I export only certain columns from knowledge?”
Tell an agent
Export knowledge set {knowledge_set} to CSV.
Export fields {select_fields} of {knowledge_set} as {export_extension}.

Documentation

📖
Documentation
https://relevanceai.com/docs
📖
APIReference
https://api-f1db6c.stack.tryrelevance.com/latest/documentation
📖
Authentication
https://artifacts.apis.io/relevance-ai/authentication/relevance-ai-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/relevance-ai/openapi/relevance-ai-knowledge-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://artifacts.apis.io/relevance-ai/errors/relevance-ai-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/relevance-ai/data-model/relevance-ai-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/relevance-ai:relevance-ai-knowledge-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

relevance-ai-knowledge-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Relevance AI Endpoints
  title: Relevance AI Endpoints Knowledge API
  version: latest
  contact:
    email: dev@tryrelevance.com
servers:
- url: /latest
security:
- AuthorizationHeader:
  - Authorization
tags:


# --- truncated at 32 KB (4058 KB total) ---
# Full source: https://artifacts.apis.io/relevance-ai/openapi/relevance-ai-knowledge-api-openapi.yml