GUgupshup
Onboard

Onboard an agent

Creates a Business AI agent for the app and returns its agent_id. Every call mints a new agent, and there is no delete-agent endpoint, so call it once per app.

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

Request

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

Request body

catalog_idstring

Optional Meta commerce catalog id to ground the agent on.

Response

Agent created.

agent_idstring required

Meta resource id.

Example response

{
  "agent_id": "pfbid0GNkExampleExampleExample"
}

Changes

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