Gets an AI Copilot configuration - Cognigy Documentation

GET

v2.0

aicopilotconfigs

{configId}

Gets an AI Copilot configuration

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/aicopilotconfigs/{configId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "name": "<string>",
  "description": "<string>",
  "config": {
    "grid": {
      "columns": 123,
      "rows": 123,
      "gap": 123
    },
    "tiles": {
      "tile-id": {
        "x": 123,
        "y": 123,
        "columns": 123,
        "rows": 123
      }
    }
  },
  "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

Authorization

string

header

required

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

api_key

string

query

required

Supply the API Key in the Url-Query

Headers

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

Response

Returns an AI Copilot config object

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

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.

Show child attributes

referenceId

string<uuid>

_id

string

Required string length: 24

createdAt

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

lastChanged

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

createdBy

string

Required string length: 24

lastChangedBy

string

Required string length: 24

Deletes an AI Copilot configurationDeletes an AiCopilotConfig resource in a project and from the Endpoints referencing it. Note that if you are still using this config in the AI Copilot Config section, first replace it with another config and then proceed with the API Delete request.

⌘I

Gets an AI Copilot configuration

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/aicopilotconfigs/{configId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "name": "<string>",
  "description": "<string>",
  "config": {
    "grid": {
      "columns": 123,
      "rows": 123,
      "gap": 123
    },
    "tiles": {
      "tile-id": {
        "x": 123,
        "y": 123,
        "columns": 123,
        "rows": 123
      }
    }
  },
  "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}