Files
sdk/docs/ConnectorsApi.md
zeekayandHanzo Dev b55332704a feat: Hanzo Cloud SDK for Kotlin (generated from OpenAPI v8.0.0)
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]>
2026-07-25 07:10:32 -07:00

8.6 KiB

ConnectorsApi

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
kbConnectCallback GET /v1/kb/connectors/{provider}/callback OAuth callback (provider redirect — org recovered from signed state)
kbConnectStart GET /v1/kb/connectors/{provider}/connect Begin an OAuth connection (returns the provider authorize URL)
kbDisconnectConnector DELETE /v1/kb/connectors/{provider} Disconnect a connector (tombstone token, purge its vector points)
kbListCatalog GET /v1/kb/connectors/catalog List every connectable source (native + long-tail pieces)
kbListConnectors GET /v1/kb/connectors List this org's connectors and connection state
kbSyncConnector POST /v1/kb/connectors/{provider}/sync Sync the provider's documents into this org's knowledge store

kbConnectCallback

KbConnectCallback200Response kbConnectCallback(provider, code, state, error)

OAuth callback (provider redirect — org recovered from signed state)

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ConnectorsApi()
val provider : kotlin.String = provider_example // kotlin.String | 
val code : kotlin.String = code_example // kotlin.String | 
val state : kotlin.String = state_example // kotlin.String | 
val error : kotlin.String = error_example // kotlin.String | 
try {
    val result : KbConnectCallback200Response = apiInstance.kbConnectCallback(provider, code, state, error)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ConnectorsApi#kbConnectCallback")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ConnectorsApi#kbConnectCallback")
    e.printStackTrace()
}

Parameters

| provider | kotlin.String| | [enum: github, slack, google, notion] | | code | kotlin.String| | [optional] | | state | kotlin.String| | [optional] |

Name Type Description Notes
error kotlin.String [optional]

Return type

KbConnectCallback200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

kbConnectStart

KbConnectStart200Response kbConnectStart(provider)

Begin an OAuth connection (returns the provider authorize URL)

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ConnectorsApi()
val provider : kotlin.String = provider_example // kotlin.String | 
try {
    val result : KbConnectStart200Response = apiInstance.kbConnectStart(provider)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ConnectorsApi#kbConnectStart")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ConnectorsApi#kbConnectStart")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
provider kotlin.String [enum: github, slack, google, notion]

Return type

KbConnectStart200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

kbDisconnectConnector

KbDisconnectConnector200Response kbDisconnectConnector(provider)

Disconnect a connector (tombstone token, purge its vector points)

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ConnectorsApi()
val provider : kotlin.String = provider_example // kotlin.String | 
try {
    val result : KbDisconnectConnector200Response = apiInstance.kbDisconnectConnector(provider)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ConnectorsApi#kbDisconnectConnector")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ConnectorsApi#kbDisconnectConnector")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
provider kotlin.String [enum: github, slack, google, notion]

Return type

KbDisconnectConnector200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

kbListCatalog

KbListCatalog200Response kbListCatalog()

List every connectable source (native + long-tail pieces)

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ConnectorsApi()
try {
    val result : KbListCatalog200Response = apiInstance.kbListCatalog()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ConnectorsApi#kbListCatalog")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ConnectorsApi#kbListCatalog")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

KbListCatalog200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

kbListConnectors

KbListConnectors200Response kbListConnectors()

List this org's connectors and connection state

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ConnectorsApi()
try {
    val result : KbListConnectors200Response = apiInstance.kbListConnectors()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ConnectorsApi#kbListConnectors")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ConnectorsApi#kbListConnectors")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

KbListConnectors200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

kbSyncConnector

KbSyncConnector200Response kbSyncConnector(provider)

Sync the provider's documents into this org's knowledge store

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = ConnectorsApi()
val provider : kotlin.String = provider_example // kotlin.String | 
try {
    val result : KbSyncConnector200Response = apiInstance.kbSyncConnector(provider)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ConnectorsApi#kbSyncConnector")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ConnectorsApi#kbSyncConnector")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
provider kotlin.String [enum: github, slack, google, notion]

Return type

KbSyncConnector200Response

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json