Configure — Connectors

Create connector

Names are unique per app. Credentials can be set here or later through the upsert routes.

post/partner/app/{appId}/bizai/agent_connectors

Request

Base URL
https://partner.gupshup.io
URL
https://partner.gupshup.io/partner/app/{appId}/bizai/agent_connectors
Auth
API key in header Authorization

Request body

namestring required

Unique per app.

descriptionstring required

base_urlstring uri required

connector_protocol'HTTP' | 'MCP'

auth_type'OAUTH2_CLIENT_CREDENTIALS' | 'API_KEY' | 'NONE' required

The only supported values. connector_protocol cannot change after creation.

requires_certificateboolean

Example request

{
  "auth_config": {
    "api_key": {
      "headers": [
        {
          "prefix": "Bearer "
        }
      ],
      "query_params": [
        {
          "prefix": "Bearer "
        }
      ],
      "body_params": [
        {
          "prefix": "Bearer "
        }
      ]
    }
  }
}

Response

Connector created.

idstring

Meta resource id.

namestring

descriptionstring

base_urlstring

connector_protocol'HTTP' | 'MCP'

auth_type'OAUTH2_CLIENT_CREDENTIALS' | 'API_KEY' | 'NONE'

auth_configobject

Example response

{
  "id": "pfbid0GNkExampleExampleExample"
}

Changes

No recorded changes to this operation across all 1 revision of this API.