### GET /instance/connect/{instance}

Source: https://doc.evolution-api.com/v2/api-reference/instance-controller/instance-connect

Generates and returns the QR code for WhatsApp connection.

```APIDOC
## GET /instance/connect/{instance}

### Description
Generates and returns the QR code for WhatsApp connection.

### Method
GET

### Endpoint
/instance/connect/{instance}

### Parameters
#### Path Parameters
- **instance** (string) - Required - Name of the instance to connect

#### Query Parameters
- **number** (string) - Optional - Phone number (with country code) to be connected

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **pairingCode** (string) - The unique code used for pairing a device or account.
- **code** (string) - A specific code associated with the pairing process. This may include tokens or other identifiers.
- **count** (integer) - The count or number of attempts or instances related to the pairing process.

#### Response Example
```json
{
  "pairingCode": "WZYEH1YY",
  "code": "2@y8eK+bjtEjUWy9/FOM...",
  "count": 1
}
```

#### Error Response (404)
- **status** (integer) - The HTTP status of the response
- **error** (string) - The error message indicating the type of error
- **response** (object) - Contains detailed error messages
  - **message** (array of strings) - List of detailed error messages

#### Response Example
```json
{
  "status": 404,
  "error": "Not Found",
  "response": {
    "message": [
      "The \"invalid-instance\" instance does not exist"
    ]
  }
}
```
```

--------------------------------

### GET /n8n/find/{instance}

Source: https://doc.evolution-api.com/v2/api-reference/integrations/n8n/find-n8n

Fetches n8n bots for a specified instance.

```APIDOC
## GET /n8n/find/{instance}

### Description
Fetches n8n bots.

### Method
GET

### Endpoint
/n8n/find/{instance}

### Parameters
#### Path Parameters
- **instance** (string) - Required - Name of the instance

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **message** (string) - OK

#### Response Example
```json
{
  "message": "OK"
}
```
```

--------------------------------

### OpenAPI Specification for Instance Connect

Source: https://doc.evolution-api.com/v2/api-reference/instance-controller/instance-connect

This OpenAPI v3 specification defines the GET /instance/connect/{instance} endpoint. It details parameters for connecting an instance and retrieving a QR code for WhatsApp pairing. The response includes pairing codes and status information.

```yaml
openapi: 3.0.3
info:
  title: Evolution API
  version: 2.1.1
servers:
  - url: https://{server-url}
    variables:
      server-url:
        default: evolution-example
        description: The URL of your EvolutionAPI server
    description: Your instance domain
security: []
paths:
  /instance/connect/{instance}:
    get:
      tags:
        - Instance Controller
      summary: Instances Connect
      description: Generates and returns the QR code for WhatsApp connection
      operationId: instanceConnect
      parameters:
        - name: instance
          in: path
          required: true
          description: Name of the instance to connect
          schema:
            type: string
        - name: number
          description: Phone number (with country code) to be connected
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  pairingCode:
                    type: string
                    description: The unique code used for pairing a device or account.
                  code:
                    type: string
                    description: >-
                      A specific code associated with the pairing process. This
                      may include tokens or other identifiers.
                  count:
                    type: integer
                    description: >-
                      The count or number of attempts or instances related to
                      the pairing process.
                example:
                  pairingCode: WZYEH1YY
                  code: 2@y8eK+bjtEjUWy9/FOM...
                  count: 1
        '404':
          description: Instance not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: The HTTP status of the response
                  error:
                    type: string
                    description: The error message indicating the type of error
                  response:
                    type: object
                    properties:
                      message:
                        type: array
                        items:
                          type: string
                        description: List of detailed error messages
                example:
                  status: 404
                  error: Not Found
                  response:
                    message:
                      - The "invalid-instance" instance does not exist
      deprecated: false
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: Your authorization key header

```

--------------------------------

### GET /group/fetchAllGroups/{instance}

Source: https://doc.evolution-api.com/v2/api-reference/group-controller/fetch-all-groups

Fetches all groups for a given instance. You can optionally include group participants in the response.

```APIDOC
## GET /group/fetchAllGroups/{instance}

### Description
Fetch all groups for a given instance. This endpoint allows you to retrieve a list of all groups associated with your Evolution API instance.

### Method
GET

### Endpoint
/group/fetchAllGroups/{instance}

### Parameters
#### Path Parameters
- **instance** (string) - Required - The name of the instance for which to fetch groups.

#### Query Parameters
- **getParticipants** (boolean) - Required - Whether to include the list of participants for each group in the response.

### Request Example
```bash
curl -X GET \
  'https://evolution-example.com/group/fetchAllGroups/your_instance_name?getParticipants=true' \
  -H 'apikey: YOUR_API_KEY'
```

### Response
#### Success Response (200)
- **id** (string) - The ID of the group.
- **subject** (string) - The subject (name) of the group.
- **subjectOwner** (string) - The ID of the user who set the subject.
- **subjectTime** (integer) - The timestamp when the subject was set.
- **pictureUrl** (string) - URL of the group's profile picture.
- **size** (integer) - The number of participants in the group.
- **creation** (integer) - The timestamp when the group was created.
- **owner** (string) - The ID of the group owner.
- **desc** (string) - The description of the group.
- **descId** (string) - The ID of the description message.
- **restrict** (boolean) - Indicates if the group is restricted (only admins can send messages).
- **announce** (boolean) - Indicates if the group is an announcement group (only admins can send messages).

#### Response Example
```json
[
  {
    "id": "120363295648424210@g.us",
    "subject": "Example Group",
    "subjectOwner": "553198296801@s.whatsapp.net",
    "subjectTime": 1714769954,
    "pictureUrl": null,
    "size": 1,
    "creation": 1714769954,
    "owner": "553198296801@s.whatsapp.net",
    "desc": "optional",
    "descId": "BAE57E16498982ED",
    "restrict": false,
    "announce": false
  }
]
```
```

--------------------------------

### Find SQS

Source: https://doc.evolution-api.com/v2/api-reference/integrations/sqs/find-sqs

Find SQS instances within your Evolution API setup.

```APIDOC
## GET /sqs/find/{instance}

### Description
Find SQS

### Method
GET

### Endpoint
/sqs/find/{instance}

### Parameters
#### Path Parameters
- **instance** (string) - Required - Name of the instance

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **example** (object) - Description

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### GET /group/participants/{instance}

Source: https://doc.evolution-api.com/v2/api-reference/group-controller/find-participants

Fetches all participants for a given group instance.

```APIDOC
## GET /group/participants/{instance}

### Description
Fetch all group members.

### Method
GET

### Endpoint
/group/participants/{instance}

### Parameters
#### Path Parameters
- **instance** (string) - Required - Name of the instance 

#### Query Parameters
- **groupJid** (string) - Required - Group remote JID

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **participants** (array) - List of participants in the group.
  - **id** (string) - The ID of the participant.
  - **admin** (string) - The role of the participant (e.g., 'admin', 'superadmin').

#### Response Example
```json
{
  "participants": [
    {
      "id": "553198296801@s.whatsapp.net",
      "admin": "superadmin"
    }
  ]
}
```
```

--------------------------------

### GET /openai/fetchSessions/:openaiBotId/{instance}

Source: https://doc.evolution-api.com/v2/api-reference/integrations/openai/find-session

Fetches the sessions of the specified OpenAI bot instance.

```APIDOC
## GET /openai/fetchSessions/:openaiBotId/{instance}

### Description
Fetches the sessions of the specified OpenAI bot instance.

### Method
GET

### Endpoint
/openai/fetchSessions/:openaiBotId/{instance}

### Parameters
#### Path Parameters
- **openaiBotId** (string) - Required - ID of the OpenAI bot
- **instance** (string) - Required - Name of the instance

### Response
#### Success Response (200)
- **message** (string) - Example: OK

#### Error Responses
- **400** - Bad Request - Invalid parameters
- **404** - Not Found - No sessions found for the given bot and instance
- **500** - Internal Server Error
```

--------------------------------

### GET /evoai/fetchSessions/:evoaiId/{instance}

Source: https://doc.evolution-api.com/v2/api-reference/integrations/evoai/find-status

Retrieves active sessions for a specific EvoAI bot based on the bot ID and instance.

```APIDOC
## GET /evoai/fetchSessions/:evoaiId/{instance}

### Description
Recupera as sessões ativas de um bot EvoAI específico, com base no ID do bot (`evoaiId`) e na instância do bot (`instance`).

### Method
GET

### Endpoint
/evoai/fetchSessions/:evoaiId/{instance}

### Parameters
#### Path Parameters
- **evoaiId** (string) - Required - ID único do bot EvoAI.
- **instance** (string) - Required - Nome da instância.

### Response
#### Success Response (200)
- **sessions** (string) - Description of the active sessions.

#### Response Example
```json
{
  "sessions": "[Active sessions data]"
}
```
```

--------------------------------

### Fetch Group Invite Code OpenAPI Specification

Source: https://doc.evolution-api.com/v2/api-reference/group-controller/fetch-invite-code

This OpenAPI v3 specification defines the GET /group/inviteCode/{instance} endpoint. It requires an instance name and group JID to fetch a WhatsApp group invite URL and code. The API key must be provided in the 'apikey' header.

```yaml
openapi: 3.0.3
info:
  title: Evolution API
  version: 2.1.1
servers:
  - url: https://{server-url}
    variables:
      server-url:
        default: evolution-example
        description: The URL of your EvolutionAPI server
    description: Your instance domain
security: []
paths:
  /group/inviteCode/{instance}:
    get:
      tags:
        - Group Controller
      summary: Fetch Group Invite Code
      description: Fetch group invite code
      operationId: fetchInviteCode
      parameters:
        - name: instance
          in: path
          required: true
          description: 'Name of the instance '
          schema:
            type: string
        - name: groupJid
          description: Group remote JID
          required: true
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  inviteUrl:
                    type: string
                    description: The URL for the WhatsApp group invite.
                  inviteCode:
                    type: string
                    description: The code for the WhatsApp group invite.
                example:
                  inviteUrl: https://chat.whatsapp.com/DgQvyfXzY01B6rGrpZpYze
                  inviteCode: DgQvyfXzY01B6rGrpZpYze
      deprecated: false
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: Your authorization key header

```

--------------------------------

### OpenAPI Specification for Finding OpenAI Credentials

Source: https://doc.evolution-api.com/v2/api-reference/integrations/openai/find-creds-openai

This OpenAPI v3 specification defines the GET /openai/creds/{instance} endpoint. It requires an API key for authentication and retrieves OpenAI credentials for a given instance. The server URL is configurable.

```yaml
openapi: 3.0.3
info:
  title: Evolution API
  version: 2.1.1
servers:
  - url: https://{server-url}
    variables:
      server-url:
        default: evolution-example
        description: The URL of your EvolutionAPI server
    description: Your instance domain
security: []
paths:
  /openai/creds/{instance}:
    get:
      tags:
        - OpenIA Controller
      summary: Find OpenAI Creds
      description: Get OpenAI Creds
      operationId: getBotOpenAICreds
      parameters:
        - name: instance
          in: path
          required: true
          description: Name of the instance
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content: {}
      deprecated: false
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: Your authorization key header

```

--------------------------------

### POST /evoai/create/{instance}

Source: https://doc.evolution-api.com/v2/api-reference/integrations/evoai/create-evoai

Creates a new EvoAI bot with the provided configuration.

```APIDOC
## POST /evoai/create/{instance}

### Description
Creates a new EvoAI bot with the provided configuration.

### Method
POST

### Endpoint
/evoai/create/{instance}

### Parameters
#### Path Parameters
- **instance** (string) - Required - Name of the instance

#### Request Body
- **enabled** (boolean) - Required
- **agentUrl** (string) - Required
- **apiKey** (string) - Required
- **triggerType** (string) - Optional - Enum: all, keyword
- **triggerOperator** (string) - Optional - Enum: contains, equals, startsWith, endsWith, regex, none
- **triggerValue** (string) - Optional
- **expire** (integer) - Optional
- **keywordFinish** (string) - Optional
- **delayMessage** (integer) - Optional
- **unknownMessage** (string) - Optional
- **listeningFromMe** (boolean) - Optional
- **stopBotFromMe** (boolean) - Optional
- **keepOpen** (boolean) - Optional
- **debounceTime** (integer) - Optional
- **ignoreJids** (array) - Optional - Items: string

### Request Example
```json
{
  "enabled": true,
  "agentUrl": "https://example.com/agent",
  "apiKey": "YOUR_API_KEY",
  "triggerType": "keyword",
  "triggerValue": "help",
  "expire": 3600,
  "ignoreJids": [
    "user1@example.com",
    "user2@example.com"
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - EvoAI bot instance created successfully

#### Response Example
```json
{
  "message": "EvoAI bot instance created successfully"
}
```

#### Error Responses
- **400**: Bad Request - Invalid or missing parameters
- **404**: Not Found - Instance could not be created
- **500**: Internal Server Error
```

--------------------------------

### POST /instance/create

Source: https://doc.evolution-api.com/v2/api-reference/instance-controller/create-instance-basic

Creates a new instance for the Evolution API. This endpoint allows for the configuration of various WhatsApp and webhook settings.

```APIDOC
## POST /instance/create

### Description
Creates a new instance for the Evolution API. This endpoint allows for the configuration of various WhatsApp and webhook settings.

### Method
POST

### Endpoint
/instance/create

### Parameters
#### Request Body
- **instanceName** (string) - Required - Instance name
- **token** (string) - Optional - API key (Enter or leave empty to create dynamically)
- **qrcode** (boolean) - Optional - Create QR Code automatically after creation
- **number** (string) - Optional - Instance owner number with Country Code (e.g., 559999999999)
- **integration** (string) - Required - WhatsApp engine (enum: WHATSAPP-BAILEYS, WHATSAPP-BUSINESS)
- **rejectCall** (boolean) - Optional - Reject WhatsApp calls automatically
- **msgCall** (string) - Optional - Message to be sent when a call is rejected automatically
- **groupsIgnore** (boolean) - Optional - Ignore group messages
- **alwaysOnline** (boolean) - Optional - Keep WhatsApp always online
- **readMessages** (boolean) - Optional - Send read receipts to received messages
- **readStatus** (boolean) - Optional - Show sent messages read status
- **syncFullHistory** (boolean) - Optional - Synchronize full WhatsApp history with EvolutionAPI
- **proxyHost** (string) - Optional - Proxy host
- **proxyPort** (string) - Optional - Proxy port
- **proxyProtocol** (string) - Optional - Proxy protocol
- **proxyUsername** (string) - Optional - Proxy Username
- **proxyPassword** (string) - Optional - Proxy password
- **webhook** (object) - Optional - Webhook configuration
  - **webhook.url** (string) - Optional - The URL of the webhook.
  - **webhook.byEvents** (boolean) - Optional - Enable Webhook by events
  - **webhook.base64** (boolean) - Optional - Sends files in base64 when available
  - **webhook.headers** (object) - Optional - Headers for sending the API from webhook
    - **webhook.headers.authorization** (string) - Optional - Your authorization key header
    - **webhook.headers.Content-Type** (string) - Optional - Content-Type
  - **webhook.events** (array) - Optional - List of events to trigger webhook
    - (string) - enum: APPLICATION_STARTUP, QRCODE_UPDATED, MESSAGES_SET, MESSAGES_UPSERT, MESSAGES_UPDATE, MESSAGES_DELETE, SEND_MESSAGE, CONTACTS_SET, CONTACTS_UPSERT, CONTACTS_UPDATE, PRESENCE_UPDATE, CHATS_SET, CHATS_UPSERT, CHATS_UPDATE, CHATS_DELETE, GROUPS_UPSERT, GROUP_UPDATE, GROUP_PARTICIPANTS_UPDATE, CONNECTION_UPDATE, CALL, NEW_JWT_TOKEN, TYPEBOT_START, TYPEBOT_CHANGE_STATUS

### Request Example
{
  "instanceName": "my-instance",
  "integration": "WHATSAPP-BAILEYS",
  "token": "your-api-key",
  "qrcode": true,
  "webhook": {
    "url": "https://your-webhook.com/callback",
    "byEvents": true,
    "events": [
      "MESSAGES_UPSERT",
      "QRCODE_UPDATED"
    ]
  }
}

### Response
#### Success Response (200)
- **instance** (object) - Details of the created instance.
  - **instance.id** (string) - The unique identifier for the instance.
  - **instance.name** (string) - The name of the instance.
  - **instance.status** (string) - The current status of the instance.

#### Response Example
{
  "instance": {
    "id": "instance-123",
    "name": "my-instance",
    "status": "connected"
  }
}
```

--------------------------------

### Find Settings

Source: https://doc.evolution-api.com/v2/api-reference/settings/get

Fetch Webhook configuration for a given instance.

```APIDOC
## GET /settings/find/{instance}

### Description
Fetch Webhook configuration.

### Method
GET

### Endpoint
/settings/find/{instance}

### Parameters
#### Path Parameters
- **instance** (string) - Required - Name of the instance to get settings

### Request Example
(No request body for GET request)

### Response
#### Success Response (200)
- **reject_call** (boolean) - Indicates whether to reject incoming calls.
- **groups_ignore** (boolean) - Indicates whether to ignore group messages.
- **always_online** (boolean) - Indicates whether to always keep the instance online.
- **read_messages** (boolean) - Indicates whether to mark messages as read.
- **read_status** (boolean) - Indicates whether to read status updates.
- **sync_full_history** (boolean) - Indicates whether to synchronize full message history.

#### Response Example
```json
{
  "reject_call": true,
  "groups_ignore": true,
  "always_online": true,
  "read_messages": true,
  "read_status": true,
  "sync_full_history": false
}
```
```

--------------------------------

### POST /settings/set/{instance}

Source: https://doc.evolution-api.com/v2/api-reference/settings/set

Set various settings for a specific instance, such as call rejection, group message handling, and synchronization options.

```APIDOC
## POST /settings/set/{instance}

### Description
Set settings for a specific instance.

### Method
POST

### Endpoint
/settings/set/{instance}

### Parameters
#### Path Parameters
- **instance** (string) - Required - Name of the instance

#### Request Body
- **rejectCall** (boolean) - Required - Reject calls automatically
- **msgCall** (string) - Required - Message to be sent when a call is rejected automatically
- **groupsIgnore** (boolean) - Required - Ignore group messages
- **alwaysOnline** (boolean) - Required - Always show WhatsApp online
- **readMessages** (boolean) - Required - Send read receipts
- **readStatus** (boolean) - Required - See message status
- **syncFullHistory** (boolean) - Required - Synchronize full WhatsApp history with EvolutionAPI

### Request Example
```json
{
  "rejectCall": true,
  "msgCall": "I am busy right now.",
  "groupsIgnore": true,
  "alwaysOnline": true,
  "readMessages": true,
  "readStatus": true,
  "syncFullHistory": false
}
```

### Response
#### Success Response (201)
- **settings** (object) - Contains instance settings information.
  - **instanceName** (string) - The name of the instance.
  - **settings** (object) - Detailed settings for the instance.
    - **reject_call** (boolean) - Indicates whether to reject incoming calls.
    - **groups_ignore** (boolean) - Indicates whether to ignore group messages.
    - **always_online** (boolean) - Indicates whether to always keep the instance online.
    - **read_messages** (boolean) - Indicates whether to mark messages as read.
    - **read_status** (boolean) - Indicates whether to read status updates.
    - **sync_full_history** (boolean) - Indicates whether to synchronize full message history.

#### Response Example
```json
{
  "settings": {
    "instanceName": "teste-docs",
    "settings": {
      "reject_call": true,
      "groups_ignore": true,
      "always_online": true,
      "read_messages": true,
      "read_status": true,
      "sync_full_history": false
    }
  }
}
```
```

--------------------------------

### POST /dify/create/{instance}

Source: https://doc.evolution-api.com/v2/api-reference/integrations/dify/create-dify

Creates a new Dify bot instance with the specified configuration.

```APIDOC
## POST /dify/create/{instance}

### Description
Creates a new Dify bot with the provided configuration.

### Method
POST

### Endpoint
/dify/create/{instance}

### Parameters
#### Path Parameters
- **instance** (string) - Required - Name of the instance

#### Request Body
- **enabled** (boolean) - Required
- **botType** (string) - Required - Enum: chatBot, textGenerator, agent, workflow
- **apiUrl** (string) - Required
- **apiKey** (string) - Required
- **triggerType** (string) - Optional - Enum: all, keyword
- **triggerOperator** (string) - Optional - Enum: contains, equals, startsWith, endsWith, regex, none
- **triggerValue** (string) - Optional
- **expire** (integer) - Optional
- **keywordFinish** (string) - Optional
- **delayMessage** (integer) - Optional
- **unknownMessage** (string) - Optional
- **listeningFromMe** (boolean) - Optional
- **stopBotFromMe** (boolean) - Optional
- **keepOpen** (boolean) - Optional
- **debounceTime** (integer) - Optional
- **ignoreJids** (array) - Optional - Items: string

### Request Example
```json
{
  "enabled": true,
  "botType": "chatBot",
  "apiUrl": "https://api.example.com",
  "apiKey": "YOUR_API_KEY",
  "triggerType": "keyword",
  "triggerValue": "help",
  "expire": 3600,
  "ignoreJids": [
    "user1@example.com",
    "user2@example.com"
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - Bot instance created successfully

#### Response Example
```json
{
  "message": "Bot instance created successfully"
}
```

#### Error Responses
- **400**: Bad Request - Invalid or missing parameters
- **404**: Not Found - Instance could not be created
- **500**: Internal Server Error
```

--------------------------------

### POST /group/create/{instance}

Source: https://doc.evolution-api.com/v2/api-reference/group-controller/group-create

Creates a new group with the specified subject, description, and participants. The instance parameter specifies the target instance for group creation.

```APIDOC
## POST /group/create/{instance}

### Description
Create group

### Method
POST

### Endpoint
/group/create/{instance}

### Parameters
#### Path Parameters
- **instance** (string) - Required - Name of the instance 

#### Request Body
- **subject** (object) - Required - Group subject
- **description** (string) - Required - Group description
- **participants** (array) - Required - Group members phone numbers with country code
  - items: (string)

### Request Example
```json
{
  "subject": {},
  "description": "string",
  "participants": [
    "string"
  ]
}
```

### Response
#### Success Response (200)
- **Ok** (object) - Description: Ok

#### Response Example
```json
{}
```
```

--------------------------------

### POST /flowise/create/{instance}

Source: https://doc.evolution-api.com/v2/api-reference/integrations/flowise/create-bot

Creates a new Flowise instance with the specified configuration.

```APIDOC
## POST /flowise/create/{instance}

### Description
Creates a new Flowise instance with the specified configuration.

### Method
POST

### Endpoint
/flowise/create/{instance}

### Parameters
#### Path Parameters
- **instance** (string) - Required - Nome da instância

#### Request Body
- **enabled** (boolean) - Required - Indica se a instância está habilitada ou não.
- **apiUrl** (string) - Required - URL da API do Flowise.
- **apiKey** (string) - Optional - Chave de API (opcional).
- **triggerType** (string) - Required - Tipo de gatilho para o bot. Enum: all, keyword
- **triggerOperator** (string) - Required - Operador para o gatilho. Enum: contains, equals, startsWith, endsWith, regex, none
- **triggerValue** (string) - Required - Valor do gatilho.
- **expire** (integer) - Optional - Tempo de expiração do bot em minutos.
- **keywordFinish** (string) - Optional - Palavra-chave para encerrar a interação.
- **delayMessage** (integer) - Optional - Tempo de atraso para a mensagem, em milissegundos.
- **unknownMessage** (string) - Optional - Mensagem padrão quando a entrada não for reconhecida.
- **listeningFromMe** (boolean) - Optional - Indica se o bot deve ouvir apenas mensagens enviadas por você.
- **stopBotFromMe** (boolean) - Optional - Indica se o bot deve ser parado quando você enviar uma mensagem.
- **keepOpen** (boolean) - Optional - Indica se a instância do bot deve permanecer aberta.
- **debounceTime** (integer) - Optional - Tempo de debounce para a entrada, em milissegundos.
- **ignoreJids** (array) - Optional - Lista de JIDs (identificadores de usuário) que o bot deve ignorar.

### Request Example
```json
{
  "enabled": true,
  "apiUrl": "http://dify.site.com/v1",
  "apiKey": "app-123456",
  "triggerType": "keyword",
  "triggerOperator": "equals",
  "triggerValue": "teste",
  "expire": 0,
  "keywordFinish": "#SAIR",
  "delayMessage": 1000,
  "unknownMessage": "Mensagem não reconhecida",
  "listeningFromMe": false,
  "stopBotFromMe": false,
  "keepOpen": false,
  "debounceTime": 0,
  "ignoreJids": [
    "1234567890@s.whatsapp.net"
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - Instância do Flowise criada com sucesso

#### Response Example
```json
{
  "message": "Instância do Flowise criada com sucesso"
}
```

#### Error Response (400)
- **error** (string) - Parâmetros inválidos fornecidos

#### Error Response (404)
- **error** (string) - Instância não encontrada
```

--------------------------------

### POST /openai/settings/{instance}

Source: https://doc.evolution-api.com/v2/api-reference/integrations/openai/settings-openai

Set settings for an OpenAI bot instance. This endpoint allows you to configure various aspects of an OpenAI bot, such as credentials, message delays, keywords, and listening behavior.

```APIDOC
## POST /openai/settings/{instance}

### Description
Set settings for an OpenAI bot instance.

### Method
POST

### Endpoint
/openai/settings/{instance}

### Parameters
#### Path Parameters
- **instance** (string) - Required - Name of the instance

#### Request Body
- **openaiCredsId** (string) - Required - The OpenAI credentials ID
- **expire** (integer) - Required - Expiration time in seconds
- **keywordFinish** (string) - Required - Keyword to finish the interaction
- **delayMessage** (integer) - Required - Delay time for the message in milliseconds
- **unknownMessage** (string) - Required - Message when the input is not recognized
- **listeningFromMe** (boolean) - Required - Indicates if the bot is listening for commands from the user
- **stopBotFromMe** (boolean) - Required - Indicates if the bot should stop upon user command
- **keepOpen** (boolean) - Required - Indicates if the bot session should remain open
- **debounceTime** (integer) - Required - Time in milliseconds to wait before processing the next input
- **ignoreJids** (array[string]) - Required - List of JIDs (Jabber IDs) to ignore
- **openaiIdFallback** (string) - Required - Fallback OpenAI credentials ID if the main one fails

### Request Example
{
  "openaiCredsId": "creds_123",
  "expire": 3600,
  "keywordFinish": "goodbye",
  "delayMessage": 500,
  "unknownMessage": "I don't understand.",
  "listeningFromMe": true,
  "stopBotFromMe": true,
  "keepOpen": false,
  "debounceTime": 1000,
  "ignoreJids": ["user1@example.com", "user2@example.com"],
  "openaiIdFallback": "fallback_creds_456"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the update was successful
- **message** (string) - Details about the operation

#### Response Example
{
  "success": true,
  "message": "OpenAI settings updated successfully."
}
```

--------------------------------

### POST /chatwoot/set/{instance}

Source: https://doc.evolution-api.com/v2/api-reference/integrations/chatwoot/set-chatwoot

Sets the configuration for Chatwoot integration for a specific instance.

```APIDOC
## POST /chatwoot/set/{instance}

### Description
Set Chatwoot

### Method
POST

### Endpoint
/chatwoot/set/{instance}

### Parameters
#### Path Parameters
- **instance** (string) - Required - Name of the instance

#### Request Body
- **enabled** (boolean) - Required - Enable chatwoot
- **accountId** (string) - Required - Chatwoot account ID
- **token** (string) - Required - Chatwoot token
- **url** (string) - Required - Chatwoot server URL
- **signMsg** (boolean) - Required - Sign message with user name
- **reopenConversation** (boolean) - Required - 
- **conversationPending** (boolean) - Required - 
- **nameInbox** (string) - Required - Name inbox chatwoot
- **mergeBrazilContacts** (boolean) - Required - 
- **importContacts** (boolean) - Required - Import Chatwoot contacts
- **importMessages** (boolean) - Required - Import chatwoot messages
- **daysLimitImportMessages** (integer) - Required - 
- **signDelimiter** (string) - Required - Break line
- **autoCreate** (boolean) - Required - 
- **organization** (string) - Required - Name organization
- **logo** (string) - Required - Url logo
- **ignoreJids** (array) - Required - Jids ignore
  - **items** (string) - Description: Jids ignore

### Request Example
{
  "enabled": true,
  "accountId": "string",
  "token": "string",
  "url": "string",
  "signMsg": true,
  "reopenConversation": true,
  "conversationPending": true,
  "nameInbox": "string",
  "mergeBrazilContacts": true,
  "importContacts": true,
  "importMessages": true,
  "daysLimitImportMessages": 0,
  "signDelimiter": "string",
  "autoCreate": true,
  "organization": "string",
  "logo": "string",
  "ignoreJids": [
    "string"
  ]
}

### Response
#### Success Response (200)
- (empty object)

#### Response Example
{}

```

--------------------------------

### POST /dify/settings/{instance}

Source: https://doc.evolution-api.com/v2/api-reference/integrations/dify/set-settings-dify

Updates the Dify bot settings for a specific instance.

```APIDOC
## POST /dify/settings/{instance}

### Description
Updates the Dify bot settings for a specific instance.

### Method
POST

### Endpoint
/dify/settings/{instance}

### Parameters
#### Path Parameters
- **instance** (string) - Required - Nome da instância

#### Request Body
- **expire** (integer) - Required - Tempo de expiração em minutos.
- **keywordFinish** (string) - Required - Palavra-chave que finalizará o bot.
- **delayMessage** (integer) - Required - Tempo de delay antes do envio de uma nova mensagem (em milissegundos).
- **unknownMessage** (string) - Required - Mensagem que será enviada quando o bot não reconhecer o comando.
- **listeningFromMe** (boolean) - Required - Define se o bot deve ouvir mensagens enviadas pelo próprio usuário.
- **stopBotFromMe** (boolean) - Required - Define se o bot deve parar ao receber mensagens enviadas pelo próprio usuário.
- **keepOpen** (boolean) - Required - Define se o bot deve manter a conversa aberta após uma resposta.
- **debounceTime** (integer) - Required - Tempo de debounce (em milissegundos).
- **ignoreJids** (array) - Required - Lista de JIDs a serem ignorados.
- **difyIdFallback** (string) - Required - ID de fallback do bot Dify.

### Request Example
{
  "expire": 20,
  "keywordFinish": "#SAIR",
  "delayMessage": 1000,
  "unknownMessage": "Mensagem não reconhecida",
  "listeningFromMe": false,
  "stopBotFromMe": false,
  "keepOpen": false,
  "debounceTime": 0,
  "ignoreJids": [],
  "difyIdFallback": "clyja4oys0a3uqpy7k3bd7swe"
}

### Response
#### Success Response (200)
- **message** (string) - Configurações do bot Dify atualizadas com sucesso

#### Response Example
{
  "message": "Configurações do bot Dify atualizadas com sucesso"
}
```

--------------------------------

### Restart Instance

Source: https://doc.evolution-api.com/v2/api-reference/instance-controller/restart-instance

Restarts a specified instance.

```APIDOC
## PUT /instance/restart/{instance}

### Description
Restarts the instance.

### Method
PUT

### Endpoint
/instance/restart/{instance}

### Parameters
#### Path Parameters
- **instance** (string) - Required - Name of the instance to restart

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **instance** (object) - Description of the instance details
  - **instanceName** (string) - The name of the instance.
  - **state** (string) - The state of the instance.

#### Response Example
```json
{
  "instance": {
    "instanceName": "teste-docs",
    "state": "open"
  }
}
```

#### Error Response (404)
- **status** (integer) - The HTTP status of the response
- **error** (string) - The error message indicating the type of error
- **response** (object) - Details about the error response
  - **message** (array of strings) - List of detailed error messages

#### Response Example
```json
{
  "status": 404,
  "error": "Not Found",
  "response": {
    "message": [
      "The \"invalid-instance\" instance does not exist"
    ]
  }
}
```
```

--------------------------------

### Set RabbitMQ Configuration

Source: https://doc.evolution-api.com/v2/api-reference/integrations/rabbitmq/set-rabbitmq

Configure RabbitMQ settings for your instance, including enabling it and selecting which events to receive.

```APIDOC
## POST /rabbitmq/set/{instance}

### Description
Set RabbitMQ configuration for a specific instance.

### Method
POST

### Endpoint
/rabbitmq/set/{instance}

### Parameters
#### Path Parameters
- **instance** (string) - Required - Name of the instance

#### Request Body
- **rabbitmq** (object) - Required - RabbitMQ configuration object
  - **enabled** (boolean) - Optional - Whether RabbitMQ is enabled
  - **events** (array) - Optional - Events to be sent to the Webhook. Possible values: APPLICATION_STARTUP, QRCODE_UPDATED, MESSAGES_SET, MESSAGES_UPSERT, MESSAGES_UPDATE, MESSAGES_DELETE, SEND_MESSAGE, CONTACTS_SET, CONTACTS_UPSERT, CONTACTS_UPDATE, PRESENCE_UPDATE, CHATS_SET, CHATS_UPSERT, CHATS_UPDATE, CHATS_DELETE, GROUPS_UPSERT, GROUP_UPDATE, GROUP_PARTICIPANTS_UPDATE, CONNECTION_UPDATE, LABELS_EDIT, LABELS_ASSOCIATION, CALL, TYPEBOT_START, TYPEBOT_CHANGE_STATUS

### Request Example
```json
{
  "rabbitmq": {
    "enabled": true,
    "events": [
      "APPLICATION_STARTUP",
      "MESSAGES_UPSERT"
    ]
  }
}
```

### Response
#### Success Response (200)
- **description**: Ok

#### Response Example
```json
{}
```
```

--------------------------------

### Documentation Index

Source: https://doc.evolution-api.com/v2/api-reference/integrations/sqs/find-sqs

Fetch the complete documentation index to discover all available pages.

```APIDOC
## Documentation Index

Fetch the complete documentation index at: https://doc.evolution-api.com/llms.txt

Use this file to discover all available pages before exploring further.
```

--------------------------------

### Set Instance Settings OpenAPI Specification

Source: https://doc.evolution-api.com/v2/api-reference/settings/set

This OpenAPI specification defines the POST /settings/set/{instance} endpoint. Use this to configure settings such as rejecting calls, ignoring group messages, always staying online, sending read receipts, and synchronizing message history.

```yaml
openapi: 3.0.3
info:
  title: Evolution API
  version: 2.1.1
servers:
  - url: https://{server-url}
    variables:
      server-url:
        default: evolution-example
        description: The URL of your EvolutionAPI server
    description: Your instance domain
security: []
paths:
  /settings/set/{instance}:
    post:
      tags:
        - Settings Controller
      summary: Set Settings
      description: Set settings
      operationId: setSettings
      parameters:
        - name: instance
          in: path
          required: true
          description: Name of the instance
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - rejectCall
                - groupsIgnore
                - alwaysOnline
                - readMessages
                - readStatus
                - syncFullHistory
                - msgCall
              properties:
                rejectCall:
                  type: boolean
                  description: Reject calls automatically
                msgCall:
                  type: string
                  description: Message to be sent when a call is rejected automatically
                groupsIgnore:
                  type: boolean
                  description: Ignore group messages
                alwaysOnline:
                  type: boolean
                  description: Always show WhatsApp online
                readMessages:
                  type: boolean
                  description: Send read receipts
                readStatus:
                  type: boolean
                  description: See message status
                syncFullHistory:
                  type: boolean
                  description: Syncronize full WhatsApp history with EvolutionAPI
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  settings:
                    type: object
                    properties:
                      instanceName:
                        type: string
                        description: The name of the instance.
                      settings:
                        type: object
                        properties:
                          reject_call:
                            type: boolean
                            description: Indicates whether to reject incoming calls.
                          groups_ignore:
                            type: boolean
                            description: Indicates whether to ignore group messages.
                          always_online:
                            type: boolean
                            description: >-
                              Indicates whether to always keep the instance
                              online.
                          read_messages:
                            type: boolean
                            description: Indicates whether to mark messages as read.
                          read_status:
                            type: boolean
                            description: Indicates whether to read status updates.
                          sync_full_history:
                            type: boolean
                            description: >-
                              Indicates whether to synchronize full message
                              history.
                example:
                  settings:
                    instanceName: teste-docs
                    settings:
                      reject_call: true
                      groups_ignore: true
                      always_online: true
                      read_messages: true
                      read_status: true
                      sync_full_history: false
      deprecated: false
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: Your authorization key header

```

--------------------------------

### API Key Authentication

Source: https://doc.evolution-api.com/v2/api-reference/integrations/flowise/update-flowise-bot

This snippet shows how to configure API key authentication for your API. The key should be provided in the 'apikey' header.

```yaml
security:
  - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: Your authorization key header
```

--------------------------------

### Set SQS

Source: https://doc.evolution-api.com/v2/api-reference/integrations/sqs/set-sqs

Configure the SQS (Simple Queue Service) for receiving events from your Evolution API instance.

```APIDOC
## POST /sqs/set/{instance}

### Description
Set SQS configuration for a specific instance.

### Method
POST

### Endpoint
/sqs/set/{instance}

### Parameters
#### Path Parameters
- **instance** (string) - Required - Name of the instance

#### Request Body
- **sqs** (object) - Required - SQS configuration object
  - **enabled** (boolean) - Optional - Whether SQS is enabled
  - **events** (array) - Optional - List of events to be sent to the Webhook
    - **item** (string) - Enum: APPLICATION_STARTUP, QRCODE_UPDATED, MESSAGES_SET, MESSAGES_UPSERT, MESSAGES_UPDATE, MESSAGES_DELETE, SEND_MESSAGE, CONTACTS_SET, CONTACTS_UPSERT, CONTACTS_UPDATE, PRESENCE_UPDATE, CHATS_SET, CHATS_UPSERT, CHATS_UPDATE, CHATS_DELETE, GROUPS_UPSERT, GROUP_UPDATE, GROUP_PARTICIPANTS_UPDATE, CONNECTION_UPDATE, LABELS_EDIT, LABELS_ASSOCIATION, CALL, TYPEBOT_START, TYPEBOT_CHANGE_STATUS - Description of the event

### Request Example
```json
{
  "sqs": {
    "enabled": true,
    "events": [
      "APPLICATION_STARTUP",
      "MESSAGES_UPSERT"
    ]
  }
}
```

### Response
#### Success Response (200)
- **description** (string) - Ok

#### Response Example
```json
{}
```
```