Chat Controller22

Chatwoot Controller2

Dify Controller10

EvoAI Controller8

Evolution Bot Controller5

Flowise Controller4

Group Controller17

Instance Controller8

Message Controller11

n8n Controller8

OpenAI Controller7

OpenIA Controller9

RabbitMQ Controller2

Settings Controller1

SQS Controller2

Typebot Controller11

Update group picture1

Webhook Controller3

Websocket Controller2

get/Get information about your EvolutionAPI

Instance Controller

Create Instance

Changed on Mar 5, 2025

post/instance/create

Request

Base URL
https://evolution-example
URL
https://evolution-example/instance/create
Auth
API key in header apikey

Request body

instanceNamestring required

instance (Instance name)

tokenstring

apikey (Enter or leave empty to create dynamically)

qrcodeboolean

Create QR Code automatically after creation

numberstring

559999999999 (Instance owner number with Country Code)

integration'WHATSAPP-BAILEYS' | 'WHATSAPP-BUSINESS' required

WhatsApp engine

rejectCallboolean

Reject WhatsApp calls automatically

msgCallstring

Message to be sent when a call is rejected automatically

groupsIgnoreboolean

Ignore group messages

alwaysOnlineboolean

Keep WhatsApp always online

readMessagesboolean

Send read receipts to received messages

readStatusboolean

Show sent messages read status

syncFullHistoryboolean

Syncronize full WhatsApp history with EvolutionAPI

proxyHoststring

proxy host

proxyPortstring

proxy port

proxyProtocolstring

proxy protocol

proxyUsernamestring

proxy Username

proxyPasswordstring

proxy password

chatwootAccountIdinteger

Chatwoot account ID

chatwootTokenstring

Chatwoot authentication token

chatwootUrlstring

Chatwoot server URL

chatwootSignMsgboolean

Send message signature on Chatwoot

chatwootReopenConversationboolean

Reopen conversation on Chatwoot

chatwootConversationPendingboolean

TODO

chatwootImportContactsboolean

Import Chatwoot contacts

chatwootNameInboxstring

Name inbox chatwoot

chatwootMergeBrazilContactsboolean

TODO

chatwootImportMessagesboolean

Import chatwoot messages

chatwootDaysLimitImportMessagesinteger

Limit message import chatwoot

chatwootOrganizationstring

Evolution Bot

chatwootLogostring

https://evolution-api.com/files/evolution-api-favicon.png

Response

Created

Example response

{
  "instance": {
    "instanceName": "teste-docs",
    "instanceId": "af6c5b7c-ee27-4f94-9ea8-192393746ddd",
    "webhook_wa_business": null,
    "access_token_wa_business": "",
    "status": "created"
  },
  "hash": {
    "apikey": "123456"
  },
  "settings": {
    "reject_call": false,
    "msg_call": "",
    "groups_ignore": true,
    "always_online": false,
    "read_messages": false,
    "read_status": false,
    "sync_full_history": false
  }
}

Changes

Mar 5, 2025v211f35f0c0508 Revision changes
- warning
  removed the request property //
- info
  added the new optional request property //
Nov 25, 2024v2c153448703e5 Revision changes
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  request body became required
- breaking
  removed the success response with the status
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the non-success response with the status
- info
  added the success response with the status

Operation history (4 revisions)