Knowledge Base

Beta Release Notice: This API documentation is currently in beta and is primarily intended for developer preview. While the core functionality is stable, specific aspects including error codes, response formats, and endpoint behaviors may be refined or modified in future releases. We encourage developers to provide feedback, but recommend not using this version in production environments without understanding that breaking changes may occur. We will strive to communicate significant changes through our developer channels.

PreviousChatbot NextTransformation

Last updated 1 day ago

Query a knowledge base

post

/knowledge-base/{id}/query

Authorizations

Path parameters

idstringrequired

Knowledge base ID

Body

contextstring

semantic_search_chunksobject

queriesstring[]required

search_metadataobject

configobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.vectorshift.ai/v1/knowledge-base/{id}/query' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"semantic_search_chunks":{},"queries":[null],"search_metadata":{},"config":{"retrieval_config":{},"reranking_config":{},"question_answering_config":{},"hybrid_search_config":{}}}'

200

{
  "result": {},
  "status": "success"
}

Query results

Delete documents from a knowledge base

post

/knowledge-base/{id}/delete

Authorizations

Path parameters

idstringrequired

Knowledge base ID

Body

document_idsstring[]required

Array of document IDs to delete

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.vectorshift.ai/v1/knowledge-base/{id}/delete' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"document_ids":[null]}'

200

400

500

{
  "status": "success"
}

Documents successfully deleted

Delete a knowledge base

delete

/knowledge-base/{id}

Authorizations

Path parameters

idstringrequired

Knowledge base ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.vectorshift.ai/v1/knowledge-base/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

{
  "status": "success"
}

Knowledge base deleted successfully

Index documents in a knowledge base

post

/knowledge-base/{id}/index

Authorizations

Path parameters

idstringrequired

Knowledge base ID

Body

wikipediastring

youtubestring

arxivstring

gitstring

configobject

url_dataobject

file_dataobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.vectorshift.ai/v1/knowledge-base/{id}/index' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"config":{"index_tables":false,"analyze_documents":false,"file_processing_implementation":"Default","enrichment_tasks":["Vision"]},"url_data":{"rescrape_frequency":"text","request":{"url":"text","recursive":true,"return_type":"CHUNKS"}},"file_data":{"custom_metadata":{"ANY_ADDITIONAL_PROPERTY":"anything"},"file":{"raw_bytes":"text","type":"file","metadata":{}}}}'

200

400

500

{
  "status": "success",
  "document_ids": [
    "text"
  ]
}

Document indexed successfully

List knowledge bases

get

/knowledge-bases

Authorizations

Query parameters

include_sharedboolean

Include shared knowledge bases in the results

verboseboolean

Include full knowledge base objects in the response

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.vectorshift.ai/v1/knowledge-bases' \
  --header 'Authorization: Bearer JWT'

200

{
  "status": "success",
  "object_ids": [
    "text"
  ],
  "objects": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ]
}

Successful response. When verbose=true, full knowledge base objects are included in the response

Create a new knowledge base

post

/knowledge-base

Authorizations

Body

namestringrequired

Name of the knowledge base

descriptionstring

chunk_sizeinteger

chunk_overlapinteger

analyze_documentsboolean

apify_keystring

file_processing_implementationstring · enum

Options: Default, Textract, Unstructured, LlamaParse, Other

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.vectorshift.ai/v1/knowledge-base' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","file_processing_implementation":"Default"}'

200

400

{
  "id": "text",
  "status": "success"
}

Knowledge base created successfully

Fetch a knowledge base

get

/knowledge-base

Authorizations

Query parameters

idstring

Knowledge base ID. Either id or name must be provided

namestring

Name of the knowledge base. Either id or name must be provided

usernamestring

Optional username for name-based search. Only valid when using name parameter

org_namestring

Optional organization name for name-based search. Only valid when using name parameter

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.vectorshift.ai/v1/knowledge-base' \
  --header 'Authorization: Bearer JWT'

200

400

401

404

500

{
  "object": {},
  "status": "success"
}

Knowledge base details