ConnectCloud Developers

Switch the planning agent of a project on or off and set its language (tenant:forge:write and maintainer, or tenant:forge:admin)

PUT /api/forge/v1/projects/{key}/agent-settings

Module: Forge · operationId: putForgeAgentSettings · Tag: Agent · Auth: access token (Authorization: Bearer <accessToken>)

Requires tenant:forge:write or admin and the project role that may configure the project. language is the language the agent writes in (answers, drafts, questions), whatever language the item or the prompt is in; without it the stored language stays (de when none is stored). Emits forge.config.updated.

Parameters

Name In Type Required Description
key path string yes Project key (e.g. APP)

Request body

application/json (required)

  • enabled (boolean, required): The planning agent is switched on for the project
  • language (string): Language the agent writes in (one of de, en; default "de")

Example:

{
  "enabled": true,
  "language": "de"
}

Responses

  • 200 Saved (application/json)
  • 400 Error (application/json)
  • 403 Error (application/json)
  • 404 Error (application/json)

Fields of the 200 answer:

  • enabled (boolean, required): The planning agent is switched on for the project
  • language (string): Language the agent writes in (one of de, en; default "de")

Example 200 answer:

{
  "enabled": true,
  "language": "de"
}

Example request

curl -X PUT 'https://api.mbcom.cloud/api/forge/v1/projects/string/agent-settings' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"enabled":true,"language":"de"}'

View as Markdown · Interactive reference · OpenAPI