EVevolution-foundation
OpenAI Controller

Set OpenAI Bot Settings

Changed on

Set settings for an OpenAI bot instance.

post/openai/settings/{instance}

Request

  • Base URL
    https://evolution-example
  • URL
    https://evolution-example/openai/settings/{instance}
  • Auth
    API key in header apikey

Path parameters

instancestring required

Name of the instance

Request body

openaiCredsIdstring required

The OpenAI credentials ID

expireinteger required

Expiration time in seconds

keywordFinishstring required

Keyword to finish the interaction

delayMessageinteger required

Delay time for the message in milliseconds

unknownMessagestring required

Message when the input is not recognized

listeningFromMeboolean required

Indicates if the bot is listening for commands from the user

stopBotFromMeboolean required

Indicates if the bot should stop upon user command

keepOpenboolean required

Indicates if the bot session should remain open

debounceTimeinteger required

Time in milliseconds to wait before processing the next input

ignoreJidsstring[] required

List of JIDs (Jabber IDs) to ignore

openaiIdFallbackstring required

Fallback OpenAI credentials ID if the main one fails

Response

Successfully updated OpenAI bot settings

successboolean

Indicates if the update was successful

messagestring

Details about the operation

Changes