Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
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.
curl --request POST \
--url https://api-trial.cognigy.ai/new/v2.0/aicopilotconfigs \
--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>"
}Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Supply the API Key in the HTTP-Header
Headers
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.
application/json, application/hal+json, application/xml, text/xml, text/csv Body
The human readable name of the config.
The description which can be used to understand what the agent assist config contains in terms of tiles.
The actual grid-config.
Show child attributes
Show child attributes
The unique identifier for the Project.
24^[a-z0-9]{24}$Response
Returns the Agent Copilot Configuration 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.
The human readable name of the config.
The description which can be used to understand what the agent assist config contains in terms of tiles.
The actual grid-config.
Show child attributes
Show child attributes
24^[a-z0-9]{24}$Unix-timestamp
0 <= x <= 21474836471694518620
Unix-timestamp
0 <= x <= 21474836471694518620
24^[a-z0-9]{24}$24^[a-z0-9]{24}$curl --request POST \
--url https://api-trial.cognigy.ai/new/v2.0/aicopilotconfigs \
--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>"
}