v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Extensions

Get an Extension

Gets an Extension from a Project.

get/v2.0/extensions/{extensionId}

Path parameters

extensionIdstring required

The Id of the Extension

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.

Response

Returns Extension Object

namestring

The name of the Extension

labelstring

The label of the Extension

versionstring

The version of the Extension

imageUrlTokenstring alphanum-64

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

descriptionstring

Optional description of the extension

tagsstring[]

Optional list of tags to find the extension

authorstring

Author of the extension

extensionType'nodes'

Type of this extension

trustedCodeboolean

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

_idstring

createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring

lastChangedBystring

Example response

{
  "name": "New Extension",
  "label": "New Extension",
  "version": "1.0.0",
  "nodes": {
    "appearance": {
      "textColor": "none",
      "contrastTextColor": "none",
      "color": "none"
    },
    "tokens": [
      {
        "label": "word count",
        "script": "ci.text.split(' ').length",
        "type": "input"
      }
    ]
  },
  "connections": {
    "extension": "azure",
    "type": "oauth-2",
    "label": "OAuth-2",
    "fields": [
      {
        "fieldName": "client_secret"
      }
    ],
    "createdAt": 1694518620,
    "lastChanged": 1694518620
  },
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}