V2

Search Key Points v2

post

Performs a key-points search using Smart Search v2.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Header parameters

bosa-tokenstringOptional

Body

streambooleanOptionalDefault: false

querystringRequired

The query to search for.

sizeintegerOptional

The maximum number of results to return. Defaults to 5.

Default: 5

codenamestringOptional

The codename.

Default: deep_search

bosa_tokenany ofOptional

The Bosa Token

stringOptional

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v2/search/key-points

POST /v2/search/key-points HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 111

"stream=false&query='text'&search_profile_names=[]&size=5&codename='deep_search'&bosa_token='text'"

{
  "data": [
    {
      "id": "text",
      "content": "text",
      "metadata": {
        "source": "text",
        "source_type": "text",
        "title": "text",
        "chunk_id": "text",
        "file_id": ""
      },
      "score": 1
    }
  ]
}

Knowledge Base Registration endpoints

post

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Body

Knowledge Base configurations request schema.

Request model for Knowledge Base configurations from GLChat to Smart Search. Contains a list of Data Store configurations.

Note: This endpoint expects an Authorization Bearer token in the header passed from GLChat.

Attributes: data_store_configs (list[DataStoreConfig]): List of Data Store configurations. name (str): Name of the knowledge base.

namestringRequired

Name of the knowledge base

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v2/kb-configs

POST /v2/kb-configs HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "data_store_configs": [
    {
      "data_store_type": "elasticsearch",
      "url": "text",
      "auth": "text",
      "kwargs": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "name": "text"
}

{
  "knowledge_base_id": "text",
  "name": "text"
}

Get Knowledge Base detail by provided knowledge base id

get

Provide details of knowledge base from given id, limited on only user owned kb

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

kb_idstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v2/kb-configs/{kb_id}

GET /v2/kb-configs/{kb_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "knowledge_base_id": "text",
  "name": "text",
  "data_store_configs": [
    {
      "data_store_type": "elasticsearch",
      "url": "text",
      "auth": "text",
      "kwargs": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Delete Knowledge Base by provided knowledge base id

delete

Delete knowledge base from given id, limited on only user owned kb

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

kb_idstringRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

/v2/kb-configs/{kb_id}

DELETE /v2/kb-configs/{kb_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Initiate or Validate Data Store Connection

post

Attempts to connect to or validate the configuration of the data stores associated with the given Knowledge Base.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

kb_idstringRequired

Responses

202

Successful Response

application/json

422

Validation Error

application/json

post

/v2/kb-configs/{kb_id}/connect

POST /v2/kb-configs/{kb_id}/connect HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Autosuggest

get

Get autosuggest for a given query across all data stores associated with a knowledge base, after validating user access.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Query parameters

knowledge_base_idstringRequired

The unique identifier (UUID) of the Knowledge Base.

querystringRequired

The query string to generate suggestions for.

sizeinteger · min: 1Optional

Maximum number of suggestions to return.

Default: 10

Responses

200

Successful response containing autocomplete suggestions.

application/json

Responsestring[]Example:

["taman-purbakala-cipari. Berbagai penemuan benda dari zaman","Taman Wisata Alam dan Laut TWA.","taman wisata alam telah menjaga keaslian","taman nasional tertua di Indonesia yang","Taman Jaya yang terletak di Taman","taman wisata alam, menjadikan pantai ini","Taman Nasional Ujung Kulon terdapat hamparan","Taman Nasional Ujung Kulon yang telah","Taman Nasional Ujung Kulon, Situs Warisan","Taman Makam Pahlawan Taruna, Peristirahatan Terakhir","Taman Ismail Marzuki pada November 2024."]

422

Validation Error

application/json

500

Internal Server Error

application/json

get

/v2/autosuggest

GET /v2/autosuggest?knowledge_base_id=text&query=text HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  "taman-purbakala-cipari. Berbagai penemuan benda dari zaman",
  "Taman Wisata Alam dan Laut TWA.",
  "taman wisata alam telah menjaga keaslian",
  "taman nasional tertua di Indonesia yang",
  "Taman Jaya yang terletak di Taman",
  "taman wisata alam, menjadikan pantai ini",
  "Taman Nasional Ujung Kulon terdapat hamparan",
  "Taman Nasional Ujung Kulon yang telah",
  "Taman Nasional Ujung Kulon, Situs Warisan",
  "Taman Makam Pahlawan Taruna, Peristirahatan Terakhir",
  "Taman Ismail Marzuki pada November 2024."
]

Shingles

get

Get shingles for a given query across all data stores associated with a knowledge base, after validating user access.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Query parameters

knowledge_base_idstringRequired

The unique identifier (UUID) of the Knowledge Base.

querystringRequired

The query string to generate shingles for.

sizeinteger · min: 1Optional

Maximum number of shingles to return.

Default: 10

Responses

200

Successful response containing shingles.

application/json

Responsestring[]Example:

["taman makam pahlawan taruna peristirahatan","taman nasional ujung kulon terdapat","taman wisata alam","taman jaya","taman nasional ujung","taman makam pahlawan taruna","taman wisata alam telah menjaga","taman purbakala","taman nasional"]

422

Validation Error

application/json

500

Internal Server Error

application/json

get

/v2/shingles

GET /v2/shingles?knowledge_base_id=text&query=text HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  "taman makam pahlawan taruna peristirahatan",
  "taman nasional ujung kulon terdapat",
  "taman wisata alam",
  "taman jaya",
  "taman nasional ujung",
  "taman makam pahlawan taruna",
  "taman wisata alam telah menjaga",
  "taman purbakala",
  "taman nasional"
]

Search the web

post

Search the web for documents or pages relevant to the input query.

Args: get_web_search_results_request: Request containing query and size

Returns: Response with ranked text chunks and associated metadata

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Body

streambooleanOptionalDefault: false

querystringRequired

The query to search the web for

result_typestring · enumOptional

The type of results to return

Default: snippetsPossible values:

sizeinteger · min: 1 · max: 50Optional

The number of results to return

Default: 5

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v2/web/search

POST /v2/web/search HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 65

"stream=false&query='text'&result_type='snippets'&size=5"

{
  "data": [
    {
      "confidence_score": 0.88,
      "content": "This is a snippet from the search results explaining the refund window.",
      "id": "chunk-001",
      "metadata": {
        "created_at": "2024-01-01T10:00:00Z",
        "source": "https://example.com/returns",
        "source_type": "web",
        "title": "Return Policy",
        "updated_at": "2024-01-01T10:00:00Z"
      }
    }
  ]
}

Get web search URLs

post

Search the web for pages relevant to the query and return their URLs.

This tool behaves like a search engine (e.g., Google), returning a list of URLs for a search query. Use when you need a list of URLs relevant to a web search query without fetching the page contents.

Args: request (GetWebSearchUrlsRequest): Parameters containing the search query and result count.

Returns: GetWebSearchUrlsResponse: A list of relevant URLs from web search results.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Body

streambooleanOptionalDefault: false

querystringRequired

The query to search the web for

sizeinteger · min: 1 · max: 50Optional

The number of URLs to return

Default: 5

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v2/web/search/urls

POST /v2/web/search/urls HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 40

"stream=false&query='text'&size=5"

{
  "data": [
    "https://docs.python.org/3/tutorial/",
    "https://realpython.com/python-basics/",
    "https://www.w3schools.com/python/",
    "https://python.org/about/gettingstarted/",
    "https://www.codecademy.com/learn/learn-python-3"
  ]
}

Map a website

post

Map a website to get all URLs.

This tool crawls a website and returns a list of all URLs found on the site.

Args: request (GetWebSearchMapRequest): Parameters containing the base URL and optional filters.

Returns: GetWebSearchMapResponse: A list of URLs from the website.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Body

streambooleanOptionalDefault: false

base_urlstringRequired

The base URL of the website to map

queryany ofOptional

Optional search query to filter URLs on the website

stringOptional

nullOptional

include_subdomainsbooleanOptional

Whether to include subdomains in the mapping

Default: true

sizeinteger · min: 1 · max: 1000Optional

The number of results to return

Default: 20

pageinteger · min: 1Optional

The page number to return

Default: 1

return_all_mapbooleanOptional

Whether to return all mapped links

Default: true

cachebooleanOptional

Whether to enable caching. When False, always fetches new data but still updates cache

Default: false

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v2/web/search/map

POST /v2/web/search/map HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 130

"stream=false&base_url='text'&query='text'&include_subdomains=true&size=20&page=1&return_all_map=true&cache=false"

{
  "data": [
    {
      "description": "Turn any url into clean data",
      "title": "Scrape | Firecrawl",
      "url": "https://docs.firecrawl.dev/features/scrape"
    },
    {
      "description": "Preview the API response and get the code snippets for the API",
      "title": "Playground - Firecrawl",
      "url": "https://www.firecrawl.dev/playground"
    }
  ],
  "total_found_links": 2
}

Fetch a web page

post

Fetch a single web page by URL and return its text, metadata, and optionally HTML content.

Args: get_web_page_request: Request containing URL and HTML flag

Returns: GetWebPageResponse with web page content and metadata

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Body

streambooleanOptionalDefault: false

sourcestringRequired

The URL of the web page to fetch

return_htmlbooleanOptional

Whether to return the full HTML content of the page

Default: false

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v2/web/page

POST /v2/web/page HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 52

"stream=false&source='text'&return_html=false"

{
  "fetched_at": "2024-05-01T10:00:00Z",
  "html": "<html><body><h1>Post 1</h1><p>Sample text</p></body></html>",
  "markdown": "# Post 1\n\nSample text",
  "metadata": {
    "description": "Sample text for post 1",
    "keywords": "post, sample, text",
    "language": "en",
    "status_code": 200,
    "title": "Post 1"
  },
  "source": "https://example.com/post/1"
}

Get web page snippets

post

Given a query and page URL, return the most relevant text fragments without returning the entire page contents.

Args: get_web_page_snippets_request: Request containing query, URL, size, and style

Returns: GetWebPageSnippetsResponse with relevant text snippets

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Body

streambooleanOptionalDefault: false

querystringRequired

The query to search for within the page

sourcestringRequired

The URL of the web page to extract

sizeinteger · min: 1 · max: 50Optional

The number of snippets to return

Default: 5

snippet_stylestring · enumOptional

The style of snippet to return

Default: paragraphPossible values:

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v2/web/page/snippets

POST /v2/web/page/snippets HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 84

"stream=false&query='text'&source='text'&size=5&snippet_style='paragraph'"

{
  "data": [
    {
      "confidence_score": 0.88,
      "content": "This is a snippet from the search results explaining the refund window.",
      "id": "chunk-001",
      "metadata": {
        "created_at": "2024-01-01T10:00:00Z",
        "source": "https://example.com/returns",
        "source_type": "web",
        "title": "Return Policy",
        "updated_at": "2024-01-01T10:00:00Z"
      }
    }
  ]
}

Get web page keypoints

post

Search the web, fetch page contents, and extract key points from each page. Returns key points from each web search result.

Args: get_web_page_keypoints_request: Request containing query and size

Returns: GetWebPageKeypointsResponse with key points from web search results

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Body

streambooleanOptionalDefault: false

querystringRequired

The query to search for

sourcestringRequired

The URL of the web page to extract

sizeinteger · min: 1 · max: 50Optional

The number of key points to return

Default: 5

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v2/web/page/keypoints

POST /v2/web/page/keypoints HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 56

"stream=false&query='text'&source='text'&size=5"

{
  "data": [
    {
      "confidence_score": 0.88,
      "content": "This is a snippet from the search results explaining the refund window.",
      "id": "chunk-001",
      "metadata": {
        "created_at": "2024-01-01T10:00:00Z",
        "source": "https://example.com/returns",
        "source_type": "web",
        "title": "Return Policy",
        "updated_at": "2024-01-01T10:00:00Z"
      }
    }
  ]
}

Connect

post

Connects to a connector. Optionally supports custom BOSA credentials.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

app_namestring · enumRequired

The name of the app to connect to

Possible values:

Header parameters

bosa-tokenstringOptional

Body

callback_urlstringOptional

OAuth callback URL where user will be redirected after authentication. Defaults to http://localhost:5000/health-check (configurable via BOSA_DEFAULT_CALLBACK_URL env var).

Default: http://localhost:5000/health-check

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v2/connector/{app_name}/connect

POST /v2/connector/{app_name}/connect HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 53

"callback_url='http://localhost:5000/health-check'"

{
  "message": "Successfully connected to GitHub",
  "status": "connected"
}

Disconnect

post

Disconnects from a connector. Optionally supports custom BOSA credentials.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

app_namestring · enumRequired

The name of the app to disconnect from

Possible values:

Header parameters

bosa-tokenstringOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v2/connector/{app_name}/disconnect

POST /v2/connector/{app_name}/disconnect HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "message": "Successfully connected to GitHub",
  "status": "connected"
}

Search

post

Searches a connector. Optionally supports custom BOSA credentials.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

app_namestring · enumRequired

The name of the app to search

Possible values:

Header parameters

bosa-tokenstringOptional

Body

streambooleanOptionalDefault: false

querystringRequired

The query to search for

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/v2/connector/{app_name}/search

POST /v2/connector/{app_name}/search HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 31

"stream=false&query='text'"

{
  "data": [
    {
      "confidence_score": 0.88,
      "content": "This is a snippet from the search results explaining the refund window.",
      "id": "chunk-001",
      "metadata": {
        "created_at": "2024-01-01T10:00:00Z",
        "source": "https://example.com/returns",
        "source_type": "web",
        "title": "Return Policy",
        "updated_at": "2024-01-01T10:00:00Z"
      }
    }
  ]
}

PreviousDefault NextDeep Research

Last updated 2 months ago

hashtagSearch Key Points v2

hashtagKnowledge Base Registration endpoints

hashtagGet Knowledge Base detail by provided knowledge base id

hashtagDelete Knowledge Base by provided knowledge base id

hashtagInitiate or Validate Data Store Connection

hashtagAutosuggest

hashtagShingles

hashtagSearch the web

hashtagGet web search URLs

hashtagMap a website

hashtagFetch a web page

hashtagGet web page snippets

hashtagGet web page keypoints

hashtagConnect

hashtagDisconnect

hashtagSearch

Search Key Points v2

Knowledge Base Registration endpoints

Get Knowledge Base detail by provided knowledge base id

Delete Knowledge Base by provided knowledge base id

Initiate or Validate Data Store Connection

Autosuggest

Shingles

Search the web

Get web search URLs

Map a website

Fetch a web page

Get web page snippets

Get web page keypoints

Connect

Disconnect

Search