Get an Agent Copilot Configuration - Cognigy Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

Get an Agent Copilot Configuration

Request

GET /v2.0/aicopilotconfigs/{configId}

Example (cURL)

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

Example (Python)

import requests

url = "https://api-trial.cognigy.ai/new/v2.0/aicopilotconfigs/{configId}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

Example (JavaScript)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api-trial.cognigy.ai/new/v2.0/aicopilotconfigs/{configId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Response Status Codes

• 200: Success
• 400: Bad Request
• 401: Unauthorized
• 402: Payment Required
• 403: Forbidden
• 404: Not Found
• 405: Method Not Allowed
• 409: Conflict
• 413: Payload Too Large
• 500: Internal Server Error
• 501: Not Implemented
• 502: Bad Gateway
• 503: Service Unavailable
• 504: Gateway Timeout

Response Structure

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

Error Response Example

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

• APIKeyHeader: X-API-Key (string, header, required) -- Supply the API Key in the HTTP-Header

Headers

• Accept: This 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. Default: application/json.

Path Parameters

• configId: (string, required) -- The Id of the Ai Copilot config (string length: 24, pattern: ^[a-z0-9]{24}$).

Last Modified

Last modified on July 8, 2026