Creates an AI Copilot configuration - Cognigy Documentation

POST

v2.0

aicopilotconfigs

Creates an AI Copilot configuration

curl --request POST \
  --url 'https://api-trial.cognigy.ai/new/v2.0/aicopilotconfigs?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
      }
    }
  },
  "projectId": "<string>"
}
'

{
  "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

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

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

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.

Show child attributes

config.grid

object

Show child attributes

config.grid.columns

number

Number of columns in the grid.

config.grid.rows

number

Number of rows in the grid.

config.grid.gap

number

Padding between tiles in pixels. The default value is 10. If you set it to 0, the default will be used.

config.tiles

object

Show child attributes

config.tiles.tile-id

object

The Tile ID is used in the Flow Nodes to fill in this specific tile.

Show child attributes

config.tiles.tile-id.x

number

The row number where the tile is located, starting from 1.

config.tiles.tile-id.y

number

The column number where the tile is located, starting from 1.

config.tiles.tile-id.columns

number

The number of columns the tile should occupy. The default value is 1.

config.tiles.tile-id.rows

number

The number of rows the tile should occupy. The default value is 1.

projectId

string

Required string length: 24

Response

Returns agent assist 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

config.grid

object

Show child attributes

config.grid.columns

number

Number of columns in the grid.

config.grid.rows

number

Number of rows in the grid.

config.grid.gap

number

Padding between tiles in pixels. The default value is 10. If you set it to 0, the default will be used.

config.tiles

object

Show child attributes

config.tiles.tile-id

object

The Tile ID is used in the Flow Nodes to fill in this specific tile.

Show child attributes

config.tiles.tile-id.x

number

The row number where the tile is located, starting from 1.

config.tiles.tile-id.y

number

The column number where the tile is located, starting from 1.

config.tiles.tile-id.columns

number

The number of columns the tile should occupy. The default value is 1.

config.tiles.tile-id.rows

number

The number of rows the tile should occupy. The default value is 1.

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

Gets an AI Copilot configurationGets a single AiCopilotConfig resource in a project.

⌘I

Creates an AI Copilot configuration

curl --request POST \
  --url 'https://api-trial.cognigy.ai/new/v2.0/aicopilotconfigs?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
      }
    }
  },
  "projectId": "<string>"
}
'

{
  "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>"
}

Overview

API

Authorizations

Headers

Body

Response