v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Agent Copilot Configuration

Create an Agent Copilot Configuration

Creates an Agent Copilot configuration in a Project. The Agent Copilot configuration defines the grid layout, which serves as the structure for your AI Copilot Workspace. After creation, select the configuration in the Cognigy.AI Endpoint under the Copilot section.

post/v2.0/aicopilotconfigs

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Request body

namestring

The human readable name of the config.

descriptionstring

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

projectIdstring

The unique identifier for the Project.

Response

Returns the Agent Copilot Configuration object.

namestring

The human readable name of the config.

descriptionstring

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

referenceIdstring uuid
_idstring
createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring
lastChangedBystring

Example response

{
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}