Skip to main content
GET
/
v2.0
/
extensions
/
{extensionId}
Get a Extension
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/extensions/{extensionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "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",
      "variant": "regular"
    },
    "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": [
      {
        "type": "text",
        "key": "<string>",
        "label": "<string>",
        "defaultValue": "<any>"
      }
    ],
    "previews": [
      {
        "type": "message",
        "key": "<string>"
      }
    ],
    "tokens": [
      {
        "label": "word count",
        "script": "ci.text.split(' ').length",
        "type": "input"
      }
    ],
    "tags": "basic",
    "sections": [
      {
        "key": "<string>",
        "value": "<any>",
        "negate": true
      }
    ],
    "form": [
      {
        "key": "<string>",
        "type": "field"
      }
    ]
  },
  "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": [
      {
        "type": "text",
        "key": "<string>",
        "label": "<string>",
        "defaultValue": "<any>"
      }
    ],
    "sections": [
      {
        "key": "<string>",
        "value": "<any>",
        "negate": true
      }
    ],
    "form": [
      {
        "key": "<string>",
        "type": "field"
      }
    ]
  },
  "_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

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
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

Path Parameters

​
extensionId
string
required

The Id of the Extension

Required string length: 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

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
​
connections
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.

​
knowledge
object
​
_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