> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Meta Business Agent overview

> Build and operate a Meta-hosted AI agent for a WhatsApp Business phone number through YCloud APIs.

Meta Business Agent is a Meta-hosted AI agent that can answer WhatsApp customer messages using the business information, knowledge, skills, and tools you configure. YCloud exposes the Meta Business Agent lifecycle through the YCloud REST API and supplies the Meta credential on your behalf.

<Warning>
  Meta Business Agent is an early-access Meta product. Availability, validation, and runtime behavior can change independently of YCloud. Always call the [Check Eligibility endpoint](/api-reference/meta-business-agents/check-eligibility) for the phone number you plan to use.
</Warning>

## API basics

| Item | Value |
| - | - |
| Base URL | `https://api.ycloud.com/v2` |
| Authentication | `X-API-Key: YOUR_API_KEY` |
| Resource path | `/metaBusinessAgents/{entityId}` |
| `entityId` | The WhatsApp Business Phone Number ID that owns the agent |
| Payload naming | `snake_case` |

YCloud resolves the tenant and Meta access token from your API key. Do not send a Meta access token in these requests.

## Recommended lifecycle

Follow the Build and launch guides in order. They connect the individual API resources into an end-to-end rollout process.

1. [Prepare and check eligibility](/en/documentation/meta-business-agent/prepare-and-check-eligibility).
2. [Onboard and configure](/en/documentation/meta-business-agent/onboard-and-configure) the agent in a restricted test state.
3. [Test and evaluate](/en/documentation/meta-business-agent/test-and-evaluate) single-turn, multi-turn, and representative business scenarios.
4. [Roll out safely](/en/documentation/meta-business-agent/roll-out-safely) from allowlisted recipients to the full audience.
5. [Operate and troubleshoot](/en/documentation/meta-business-agent/operate-and-troubleshoot) the live agent.

## Resources covered by the workflow

Each API Reference directory has its own landing page and links to every endpoint in that area.

| Area | What you can do | API reference |
| - | - | - |
| Onboard | Check eligibility, onboard or delete an agent, manage profile settings and budgets, and maintain allowlist entries | [Open directory](/en/api-reference/meta-business-agents/onboard) |
| Configure | Manage business knowledge, behavioral and UI skills, connectors, credentials, and connector tools | [Open directory](/en/api-reference/meta-business-agents/configure) |
| Operate | Submit events, inspect conversation turns, test responses, control conversation threads, run evaluations, and retrieve results | [Open directory](/en/api-reference/meta-business-agents/operate) |

This release documents 62 REST operations. API-created Agents can also emit
[echo and handover webhook events](/en/api-reference/guides/examples/webhook-examples/overview#echo-and-agent-handover-events).

## Ownership and isolation

Except for eligibility, phone-number-scoped operations require an active Public API agent binding owned by the same YCloud tenant. YCloud returns `404` when the binding is missing, belongs to another tenant, or was created through an incompatible origin. This prevents one tenant or integration surface from accessing another agent.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.