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!
Extensions v2.0
Get a Extension
Get a single Extension resource in a project.
GET
/
v2.0
/
extensions
/
{extensionId}
Get a Extension
Copy
curl --request GET \
--url 'https://api-trial.cognigy.ai/new/v2.0/extensions/{extensionId}?api_key=' \
--header 'Authorization: Bearer <token>' \
--header 'X-API-Key: <api-key>'Copy
{
"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": "<unknown>"
}
],
"previews": [
{
"type": "message",
"key": "<string>"
}
],
"tokens": [
{
"label": "word count",
"script": "ci.text.split(' ').length",
"type": "input"
}
],
"tags": "basic",
"sections": [
{
"key": "<string>",
"value": "<unknown>",
"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": "<unknown>"
}
],
"sections": [
{
"key": "<string>",
"value": "<unknown>",
"negate": true
}
],
"form": [
{
"key": "<string>",
"type": "field"
}
]
},
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}Authorizations
Supply the API Key in the HTTP-Header
Supply the API Key in the Url-Query
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
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
The Id of the Extension
Required string length:
24Response
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.
The name of the Extension
Example:
"New Extension"
The label of the Extension
Example:
"New Extension"
The version of the Extension
Example:
"1.0.0"
A fully qualified URL to an image/icon for the extension.
Optional description of the extension
Optional list of tags to find the extension
Author of the extension
Type of this extension
Available options:
nodes Whether the code of the extension is trusted and runs without isolation
Show child attributes
Show child attributes
The type of the node parent, if there is one
The label that should be used when a new Node of this type is created
A short line of text that describes what this Node is used for
Show child attributes
Show child attributes
Available options:
aliceBlue, antiqueWhite, aqua, aquamarine, azure, beige, bisque, black, blanchedAlmond, blue, blueViolet, brown, burlyWood, cadetBlue, chartreuse, chocolate, coral, cornflowerBlue, cornsilk, crimson, cyan, darkBlue, darkCyan, darkGoldenRod, darkGray, darkGrey, darkGreen, darkKhaki, darkMagenta, darkOliveGreen, darkOrange, darkOrchid, darkRed, darkSalmon, darkSeaGreen, darkSlateBlue, darkSlateGray, darkSlateGrey, darkTurquoise, darkViolet, deepPink, deepSkyBlue, dimGray, dimGrey, dodgerBlue, fireBrick, floralWhite, forestGreen, fuchsia, gainsboro, ghostWhite, gold, goldenRod, gray, grey, green, greenYellow, honeyDew, hotPink, indianRed, indigo, ivory, khaki, lavender, lavenderBlush, lawnGreen, lemonChiffon, lightBlue, lightCoral, lightCyan, lightGoldenRodYellow, lightGray, lightGrey, lightGreen, lightPink, lightSalmon, lightSeaGreen, lightSkyBlue, lightSlateGray, lightSlateGrey, lightSteelBlue, lightYellow, lime, limeGreen, linen, magenta, maroon, mediumAquaMarine, mediumBlue, mediumOrchid, mediumPurple, mediumSeaGreen, mediumSlateBlue, mediumSpringGreen, mediumTurquoise, mediumVioletRed, midnightBlue, mintCream, mistyRose, moccasin, navajoWhite, navy, oldLace, olive, oliveDrab, orange, orangeRed, orchid, paleGoldenRod, paleGreen, paleTurquoise, paleVioletRed, papayaWhip, peachPuff, peru, pink, plum, powderBlue, purple, rebeccaPurple, red, rosyBrown, royalBlue, saddleBrown, salmon, sandyBrown, seaGreen, seaShell, sienna, silver, skyBlue, slateBlue, slateGray, slateGrey, snow, springGreen, steelBlue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whiteSmoke, yellow, yellowGreen, none, transparent Example:
"blue"
Available options:
aliceBlue, antiqueWhite, aqua, aquamarine, azure, beige, bisque, black, blanchedAlmond, blue, blueViolet, brown, burlyWood, cadetBlue, chartreuse, chocolate, coral, cornflowerBlue, cornsilk, crimson, cyan, darkBlue, darkCyan, darkGoldenRod, darkGray, darkGrey, darkGreen, darkKhaki, darkMagenta, darkOliveGreen, darkOrange, darkOrchid, darkRed, darkSalmon, darkSeaGreen, darkSlateBlue, darkSlateGray, darkSlateGrey, darkTurquoise, darkViolet, deepPink, deepSkyBlue, dimGray, dimGrey, dodgerBlue, fireBrick, floralWhite, forestGreen, fuchsia, gainsboro, ghostWhite, gold, goldenRod, gray, grey, green, greenYellow, honeyDew, hotPink, indianRed, indigo, ivory, khaki, lavender, lavenderBlush, lawnGreen, lemonChiffon, lightBlue, lightCoral, lightCyan, lightGoldenRodYellow, lightGray, lightGrey, lightGreen, lightPink, lightSalmon, lightSeaGreen, lightSkyBlue, lightSlateGray, lightSlateGrey, lightSteelBlue, lightYellow, lime, limeGreen, linen, magenta, maroon, mediumAquaMarine, mediumBlue, mediumOrchid, mediumPurple, mediumSeaGreen, mediumSlateBlue, mediumSpringGreen, mediumTurquoise, mediumVioletRed, midnightBlue, mintCream, mistyRose, moccasin, navajoWhite, navy, oldLace, olive, oliveDrab, orange, orangeRed, orchid, paleGoldenRod, paleGreen, paleTurquoise, paleVioletRed, papayaWhip, peachPuff, peru, pink, plum, powderBlue, purple, rebeccaPurple, red, rosyBrown, royalBlue, saddleBrown, salmon, sandyBrown, seaGreen, seaShell, sienna, silver, skyBlue, slateBlue, slateGray, slateGrey, snow, springGreen, steelBlue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whiteSmoke, yellow, yellowGreen, none, transparent Example:
"blue"
Available options:
aliceBlue, antiqueWhite, aqua, aquamarine, azure, beige, bisque, black, blanchedAlmond, blue, blueViolet, brown, burlyWood, cadetBlue, chartreuse, chocolate, coral, cornflowerBlue, cornsilk, crimson, cyan, darkBlue, darkCyan, darkGoldenRod, darkGray, darkGrey, darkGreen, darkKhaki, darkMagenta, darkOliveGreen, darkOrange, darkOrchid, darkRed, darkSalmon, darkSeaGreen, darkSlateBlue, darkSlateGray, darkSlateGrey, darkTurquoise, darkViolet, deepPink, deepSkyBlue, dimGray, dimGrey, dodgerBlue, fireBrick, floralWhite, forestGreen, fuchsia, gainsboro, ghostWhite, gold, goldenRod, gray, grey, green, greenYellow, honeyDew, hotPink, indianRed, indigo, ivory, khaki, lavender, lavenderBlush, lawnGreen, lemonChiffon, lightBlue, lightCoral, lightCyan, lightGoldenRodYellow, lightGray, lightGrey, lightGreen, lightPink, lightSalmon, lightSeaGreen, lightSkyBlue, lightSlateGray, lightSlateGrey, lightSteelBlue, lightYellow, lime, limeGreen, linen, magenta, maroon, mediumAquaMarine, mediumBlue, mediumOrchid, mediumPurple, mediumSeaGreen, mediumSlateBlue, mediumSpringGreen, mediumTurquoise, mediumVioletRed, midnightBlue, mintCream, mistyRose, moccasin, navajoWhite, navy, oldLace, olive, oliveDrab, orange, orangeRed, orchid, paleGoldenRod, paleGreen, paleTurquoise, paleVioletRed, papayaWhip, peachPuff, peru, pink, plum, powderBlue, purple, rebeccaPurple, red, rosyBrown, royalBlue, saddleBrown, salmon, sandyBrown, seaGreen, seaShell, sienna, silver, skyBlue, slateBlue, slateGray, slateGrey, snow, springGreen, steelBlue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whiteSmoke, yellow, yellowGreen, none, transparent Example:
"red"
Available options:
regular, mini, hexagon Show child attributes
Show child attributes
Should this node be editable
Should this node be deletable
Should this node be manually creatable
Should this node be collapsable
Should it be possible to create child flow from this node
Should this node be movable
Additional placement information
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
basic, logic, message, profile, service, nlu, data 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.
Show child attributes
Show child attributes
The package name of the extension
Example:
"azure"
The type of the connection within the extension
Example:
"oauth-2"
The label for the connection type
Example:
"OAuth-2"
Required string length:
24Unix-timestamp
Required range:
0 <= x <= 2147483647Example:
1694518620
Unix-timestamp
Required range:
0 <= x <= 2147483647Example:
1694518620
Required string length:
24Required string length:
24Show child attributes
Show child attributes
The label that should be used when a new Knowledge of this type is created
A short line of text that describes what this Node is used for
Show child attributes
Show child attributes
Available options:
text, rule, json, checkbox, time, date, datetime, select, xml, textArray, chipInput, toggle, slider, number, daterange, connection, condition, description The default value for that field
Required string length:
24Unix-timestamp
Required range:
0 <= x <= 2147483647Example:
1694518620
Unix-timestamp
Required range:
0 <= x <= 2147483647Example:
1694518620
Required string length:
24Required string length:
24⌘I
Get a Extension
Copy
curl --request GET \
--url 'https://api-trial.cognigy.ai/new/v2.0/extensions/{extensionId}?api_key=' \
--header 'Authorization: Bearer <token>' \
--header 'X-API-Key: <api-key>'Copy
{
"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": "<unknown>"
}
],
"previews": [
{
"type": "message",
"key": "<string>"
}
],
"tokens": [
{
"label": "word count",
"script": "ci.text.split(' ').length",
"type": "input"
}
],
"tags": "basic",
"sections": [
{
"key": "<string>",
"value": "<unknown>",
"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": "<unknown>"
}
],
"sections": [
{
"key": "<string>",
"value": "<unknown>",
"negate": true
}
],
"form": [
{
"key": "<string>",
"type": "field"
}
]
},
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}