Get an Extension

GET

v2.0

extensions

{extensionId}

Get an Extension

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

import requests

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

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

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

print(response.text)

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-trial.cognigy.ai/new/v2.0/extensions/{extensionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-trial.cognigy.ai/new/v2.0/extensions/{extensionId}")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-trial.cognigy.ai/new/v2.0/extensions/{extensionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "name": "New Extension",
  "label": "New Extension",
  "version": "1.0.0",
  "imageUrlToken": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "author": "<string>",
  "extensionType": "nodes",
  "trustedCode": true,
  "nodes": {
    "type": "<string>",
    "parentType": "<string>",
    "defaultLabel": "<string>",
    "summary": "<string>",
    "extension": "<string>",
    "extensionImg": "<string>",
    "appearance": {
      "logo": "<string>",
      "textColor": "blue",
      "contrastTextColor": "blue",
      "color": "red"
    },
    "behavior": {
      "stopping": true,
      "entrypoint": true
    },
    "constraints": {
      "editable": true,
      "deletable": true,
      "creatable": true,
      "collapsable": true,
      "childFlowCreatable": true,
      "movable": true,
      "placement": {
        "predecessor": {
          "whitelist": [
            "<string>"
          ],
          "blacklist": [
            "<string>"
          ]
        },
        "successor": {
          "whitelist": [
            "<string>"
          ],
          "blacklist": [
            "<string>"
          ]
        },
        "children": {
          "whitelist": [
            "<string>"
          ],
          "blacklist": [
            "<string>"
          ]
        }
      }
    },
    "dependencies": {
      "children": [
        "<string>"
      ]
    },
    "fields": [
      {
        "key": "<string>",
        "label": "<string>",
        "defaultValue": "<unknown>"
      }
    ],
    "previews": [
      {
        "key": "<string>"
      }
    ],
    "tokens": [
      {
        "label": "word count",
        "script": "ci.text.split(' ').length",
        "type": "input"
      }
    ],
    "sections": [
      {
        "key": "<string>",
        "value": "<unknown>",
        "negate": true
      }
    ],
    "form": [
      {
        "key": "<string>"
      }
    ]
  },
  "connections": {
    "extension": "azure",
    "type": "oauth-2",
    "label": "OAuth-2",
    "fields": [
      {
        "fieldName": "client_secret"
      }
    ],
    "_id": "<string>",
    "createdAt": 1694518620,
    "lastChanged": 1694518620,
    "createdBy": "<string>",
    "lastChangedBy": "<string>"
  },
  "knowledge": {
    "type": "<string>",
    "label": "<string>",
    "summary": "<string>",
    "fields": [
      {
        "key": "<string>",
        "label": "<string>",
        "defaultValue": "<unknown>"
      }
    ],
    "sections": [
      {
        "key": "<string>",
        "value": "<unknown>",
        "negate": true
      }
    ],
    "form": [
      {
        "key": "<string>"
      }
    ]
  },
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

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

{
  "type": "Unauthorized",
  "title": "Unauthorized Error",
  "status": 401,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 401,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Payment Required",
  "title": "Payment Required Error",
  "status": 402,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 402,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Forbidden",
  "title": "Forbidden Error",
  "status": 403,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Not Found",
  "title": "Not Found Error",
  "status": 404,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {},
  "logLevel": "error"
}

{
  "type": "Method Not Allowed",
  "title": "Method Not Allowed Error",
  "status": 405,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Conflict",
  "title": "Conflict Error",
  "status": 409,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1004,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Payload Too Large",
  "title": "Payload Too Large Error",
  "status": 413,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Internal Server Error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Not Implemented",
  "title": "Not Implemented Error",
  "status": 501,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1009,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Bad Gateway",
  "title": "Bad Gateway Error",
  "status": 502,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Service Unavailable",
  "title": "Service Unavailable Error",
  "status": 503,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 503,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Gateway Timeout",
  "title": "Gateway Timeout Error",
  "status": 504,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

Headers

enum<string>

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.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Path Parameters

extensionId

string

required

The Id of the Extension

Required string length: 24

Pattern: ^[a-z0-9]{24}$

Response

Returns Extension 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 name of the Extension

Example:

"New Extension"

label

string

The label of the Extension

Example:

"New Extension"

version

string

The version of the Extension

Pattern:

^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$

Example:

"1.0.0"

imageUrlToken

string<alphanum-64>

A fully qualified URL to an image/icon for the extension.

description

string

Optional description of the extension

tags

string[]

Optional list of tags to find the extension

author

string

Author of the extension

extensionType

enum<string>

Type of this extension

Available options:

nodes

trustedCode

boolean

Whether the code of the extension is trusted and runs without isolation

nodes

object

Show child attributes

connections

object

Show child attributes

knowledge

object

Show child attributes

_id

string

Required string length: 24

Pattern: ^[a-z0-9]{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

Pattern: ^[a-z0-9]{24}$

lastChangedBy

string

Required string length: 24

Pattern: ^[a-z0-9]{24}$

Last modified on July 22, 2026

Delete an ExtensionDeletes an Extension from a Project.

Get an Extension

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

import requests

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

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

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

print(response.text)

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-trial.cognigy.ai/new/v2.0/extensions/{extensionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-trial.cognigy.ai/new/v2.0/extensions/{extensionId}")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-trial.cognigy.ai/new/v2.0/extensions/{extensionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "name": "New Extension",
  "label": "New Extension",
  "version": "1.0.0",
  "imageUrlToken": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "author": "<string>",
  "extensionType": "nodes",
  "trustedCode": true,
  "nodes": {
    "type": "<string>",
    "parentType": "<string>",
    "defaultLabel": "<string>",
    "summary": "<string>",
    "extension": "<string>",
    "extensionImg": "<string>",
    "appearance": {
      "logo": "<string>",
      "textColor": "blue",
      "contrastTextColor": "blue",
      "color": "red"
    },
    "behavior": {
      "stopping": true,
      "entrypoint": true
    },
    "constraints": {
      "editable": true,
      "deletable": true,
      "creatable": true,
      "collapsable": true,
      "childFlowCreatable": true,
      "movable": true,
      "placement": {
        "predecessor": {
          "whitelist": [
            "<string>"
          ],
          "blacklist": [
            "<string>"
          ]
        },
        "successor": {
          "whitelist": [
            "<string>"
          ],
          "blacklist": [
            "<string>"
          ]
        },
        "children": {
          "whitelist": [
            "<string>"
          ],
          "blacklist": [
            "<string>"
          ]
        }
      }
    },
    "dependencies": {
      "children": [
        "<string>"
      ]
    },
    "fields": [
      {
        "key": "<string>",
        "label": "<string>",
        "defaultValue": "<unknown>"
      }
    ],
    "previews": [
      {
        "key": "<string>"
      }
    ],
    "tokens": [
      {
        "label": "word count",
        "script": "ci.text.split(' ').length",
        "type": "input"
      }
    ],
    "sections": [
      {
        "key": "<string>",
        "value": "<unknown>",
        "negate": true
      }
    ],
    "form": [
      {
        "key": "<string>"
      }
    ]
  },
  "connections": {
    "extension": "azure",
    "type": "oauth-2",
    "label": "OAuth-2",
    "fields": [
      {
        "fieldName": "client_secret"
      }
    ],
    "_id": "<string>",
    "createdAt": 1694518620,
    "lastChanged": 1694518620,
    "createdBy": "<string>",
    "lastChangedBy": "<string>"
  },
  "knowledge": {
    "type": "<string>",
    "label": "<string>",
    "summary": "<string>",
    "fields": [
      {
        "key": "<string>",
        "label": "<string>",
        "defaultValue": "<unknown>"
      }
    ],
    "sections": [
      {
        "key": "<string>",
        "value": "<unknown>",
        "negate": true
      }
    ],
    "form": [
      {
        "key": "<string>"
      }
    ]
  },
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

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

{
  "type": "Unauthorized",
  "title": "Unauthorized Error",
  "status": 401,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 401,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Payment Required",
  "title": "Payment Required Error",
  "status": 402,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 402,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Forbidden",
  "title": "Forbidden Error",
  "status": 403,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Not Found",
  "title": "Not Found Error",
  "status": 404,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {},
  "logLevel": "error"
}

{
  "type": "Method Not Allowed",
  "title": "Method Not Allowed Error",
  "status": 405,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Conflict",
  "title": "Conflict Error",
  "status": 409,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1004,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Payload Too Large",
  "title": "Payload Too Large Error",
  "status": 413,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Internal Server Error",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Not Implemented",
  "title": "Not Implemented Error",
  "status": 501,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1009,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Bad Gateway",
  "title": "Bad Gateway Error",
  "status": 502,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Service Unavailable",
  "title": "Service Unavailable Error",
  "status": 503,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 503,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Gateway Timeout",
  "title": "Gateway Timeout Error",
  "status": 504,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

Overview

Core Resources

Simulator

Authorizations

Headers

Path Parameters

Response