Skip to main content
PATCH
/
v2.0
/
aicopilotconfigs
/
{configId}
Update an Agent Copilot Configuration
curl --request PATCH \
  --url 'https://api-trial.cognigy.ai/new/v2.0/aicopilotconfigs/{configId}?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "config": {
    "grid": {
      "columns": 123,
      "rows": 123,
      "gap": 123
    },
    "tiles": {
      "tile-id": {
        "x": 123,
        "y": 123,
        "columns": 123,
        "rows": 123
      }
    }
  }
}
'
{
  "type": "Bad Request",
  "title": "Bad Request Error",
  "status": 400,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

ā€‹
api_key
string
query
required

Supply the API Key in the Url-Query

ā€‹
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

ā€‹
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

ā€‹
configId
string
required

The Id of the Ai Copilot config

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Body

application/json
ā€‹
name
string

The human readable name of the config.

ā€‹
description
string

The description which can be used to understand what the agent assist config contains in terms of tiles.

ā€‹
config
object

The actual grid-config.

Response

The Agent Copilot Configuration was successfully updated.