Search

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.

PreviousForm NextVoicebot

Last updated 1 day ago

Fetch a search

get

/search

Authorizations

Query parameters

idstring

Search ID. Either id or name is required

namestring

Name of the search. Required if id is not provided

usernamestring

Optional username for name-based search

org_namestring

Optional organization name for name-based search

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

404

500

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

Successful response

List searches

get

/searches

Authorizations

Query parameters

include_sharedboolean

Include shared searches in the results

verboseboolean

Include full search objects in the response

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

401

500

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

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

Create a new search

post

/search

Authorizations

Body

namestringrequired

is_deployedbooleanrequired

deployment_optionsobjectrequired

access_configobjectrequired

setup_optionstring · enumrequired

Options: PIPELINE, KNOWLEDGE_BASE

knowledge_base_configobject

pipeline_configobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.vectorshift.ai/v1/search' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","is_deployed":true,"deployment_options":{"ANY_ADDITIONAL_PROPERTY":"anything"},"access_config":{"ANY_ADDITIONAL_PROPERTY":"anything"},"setup_option":"PIPELINE","knowledge_base_config":{"is_llm_mode":true,"search_llm_provider":"text","search_llm_model":"text","search_query_prompt":"text","max_docs_per_query":1,"rerank_documents":true,"do_advanced_qa":true,"search_advanced_qa_model":"text","knowledge_base_id":"text","advanced_search_mode":"text","rerank_model":"text","search_llm_max_tokens":1,"retrieval_unit":"CHUNK"},"pipeline_config":{"id":"text","input_name":"text","output_name":"text","is_llm_mode":true,"version":{"major":1,"minor":1,"patch":1}}}'

200

400

401

500

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

Successful response

Run a search

Run a search with provided inputs. Supports both regular responses and SSE streaming.

post

/search/{id}/run

Authorizations

Path parameters

idstringrequired

Body

input_messagestringrequired

conversation_idstring

is_deployedbooleanrequired

alphanumber · floatrequired

is_doc_qnabooleanrequired

search_query_promptstringrequired

portal_idstring

streamboolean

Enable server-sent events streaming

filterobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.vectorshift.ai/v1/search/{id}/run' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"input_message":"text","is_deployed":true,"alpha":1,"is_doc_qna":true,"search_query_prompt":"text","stream":false,"filter":{"selection_mode":"ALL","filter_items":[]}}'

200

400

401

500

application/json

text/event-stream

{
  "conversation_id": "text",
  "message_id": "text",
  "summary": "text",
  "status": "success",
  "doc_qna_results": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "sources": [
    "text"
  ]
}

Successful response. Returns regular JSON response or SSE stream based on 'stream' parameter.

Delete a search

delete

/search/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

500

{
  "status": "success"
}

Successful response