Settigns config OpenAI - Evolution API Documentation

Set OpenAI Bot Settings

curl --request POST \
  --url https://{server-url}/openai/settings/{instance} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "openaiCredsId": "<string>",
  "expire": 123,
  "keywordFinish": "<string>",
  "delayMessage": 123,
  "unknownMessage": "<string>",
  "listeningFromMe": true,
  "stopBotFromMe": true,
  "keepOpen": true,
  "debounceTime": 123,
  "ignoreJids": [
    "<string>"
  ],
  "openaiIdFallback": "<string>"
}
'

import requests

url = "https://{server-url}/openai/settings/{instance}"

payload = {
    "openaiCredsId": "<string>",
    "expire": 123,
    "keywordFinish": "<string>",
    "delayMessage": 123,
    "unknownMessage": "<string>",
    "listeningFromMe": True,
    "stopBotFromMe": True,
    "keepOpen": True,
    "debounceTime": 123,
    "ignoreJids": ["<string>"],
    "openaiIdFallback": "<string>"
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    openaiCredsId: '<string>',
    expire: 123,
    keywordFinish: '<string>',
    delayMessage: 123,
    unknownMessage: '<string>',
    listeningFromMe: true,
    stopBotFromMe: true,
    keepOpen: true,
    debounceTime: 123,
    ignoreJids: ['<string>'],
    openaiIdFallback: '<string>'
  })
};

fetch('https://{server-url}/openai/settings/{instance}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{server-url}/openai/settings/{instance}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'openaiCredsId' => '<string>',
    'expire' => 123,
    'keywordFinish' => '<string>',
    'delayMessage' => 123,
    'unknownMessage' => '<string>',
    'listeningFromMe' => true,
    'stopBotFromMe' => true,
    'keepOpen' => true,
    'debounceTime' => 123,
    'ignoreJids' => [
        '<string>'
    ],
    'openaiIdFallback' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{server-url}/openai/settings/{instance}"

	payload := strings.NewReader("{\n  \"openaiCredsId\": \"<string>\",\n  \"expire\": 123,\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": 123,\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": true,\n  \"stopBotFromMe\": true,\n  \"keepOpen\": true,\n  \"debounceTime\": 123,\n  \"ignoreJids\": [\n    \"<string>\"\n  ],\n  \"openaiIdFallback\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{server-url}/openai/settings/{instance}")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"openaiCredsId\": \"<string>\",\n  \"expire\": 123,\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": 123,\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": true,\n  \"stopBotFromMe\": true,\n  \"keepOpen\": true,\n  \"debounceTime\": 123,\n  \"ignoreJids\": [\n    \"<string>\"\n  ],\n  \"openaiIdFallback\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{server-url}/openai/settings/{instance}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"openaiCredsId\": \"<string>\",\n  \"expire\": 123,\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": 123,\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": true,\n  \"stopBotFromMe\": true,\n  \"keepOpen\": true,\n  \"debounceTime\": 123,\n  \"ignoreJids\": [\n    \"<string>\"\n  ],\n  \"openaiIdFallback\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "<string>"
}

POST

/

openai

/

settings

/

{instance}

Set OpenAI Bot Settings

curl --request POST \
  --url https://{server-url}/openai/settings/{instance} \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "openaiCredsId": "<string>",
  "expire": 123,
  "keywordFinish": "<string>",
  "delayMessage": 123,
  "unknownMessage": "<string>",
  "listeningFromMe": true,
  "stopBotFromMe": true,
  "keepOpen": true,
  "debounceTime": 123,
  "ignoreJids": [
    "<string>"
  ],
  "openaiIdFallback": "<string>"
}
'

import requests

url = "https://{server-url}/openai/settings/{instance}"

payload = {
    "openaiCredsId": "<string>",
    "expire": 123,
    "keywordFinish": "<string>",
    "delayMessage": 123,
    "unknownMessage": "<string>",
    "listeningFromMe": True,
    "stopBotFromMe": True,
    "keepOpen": True,
    "debounceTime": 123,
    "ignoreJids": ["<string>"],
    "openaiIdFallback": "<string>"
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    openaiCredsId: '<string>',
    expire: 123,
    keywordFinish: '<string>',
    delayMessage: 123,
    unknownMessage: '<string>',
    listeningFromMe: true,
    stopBotFromMe: true,
    keepOpen: true,
    debounceTime: 123,
    ignoreJids: ['<string>'],
    openaiIdFallback: '<string>'
  })
};

fetch('https://{server-url}/openai/settings/{instance}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{server-url}/openai/settings/{instance}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'openaiCredsId' => '<string>',
    'expire' => 123,
    'keywordFinish' => '<string>',
    'delayMessage' => 123,
    'unknownMessage' => '<string>',
    'listeningFromMe' => true,
    'stopBotFromMe' => true,
    'keepOpen' => true,
    'debounceTime' => 123,
    'ignoreJids' => [
        '<string>'
    ],
    'openaiIdFallback' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{server-url}/openai/settings/{instance}"

	payload := strings.NewReader("{\n  \"openaiCredsId\": \"<string>\",\n  \"expire\": 123,\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": 123,\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": true,\n  \"stopBotFromMe\": true,\n  \"keepOpen\": true,\n  \"debounceTime\": 123,\n  \"ignoreJids\": [\n    \"<string>\"\n  ],\n  \"openaiIdFallback\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{server-url}/openai/settings/{instance}")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"openaiCredsId\": \"<string>\",\n  \"expire\": 123,\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": 123,\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": true,\n  \"stopBotFromMe\": true,\n  \"keepOpen\": true,\n  \"debounceTime\": 123,\n  \"ignoreJids\": [\n    \"<string>\"\n  ],\n  \"openaiIdFallback\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{server-url}/openai/settings/{instance}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"openaiCredsId\": \"<string>\",\n  \"expire\": 123,\n  \"keywordFinish\": \"<string>\",\n  \"delayMessage\": 123,\n  \"unknownMessage\": \"<string>\",\n  \"listeningFromMe\": true,\n  \"stopBotFromMe\": true,\n  \"keepOpen\": true,\n  \"debounceTime\": 123,\n  \"ignoreJids\": [\n    \"<string>\"\n  ],\n  \"openaiIdFallback\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "<string>"
}

Authorizations

apikey

string

header

required

Your authorization key header

Path Parameters

instance

string

required

Name of the instance

Body

application/json

Configuration for updating the OpenAI bot settings

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

string[]

required

List of JIDs (Jabber IDs) to ignore

openaiIdFallback

string

required

Fallback OpenAI credentials ID if the main one fails

Response

Successfully updated OpenAI bot settings

success

boolean

Indicates if the update was successful

message

string

Details about the operation