Search

Key Points

post

Retrieve a search result from provided query on designated search provider. Args: request (SmartSearchSearchRequest): The request model for generating a response. Returns: SearchCollectionResponse: The search results.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Header parameters

bosa-tokenany ofOptional

stringOptional

nullOptional

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

/v1/search/key-points

POST /v1/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
    }
  ]
}

Searchs

post

Retrieve a search result from provided query on designated search provider. Args: request (SmartSearchSearchsRequest): The request model for generating a response. Returns: SearchCollectionResponse: The search results.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Header parameters

bosa-tokenany ofOptional

stringOptional

nullOptional

Body

querystringRequired

The search query string that specifies the information to be retrieved.

codenamestringRequired

sizeintegerOptional

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

Default: 20

paramsstringOptional

Optional params. Defaults to empty string.

Default: {}

bosa_tokenany ofOptional

The Bosa Token

stringOptional

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/searchs

POST /searchs HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 78

"query='text'&codename='text'&size=20&params='{}'&bosa_token='text'"

{
  "data": [
    {
      "page_content": "text",
      "metadata": {
        "source": "text",
        "id": "text",
        "source_type": "text",
        "title": "text",
        "chunk_id": "text",
        "file_id": "text"
      },
      "chunk": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Search

post

Retrieve a search result from provided query on designated search provider.

Args: request (SmartSearchSearchRequest): The request model for generating a response.

Returns: SearchCollectionResponse: The search results.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Body

querystringRequired

The search query string that specifies the information to be retrieved.

providersstringRequired

List of provider ids source to search. Separated by comma.

sizeintegerOptional

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

Default: 20

filterstringOptional

Optional filter. Defaults to empty string.

Default: ""

Responses

200

Successful response containing the search results.

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

post

/search

Form Request Example

curl -X POST {host}/search \
-F "query=Whose weekly report mentioned issue Sentinel?" \
-F "providers=53" \
-F "size=10" \
-F "filter={\"53\":{\"filter\":{\"bool\":{\"should\":[{\"bool\":{\"must_not\":{\"exists\":{\"field\":\"metadata.conversation_id\"}}}},{\"term\":{\"metadata.conversation_id.keyword\":\"74bcd05e-d186-463b-ba89-d544267788ff\"}}],\"minimum_should_match\":1}}, \"weight\":\"0.8\"}}"

{
  "result": [
    {
      "page_content": "Dear Team,\nPlease kindly find my weekly report here.\nThank you.\n[Weekly Report: [Employee Name]] [Date Range, e.g., Month Day-Day, Year]\n=============\nIssues\n1)\t[WIP] [Type of Issue, e.g., System performance] and [Type of Action, e.g., Code optimization]\n\n\ta)\tDiscussed with team to allocate additional resources for critical tasks\n\n\tb)\tRefactor plan: [high-level plan details]\n\nAccomplishments\n1)\t[Project Name]\n\n\t--\tReviewed [system feature], demo scenario\n\n2)\tInternal Collaboration\n\n\t--\tFacilitated task allocation\n\n3)\tInternal Review\n\n\t--\tAudited [types of records, e.g., project reports, financial summaries], ensuring compliance.",
      "metadata": {
        "source": "https://example.com/doc1",
        "id": "12345",
        "source_type": "docx",
        "title": "Weekly Report Week 48",
        "chunk_id": "chunk1",
        "file_id": "file1"
      },
      "chunk": {
        "text": "Summary of the week.\nIssues and accomplishments listed here.",
        "metadata": {
          "source": "Summary document for reporting.",
          "source_type": "docx",
          "file_id": "file1"
        }
      }
    }
  ]
}

Autosuggest

post

Retrieve autosuggest from provided query on designated search provider.

Args: request (SmartSearchSearchRequest): The request model for generating a response.

Returns: list[str]: List of found autosuggest.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Body

querystringRequired

The search query string that specifies the information to be retrieved.

providersstringRequired

List of provider ids source to search. Separated by comma.

sizeintegerOptional

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

Default: 20

filterstringOptional

Optional filter. Defaults to empty string.

Default: ""

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

post

/autosuggest

Form Request Example

curl -X POST {host}/autosuggest \
-F "query=taman" \
-F "providers=63" \
-F "filter={\"63\":{\"filter\":{\"bool\":{\"must_not\":{\"exists\":{\"field\":\"metadata.conversation_id\"}}}}}}" \
-F "size=20"

[
  "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

post

Retrieve text shingle from provided query on designated search provider.

Args: request (SmartSearchSearchRequest): The request model for generating a response.

Returns: list[str]: List of found text shingles.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Body

querystringRequired

The search query string that specifies the information to be retrieved.

providersstringRequired

List of provider ids source to search. Separated by comma.

sizeintegerOptional

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

Default: 20

filterstringOptional

Optional filter. Defaults to empty string.

Default: ""

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

post

/shingles

Form Request Example

curl -X POST {host}/shingles \
-F "query=taman" \
-F "providers=64" \
-F "filter={\"64\":{\"filter\":{\"bool\":{\"must_not\":{\"exists\":{\"field\":\"metadata.conversation_id\"}}}}}}" \
-F "size=20"

[
  "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"
]

Deprecated

Web Search

post

Retrieve result from provided query from web on designated search provider.

Args: request (SmartSearchSearchRequest): The request model for generating a response.

Returns: list[str]: List of found result.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Body

querystringRequired

The search query string that specifies the information to be retrieved.

providersstringRequired

List of provider ids source to search. Separated by comma.

sizeintegerOptional

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

Default: 20

filterstringOptional

Optional filter. Defaults to empty string.

Default: ""

Responses

200

Successful response containing search results.

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

post

/web_search

Form Request Example

curl -X POST {host}/web_search \
-F "query=tariff" \
-F "providers=54" \
-F "size=20"

{
  "result": [
    {
      "page_content": "On Liberation Day, President Trump imposed a 10% <em>tariff</em> on all countries and individualized reciprocal higher <em>tariff</em>s on nations with which the ...",
      "metadata": {
        "source": "https://www.whitehouse.gov/fact-sheets/2025/04/fact-sheet-president-donald-j-trump-ensures-national-security-and-economic-resilience-through-section-232-actions-on-processed-critical-minerals-and-derivative-products/",
        "id": 1,
        "source_type": "website",
        "title": "Fact Sheet: President Donald J. Trump Ensures National Security ...",
        "chunk_id": 1,
        "file_id": 1
      }
    },
    {
      "page_content": "Trump imposed a series of new <em>tariff</em>s on Chinese goods this year that now stand at 125%, and a 20% <em>tariff</em> aimed at pushing the country to ...",
      "metadata": {
        "source": "https://www.usatoday.com/story/news/politics/2025/04/16/trump-china-tariff-245-percent-trade-war/83114710007/",
        "id": 2,
        "source_type": "website",
        "title": "White House <em>tariff</em> figure for China causes confusion - USA Today",
        "chunk_id": 2,
        "file_id": 2
      }
    }
  ]
}

Get Discovery

get

Retrieve discovery result from provided query on designated search provider.

Args: request (SmartSearchDiscoveryRequest): The request model for generating a response.

Returns: list[str]: List of found result.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Query parameters

providersstringRequired

A comma-separated string of provider IDs representing the discovery sources.

Responses

200

Successful response containing discovery results.

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get

/discovery

Form Request Example

curl -X GET {host}/discovery?providers=66

{
  "result": [
    {
      "title": "Apa manfaat menggunakan buku dibandingkan dengan format digital?",
      "body": "",
      "url": ""
    },
    {
      "title": "Mengapa transformasi digital tidak dapat dilakukan jika masih menggunakan kertas?",
      "body": "",
      "url": ""
    },
    {
      "title": "Bagaimana teknologi digital meningkatkan produktivitas pekerja?",
      "body": "",
      "url": ""
    },
    {
      "title": "Apa yang dimaksud dengan hyper-automasi dalam teknologi digital?",
      "body": "",
      "url": ""
    },
    {
      "title": "Mengapa mindset perusahaan penting dalam adopsi teknologi?",
      "body": "",
      "url": ""
    }
  ]
}

Get Deep Search

get

Retrieve Deep Search result.

Args: request (SmartSearchDeepSearchRequest): The request model.

Returns: list[str]: List of result.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Query parameters

querystringRequired

The search query string that specifies the information to be retrieved.

codenamesany ofOptional

The codenames (separated by comma).

Default: ""

stringOptional

nullOptional

paramsany ofOptional

Optional parameters. Defaults to empty string.

Default: ""

stringOptional

nullOptional

Header parameters

bosa-tokenany ofOptional

stringOptional

nullOptional

Body

bosa_tokenany ofOptional

The Bosa Token

stringOptional

nullOptional

Responses

200

Successful response of deep search results.

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get

/deep-search

Form Request Example

curl "{host}/deep-search?query=tariff&codenames=x,general"

[
  [
    {
      "page_content": "RT @[GenericNewsSource]: [Summarized content about a public policy discussion or economic topic].",
      "metadata": {
        "source": "https://example.com/social_media_post/[generic_post_id]",
        "id": "[generic_id_1]",
        "source_type": "social_media",
        "title": "General News Headline",
        "chunk_id": "[generic_chunk_id_1]",
        "file_id": "[generic_file_id_1]"
      },
      "chunk": {
        "text": "RT @[GenericNewsSource]: [Summarized content about a public policy discussion or economic topic].",
        "author_id": "[masked_author_id_1]",
        "id": "[generic_post_id_1]",
        "edit_history_tweet_ids": [
          "[generic_edit_id_1]"
        ]
      },
      "codename": "x"
    },
    {
      "page_content": "Apr 2, 2025 ... Sec. 2. Reciprocal <em>Tariff</em> Policy. It is the policy of the United States to rebalance global trade flows by imposing an additional ad valorem ...",
      "metadata": {
        "source": "https://www.whitehouse.gov/presidential-actions/2025/04/regulating-imports-with-a-reciprocal-tariff-to-rectify-trade-practices-that-contribute-to-large-and-persistent-annual-united-states-goods-trade-deficits/",
        "id": "7f9ebe60a0e6b390586ef764cbdf0ed2",
        "source_type": "",
        "title": "Regulating Imports with a Reciprocal <em>Tariff</em> to Rectify Trade Practices ...",
        "chunk_id": "7f9ebe60a0e6b390586ef764cbdf0ed2",
        "file_id": "7f9ebe60a0e6b390586ef764cbdf0ed2"
      },
      "chunk": {
        "pagemap.metatags[*].['og:type']": "article",
        "pagemap.metatags[*].['og:site_name']": "The White House",
        "pagemap.metatags[*].['og:description']": "By the authority vested in me as President by the Constitution and the laws of the United States of America, including the International Emergency",
        "payload_url": "https://www.whitehouse.gov/presidential-actions/2025/04/regulating-imports-with-a-reciprocal-tariff-to-rectify-trade-practices-that-contribute-to-large-and-persistent-annual-united-states-goods-trade-deficits/",
        "kind": "customsearch#result",
        "htmlTitle": "Regulating Imports with a Reciprocal <b>Tariff</b> to Rectify Trade Practices ...",
        "link": "https://www.whitehouse.gov/presidential-actions/2025/04/regulating-imports-with-a-reciprocal-tariff-to-rectify-trade-practices-that-contribute-to-large-and-persistent-annual-united-states-goods-trade-deficits/",
        "displayLink": "www.whitehouse.gov",
        "snippet": "Apr 2, 2025 ... Sec. 2. Reciprocal Tariff Policy. It is the policy of the United States to rebalance global trade flows by imposing an additional ad valorem ...",
        "htmlSnippet": "Apr 2, 2025 <b>...</b> Sec. 2. Reciprocal <b>Tariff</b> Policy. It is the policy of the United States to rebalance global trade flows by imposing an additional ad valorem&nbsp;...",
        "formattedUrl": "https://www.whitehouse.gov/.../regulating-imports-with-a-reciprocal-tariff-t...",
        "htmlFormattedUrl": "https://www.whitehouse.gov/.../regulating-imports-with-a-reciprocal-<b>tariff</b>-t...",
        "pagemap": {
          "cse_thumbnail": [
            {
              "src": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcRGZ5IBWAgPWwukNtn53c-9NXwAJlh1uyK1pUqGAdNI14IjDd4z9tMP7Ptu&s",
              "width": "311",
              "height": "162"
            }
          ],
          "metatags": [
            {
              "og:image": "https://www.whitehouse.gov/wp-content/uploads/2025/03/WH47-Presidential-Actions-Social-Share-Card.jpg",
              "og:type": "article",
              "article:published_time": "2025-04-02T21:37:45+00:00",
              "og:image:width": "1200",
              "twitter:card": "summary_large_image",
              "og:site_name": "The White House",
              "og:title": "Regulating Imports with a Reciprocal Tariff to Rectify Trade Practices that Contribute to Large and Persistent Annual United States Goods Trade Deficits",
              "og:image:height": "628",
              "og:image:type": "image/jpeg",
              "og:description": "By the authority vested in me as President by the Constitution and the laws of the United States of America, including the International Emergency",
              "twitter:creator": "@whitehouse",
              "article:publisher": "https://www.facebook.com/WhiteHouse/",
              "twitter:site": "@whitehouse",
              "article:modified_time": "2025-04-03T12:50:15+00:00",
              "viewport": "width=device-width, initial-scale=1",
              "og:locale": "en_US",
              "og:url": "https://www.whitehouse.gov/presidential-actions/2025/04/regulating-imports-with-a-reciprocal-tariff-to-rectify-trade-practices-that-contribute-to-large-and-persistent-annual-united-states-goods-trade-deficits/"
            }
          ],
          "cse_image": [
            {
              "src": "https://www.whitehouse.gov/wp-content/uploads/2025/03/WH47-Presidential-Actions-Social-Share-Card.jpg"
            }
          ]
        }
      },
      "codename": "general"
    }
  ]
]

Browse

post

Retrieve Browse result.

Args: request (SmartSearchBrowseRequest): The request model.

Returns: list[str]: List of result.

Required scopes

This endpoint requires the following scopes:

: Read Permissions

Authorizations

OAuth2passwordRequired

Token URL:

Query parameters

codenamesany ofOptional

The codenames (separated by comma).

Default: ""

stringOptional

nullOptional

Header parameters

bosa-tokenany ofOptional

stringOptional

nullOptional

Body

querystringRequired

The search query string that specifies the information to be retrieved.

urlsstring[]Required

The URLs to browse.

bosa_tokenany ofOptional

The Bosa Token

stringOptional

nullOptional

Responses

200

Successful response containing learning points from the provided URLs.

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

post

/browse

Form Request Example

curl -X POST "{host}/browse?codename=general" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "query=generic_topic_1" \
-d "urls=https%3A%2F%2Fwww.viva.co.id%2Fsearch%3Fq%3Dgeneric_topic_1" \
-d "urls=https%3A%2F%2Fwww.beritasatu.com%2Fsearch%2Fgeneric_topic_1" \
-d "urls=https%3A%2F%2Fsearch.kompas.com%2Fsearch%3Fq%3Dgeneric_topic_1"

[
  {
    "url": "https://example.com/news/generic_topic_1",
    "status_code": 200,
    "learnings": [
      "**Scrutiny of Public Figure's Credentials:** A prominent public figure has faced questions regarding the authenticity of their professional or educational background, leading to public debate about transparency.",
      "**Legal Implications of Public Scrutiny:** Ongoing discussions highlight legal challenges related to verifying public figures' qualifications and the broader impact on governance.",
      "**Public and Political Reactions:** The public discourse around such issues can be polarizing, influencing public trust and shaping political narratives."
    ]
  },
  {
    "url": "https://www.viva.co.id/search?q=generic_topic_1",
    "status_code": 200,
    "learnings": [
      "[Person_1], a constitutional law expert, asserts that the public has the legal right to access [Person_2]'s diploma, under the Information Disclosure Act, suggesting a significant public interest in governance transparency.",
      "On April 17, 2025, the issue of the legitimacy of [Person_2]'s academic qualifications resurfaced, illustrating ongoing public scrutiny of political figures in Indonesia.",
      "[Person_3]'s ministers recently visited [Person_2] during Idul Fitri celebrations, indicating ongoing political dynamics and relationships within Indonesia's government, amidst debates over government integrity and public trust."
    ]
  }
]

PreviousHealthcheck NextDefault

Last updated 2 months ago

hashtagKey Points

hashtagSearchs

hashtagSearch

hashtagAutosuggest

hashtagShingles

hashtagWeb Search

hashtagGet Discovery

hashtagGet Deep Search

hashtagBrowse

Key Points

Searchs

Search

Autosuggest

Shingles

Web Search

Get Discovery

Get Deep Search

Browse