SoulFire LogoSoulFire

Update bot config entry

Updates a single configuration entry for a specific bot. The configuration is persisted to the database immediately.

PATCH
/v1/instances/:instance_id/bots/:bot_id/config/namespaces/:namespace/entries/:key

Updates a single configuration entry for a specific bot. The configuration is persisted to the database immediately.

Authorization

AuthorizationBearer <token>

Preferred API authentication. Use a JWT with the api audience.

In: header

Path Parameters

instance_id*string

The UUID of the SoulFire instance containing the bot.

Formatuuid
bot_id*string

The profile UUID of the bot to update configuration for.

Formatuuid
namespace*string

The settings namespace (e.g., plugin ID or "bot" for core bot settings). Examples: "bot", "auto-reconnect", "chat-message-controller"

key*string

The key within the namespace to update. Must be a valid setting key defined for that namespace.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://127.0.0.1:38765/v1/instances/:instance_id/bots/:bot_id/config/namespaces/:namespace/entries/:key" \  -H "Content-Type: application/json" \  -d '{    "value": {}  }'
{}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}

How is this page?