# Documentation MegaAPI API

> Documentation MegaAPI API on Apizie: 29 endpoints (Get an status of instance, POST /rest/instance/downloadMediaMessage/{instance_key}, Get image from any whatsapp profile, Check if the number exists in whatsapp, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/business:megaapi/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `business:megaapi`
- Category: Business
- Status: byok
- Source: https://mega-api.app.br
- Page: https://apizie.tech/api/business/megaapi
- OpenAPI: https://apizie.tech/api/business/megaapi/openapi.json

This is a sample documentation for a new API.

## Endpoints

### Get an status of instance
`GET https://apizie.tech/v1/business:megaapi/instance-controller-get-instance-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |

### POST /rest/instance/downloadMediaMessage/{instance_key}
`POST https://apizie.tech/v1/business:megaapi/instance-controller-download-media-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| body | object | no | JSON request body |

### Get image from any whatsapp profile
`GET https://apizie.tech/v1/business:megaapi/instance-controller-get-profile-picture` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| to | string | no |  |
| type | string | no | icon/image |

### Check if the number exists in whatsapp
`GET https://apizie.tech/v1/business:megaapi/instance-controller-check-if-number-exists-in-whats-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| jid | string | no |  |

### Get the qrcode
`GET https://apizie.tech/v1/business:megaapi/instance-controller-get-qr-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |

### Get the qrcode in base64 format
`GET https://apizie.tech/v1/business:megaapi/instance-controller-get-qr-code-base64` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |

### Get the pairing code to login
`GET https://apizie.tech/v1/business:megaapi/instance-controller-get-pairing-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| phoneNumber | string | no |  |

### Logout from an instance
`POST https://apizie.tech/v1/business:megaapi/instance-controller-logout-instance-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |

### Restart an instance
`POST https://apizie.tech/v1/business:megaapi/instance-controller-restart-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |

### Get an instance webhook data
`GET https://apizie.tech/v1/business:megaapi/webhook-controller-get-instance-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |

### POST /rest/webhook/{instance_key}/configWebhook
`POST https://apizie.tech/v1/business:megaapi/webhook-controller-configure-webhook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| body | object | no | JSON request body |

### Send a text message to an WhatsApp User
`POST https://apizie.tech/v1/business:megaapi/send-message-controller-send-text-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| body | object | no | JSON request body |

### Send a media message via a URL
`POST https://apizie.tech/v1/business:megaapi/send-message-controller-send-media-via-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| body | object | no | JSON request body |

### Send a media message via Base64
`POST https://apizie.tech/v1/business:megaapi/send-message-controller-send-media-base64` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| body | object | no | JSON request body |

### Send an location to an WhatsApp User
`POST https://apizie.tech/v1/business:megaapi/send-message-controller-send-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| body | object | no | JSON request body |

### Send a message with link preview
`POST https://apizie.tech/v1/business:megaapi/send-message-controller-send-message-link-preview` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| body | object | no | JSON request body |

### Send an List Message to an User
`POST https://apizie.tech/v1/business:megaapi/send-message-controller-list-message-to-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| body | object | no | JSON request body |

### Send an Vcard message to an User
`POST https://apizie.tech/v1/business:megaapi/send-message-controller-send-vcard-message-to-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| body | object | no | JSON request body |

### Forward message to User
`POST https://apizie.tech/v1/business:megaapi/send-message-controller-forward-to-user-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| body | object | no | JSON request body |

### Quote message for User
`POST https://apizie.tech/v1/business:megaapi/send-message-controller-quote-user-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| body | object | no | JSON request body |

### Change presence for chat
`POST https://apizie.tech/v1/business:megaapi/chat-controller-change-presence-for-chat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| body | object | no | JSON request body |

### Delete message in chat
`POST https://apizie.tech/v1/business:megaapi/chat-controller-delete-message-instance-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| body | object | no | JSON request body |

### Delete message fromMe in chat
`POST https://apizie.tech/v1/business:megaapi/chat-controller-delete-message-from-me` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| body | object | no | JSON request body |

### List all groups and communitys
`GET https://apizie.tech/v1/business:megaapi/group-controller-list-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |

### Get a group info
`GET https://apizie.tech/v1/business:megaapi/group-controller-get-group-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| jid | string | no |  |

### Create a group
`POST https://apizie.tech/v1/business:megaapi/group-controller-create-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| body | object | no | JSON request body |

### Add participants to a group
`POST https://apizie.tech/v1/business:megaapi/group-controller-add-participants-to-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| body | object | no | JSON request body |

### Remove participants from group
`POST https://apizie.tech/v1/business:megaapi/group-controller-remove-participants` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| body | object | no | JSON request body |

### Leave group
`POST https://apizie.tech/v1/business:megaapi/group-controller-leave-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_key | string | yes |  |
| jid | string | no |  |

## Example
```
curl "https://apizie.tech/v1/business:megaapi/instance-controller-get-instance-status" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Documentation MegaAPI API?
Create a free Apizie key, then send GET https://apizie.tech/v1/business:megaapi/instance-controller-get-instance-status with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Documentation MegaAPI API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Documentation MegaAPI itself also needs your own key from apistart01.megaapi.com.br.

### Can AI agents use the Documentation MegaAPI API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key business:megaapi.

### What is the status of the Documentation MegaAPI API?
Needs your own provider key (bring your own key)