Skip to main content
PATCH
/
v1
/
orchestrate
/
agents
/
{agent_id}
/
environment
/
{environment_id}
Update An Environment Of An Agent By Id
curl --request PATCH \
  --url https://{api_endpoint}/api/v1/orchestrate/agents/{agent_id}/environment/{environment_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "voice": {
    "enable_on_homepage": false
  },
  "current_version": 123
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id
string<uuid>
required
environment_id
string<uuid>
required

Body

application/json
name
string
required

Name of the environment

description
string
required

Description of what the environment does

voice
Voice · object

Voice configuration for the environment

current_version
integer | null

Current agent version pointed to this environment

Response

Successful Response