---
title: "Onboard an agent"
method: POST
path: "/partner/app/{appId}/bizai/agent_onboarding"
tags: ["Onboard"]
---

# Onboard an agent

`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`

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.

## Request body

- OnboardingRequest
  - `catalog_id` string: Optional Meta commerce catalog id to ground the agent on.

## Response `201`

Agent created.

- OnboardingResponse
  - `agent_id` string, required: Meta resource id.

## Other responses

- `400`: Rejected by Meta and forwarded unchanged.
- `401`: Missing, invalid, or foreign-app token. Raised by Partner Portal before any forwarding.
- `429`: Per-app rate limit exceeded. Retry after the 60-second window.

---

[API](https://skmtc.dev/gupshup/apis/partner-portal-meta-business-agent-bizai-api.md) - [All operations](https://skmtc.dev/gupshup/apis/partner-portal-meta-business-agent-bizai-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gupshup/apis/partner-portal-meta-business-agent-bizai-api/revisions/4c52185f2153?raw)