Coroutine-native client covering the full Hanzo /v1 cloud surface, for JVM and Android. Generated with openapi-generator kotlin (library=jvm-okhttp4, useCoroutines=true). Coordinate: ai.hanzo:sdk. Base URL: https://api.hanzo.ai. Co-authored-by: Hanzo Dev <[email protected]>
30 KiB
SearchApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| botSearchPersonas | GET /v1/bot/search/personas | Lexical search for personas |
| botSearchSkills | GET /v1/bot/search/skills | Hybrid vector + lexical search for skills |
| chatGetSearchEnable | GET /v1/chat/search/enable | Check if search is enabled |
| commerceSearchNotes | POST /v1/commerce/search/note | Search notes |
| commerceSearchOrders | GET /v1/commerce/search/order | Search orders |
| commerceSearchUsers | GET /v1/commerce/search/user | Search users |
| kbKbSearch | POST /v1/kb/search | Semantic search over the org's knowledge |
| productGetSearchStats | GET /v1/search-docs/stats | Get aggregate search statistics |
| productListSearchIndexes | GET /v1/search-docs/indexes | List search indexes |
| provisioningCreateSearch | POST /v1/search | Provision a search resource |
| provisioningDeleteSearch | DELETE /v1/search/{name} | Deprovision a search resource |
| provisioningGetSearch | GET /v1/search/{name} | Get one search resource |
| provisioningListSearch | GET /v1/search | List search resources for the caller's org |
| searchSearchGet | GET /v1/search/indexes/{indexUid}/search | Search documents (GET) |
| searchSearchPost | POST /v1/search/indexes/{indexUid}/search | Search documents (POST) |
| vectorRecommendPoints | POST /v1/vector/collections/{collection_name}/points/recommend | Recommend points |
| vectorSearchBatch | POST /v1/vector/collections/{collection_name}/points/search/batch | Batch search |
| vectorSearchPoints | POST /v1/vector/collections/{collection_name}/points/search | Search points |
| websearchWebSearch | GET /v1/websearch/search | Search the web (SearXNG JSON contract, proxied verbatim) |
botSearchPersonas
BotSearchPersonas200Response botSearchPersonas(q, limit)
Lexical search for personas
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
val q : kotlin.String = q_example // kotlin.String |
val limit : kotlin.Int = 56 // kotlin.Int |
try {
val result : BotSearchPersonas200Response = apiInstance.botSearchPersonas(q, limit)
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#botSearchPersonas")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#botSearchPersonas")
e.printStackTrace()
}
Parameters
| q | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | kotlin.Int | [optional] [default to 20] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
botSearchSkills
BotSearchPersonas200Response botSearchSkills(q, limit)
Hybrid vector + lexical search for skills
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
val q : kotlin.String = q_example // kotlin.String | Search query
val limit : kotlin.Int = 56 // kotlin.Int |
try {
val result : BotSearchPersonas200Response = apiInstance.botSearchSkills(q, limit)
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#botSearchSkills")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#botSearchSkills")
e.printStackTrace()
}
Parameters
| q | kotlin.String| Search query | |
| Name | Type | Description | Notes |
|---|---|---|---|
| limit | kotlin.Int | [optional] [default to 20] |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
chatGetSearchEnable
kotlin.Boolean chatGetSearchEnable()
Check if search is enabled
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
try {
val result : kotlin.Boolean = apiInstance.chatGetSearchEnable()
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#chatGetSearchEnable")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#chatGetSearchEnable")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
kotlin.Boolean
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
commerceSearchNotes
kotlin.collections.List<CommerceNote> commerceSearchNotes(commerceSearchNotesRequest)
Search notes
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
val commerceSearchNotesRequest : CommerceSearchNotesRequest = // CommerceSearchNotesRequest |
try {
val result : kotlin.collections.List<CommerceNote> = apiInstance.commerceSearchNotes(commerceSearchNotesRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#commerceSearchNotes")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#commerceSearchNotes")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| commerceSearchNotesRequest | CommerceSearchNotesRequest |
Return type
kotlin.collections.List<CommerceNote>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
commerceSearchOrders
kotlin.collections.List<CommerceOrder> commerceSearchOrders(q)
Search orders
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
val q : kotlin.String = q_example // kotlin.String |
try {
val result : kotlin.collections.List<CommerceOrder> = apiInstance.commerceSearchOrders(q)
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#commerceSearchOrders")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#commerceSearchOrders")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| q | kotlin.String |
Return type
kotlin.collections.List<CommerceOrder>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
commerceSearchUsers
kotlin.collections.List<CommerceUser> commerceSearchUsers(q)
Search users
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
val q : kotlin.String = q_example // kotlin.String |
try {
val result : kotlin.collections.List<CommerceUser> = apiInstance.commerceSearchUsers(q)
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#commerceSearchUsers")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#commerceSearchUsers")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| q | kotlin.String |
Return type
kotlin.collections.List<CommerceUser>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
kbKbSearch
KbKbSearch200Response kbKbSearch(kbSearchRequest)
Semantic search over the org's knowledge
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
val kbSearchRequest : KbSearchRequest = // KbSearchRequest |
try {
val result : KbKbSearch200Response = apiInstance.kbKbSearch(kbSearchRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#kbKbSearch")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#kbKbSearch")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| kbSearchRequest | KbSearchRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
productGetSearchStats
ProductSearchStats productGetSearchStats()
Get aggregate search statistics
Returns the total document count across all Meilisearch indexes. Meilisearch keeps no query-history counters, so `totalSearches`, `totalSessions`, and the `searchesPerDay` series are reported as an honest zero/empty rather than a fabricated number. If the upstream is unreachable, returns HTTP 200 with all counters zeroed. Authenticated with the opaque search service key.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
try {
val result : ProductSearchStats = apiInstance.productGetSearchStats()
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#productGetSearchStats")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#productGetSearchStats")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
productListSearchIndexes
ProductListSearchIndexes200Response productListSearchIndexes()
List search indexes
Returns every Meilisearch index with its document count and, on a best-effort basis, its created/last-indexed timestamps. If the upstream Meilisearch is unreachable, returns HTTP 200 with an empty `indexes` array. Authenticated with the opaque search service key.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
try {
val result : ProductListSearchIndexes200Response = apiInstance.productListSearchIndexes()
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#productListSearchIndexes")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#productListSearchIndexes")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
ProductListSearchIndexes200Response
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
provisioningCreateSearch
ProvisioningCreateResponse provisioningCreateSearch(provisioningCreateRequest)
Provision a search resource
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
val provisioningCreateRequest : ProvisioningCreateRequest = // ProvisioningCreateRequest |
try {
val result : ProvisioningCreateResponse = apiInstance.provisioningCreateSearch(provisioningCreateRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#provisioningCreateSearch")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#provisioningCreateSearch")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| provisioningCreateRequest | ProvisioningCreateRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
provisioningDeleteSearch
provisioningDeleteSearch(name)
Deprovision a search resource
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
val name : kotlin.String = name_example // kotlin.String | The user-supplied resource name (slug). Lowercased and trimmed server-side; must match `^[a-z0-9]([a-z0-9-]{0,38}[a-z0-9])?$`.
try {
apiInstance.provisioningDeleteSearch(name)
} catch (e: ClientException) {
println("4xx response calling SearchApi#provisioningDeleteSearch")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#provisioningDeleteSearch")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | kotlin.String | The user-supplied resource name (slug). Lowercased and trimmed server-side; must match `^a-z0-9?$`. |
Return type
null (empty response body)
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
provisioningGetSearch
ProvisioningGetResponse provisioningGetSearch(name)
Get one search resource
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
val name : kotlin.String = name_example // kotlin.String | The user-supplied resource name (slug). Lowercased and trimmed server-side; must match `^[a-z0-9]([a-z0-9-]{0,38}[a-z0-9])?$`.
try {
val result : ProvisioningGetResponse = apiInstance.provisioningGetSearch(name)
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#provisioningGetSearch")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#provisioningGetSearch")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| name | kotlin.String | The user-supplied resource name (slug). Lowercased and trimmed server-side; must match `^a-z0-9?$`. |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
provisioningListSearch
kotlin.collections.List<ProvisioningListItem> provisioningListSearch()
List search resources for the caller's org
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
try {
val result : kotlin.collections.List<ProvisioningListItem> = apiInstance.provisioningListSearch()
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#provisioningListSearch")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#provisioningListSearch")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
kotlin.collections.List<ProvisioningListItem>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
searchSearchGet
SearchSearchResult searchSearchGet(indexUid, q, offset, limit, attributesToRetrieve, attributesToHighlight, attributesToCrop, cropLength, filter, sort, facets, showMatchesPosition, showRankingScore, matchingStrategy)
Search documents (GET)
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
val indexUid : kotlin.String = indexUid_example // kotlin.String | Unique index identifier
val q : kotlin.String = q_example // kotlin.String | Search query
val offset : kotlin.Int = 56 // kotlin.Int |
val limit : kotlin.Int = 56 // kotlin.Int |
val attributesToRetrieve : kotlin.String = attributesToRetrieve_example // kotlin.String | Comma-separated list of attributes to return
val attributesToHighlight : kotlin.String = attributesToHighlight_example // kotlin.String |
val attributesToCrop : kotlin.String = attributesToCrop_example // kotlin.String |
val cropLength : kotlin.Int = 56 // kotlin.Int |
val filter : kotlin.String = filter_example // kotlin.String | Filter expression
val sort : kotlin.String = sort_example // kotlin.String | Comma-separated sort rules
val facets : kotlin.String = facets_example // kotlin.String | Comma-separated facet attributes
val showMatchesPosition : kotlin.Boolean = true // kotlin.Boolean |
val showRankingScore : kotlin.Boolean = true // kotlin.Boolean |
val matchingStrategy : kotlin.String = matchingStrategy_example // kotlin.String |
try {
val result : SearchSearchResult = apiInstance.searchSearchGet(indexUid, q, offset, limit, attributesToRetrieve, attributesToHighlight, attributesToCrop, cropLength, filter, sort, facets, showMatchesPosition, showRankingScore, matchingStrategy)
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#searchSearchGet")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#searchSearchGet")
e.printStackTrace()
}
Parameters
| indexUid | kotlin.String| Unique index identifier | | | q | kotlin.String| Search query | [optional] | | offset | kotlin.Int| | [optional] [default to 0] | | limit | kotlin.Int| | [optional] [default to 20] | | attributesToRetrieve | kotlin.String| Comma-separated list of attributes to return | [optional] | | attributesToHighlight | kotlin.String| | [optional] | | attributesToCrop | kotlin.String| | [optional] | | cropLength | kotlin.Int| | [optional] [default to 10] | | filter | kotlin.String| Filter expression | [optional] | | sort | kotlin.String| Comma-separated sort rules | [optional] | | facets | kotlin.String| Comma-separated facet attributes | [optional] | | showMatchesPosition | kotlin.Boolean| | [optional] | | showRankingScore | kotlin.Boolean| | [optional] |
| Name | Type | Description | Notes |
|---|---|---|---|
| matchingStrategy | kotlin.String | [optional] [enum: last, all, frequency] |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
searchSearchPost
SearchSearchResult searchSearchPost(indexUid, searchSearchQuery)
Search documents (POST)
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
val indexUid : kotlin.String = indexUid_example // kotlin.String | Unique index identifier
val searchSearchQuery : SearchSearchQuery = // SearchSearchQuery |
try {
val result : SearchSearchResult = apiInstance.searchSearchPost(indexUid, searchSearchQuery)
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#searchSearchPost")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#searchSearchPost")
e.printStackTrace()
}
Parameters
| indexUid | kotlin.String| Unique index identifier | |
| Name | Type | Description | Notes |
|---|---|---|---|
| searchSearchQuery | SearchSearchQuery |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
vectorRecommendPoints
VectorRecommendPoints200Response vectorRecommendPoints(collectionName, vectorRecommendPointsRequest)
Recommend points
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
val collectionName : kotlin.String = collectionName_example // kotlin.String |
val vectorRecommendPointsRequest : VectorRecommendPointsRequest = // VectorRecommendPointsRequest |
try {
val result : VectorRecommendPoints200Response = apiInstance.vectorRecommendPoints(collectionName, vectorRecommendPointsRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#vectorRecommendPoints")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#vectorRecommendPoints")
e.printStackTrace()
}
Parameters
| collectionName | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| vectorRecommendPointsRequest | VectorRecommendPointsRequest |
Return type
VectorRecommendPoints200Response
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
vectorSearchBatch
VectorSearchBatch200Response vectorSearchBatch(collectionName, vectorSearchBatchRequest)
Batch search
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
val collectionName : kotlin.String = collectionName_example // kotlin.String |
val vectorSearchBatchRequest : VectorSearchBatchRequest = // VectorSearchBatchRequest |
try {
val result : VectorSearchBatch200Response = apiInstance.vectorSearchBatch(collectionName, vectorSearchBatchRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#vectorSearchBatch")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#vectorSearchBatch")
e.printStackTrace()
}
Parameters
| collectionName | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| vectorSearchBatchRequest | VectorSearchBatchRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
vectorSearchPoints
VectorRecommendPoints200Response vectorSearchPoints(collectionName, vectorSearchRequest)
Search points
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
val collectionName : kotlin.String = collectionName_example // kotlin.String |
val vectorSearchRequest : VectorSearchRequest = // VectorSearchRequest |
try {
val result : VectorRecommendPoints200Response = apiInstance.vectorSearchPoints(collectionName, vectorSearchRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#vectorSearchPoints")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#vectorSearchPoints")
e.printStackTrace()
}
Parameters
| collectionName | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| vectorSearchRequest | VectorSearchRequest |
Return type
VectorRecommendPoints200Response
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
websearchWebSearch
WebsearchSearchResponse websearchWebSearch(q, format)
Search the web (SearXNG JSON contract, proxied verbatim)
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SearchApi()
val q : kotlin.String = q_example // kotlin.String | Search query
val format : kotlin.String = format_example // kotlin.String |
try {
val result : WebsearchSearchResponse = apiInstance.websearchWebSearch(q, format)
println(result)
} catch (e: ClientException) {
println("4xx response calling SearchApi#websearchWebSearch")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SearchApi#websearchWebSearch")
e.printStackTrace()
}
Parameters
| q | kotlin.String| Search query | |
| Name | Type | Description | Notes |
|---|---|---|---|
| format | kotlin.String | [optional] [default to Format.json] [enum: json] |
Return type
Authorization
Configure serviceKey: ApiClient.apiKey["X-API-Key"] = "" ApiClient.apiKeyPrefix["X-API-Key"] = ""
HTTP request headers
- Content-Type: Not defined
- Accept: application/json