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!
Get an Extension
Gets an Extension from a Project.
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/extensions/{extensionId} \
--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": "<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>"
}Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Supply the API Key in the HTTP-Header
Headers
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.
application/json, application/hal+json, application/xml, text/xml, text/csv Path Parameters
The Id of the Extension
24^[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.
The name of the Extension
"New Extension"
The label of the Extension
"New Extension"
The version of the Extension
^(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-]+)*))?$"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
nodes Whether the code of the extension is trusted and runs without isolation
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
24^[a-z0-9]{24}$Unix-timestamp
0 <= x <= 21474836471694518620
Unix-timestamp
0 <= x <= 21474836471694518620
24^[a-z0-9]{24}$24^[a-z0-9]{24}$curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/extensions/{extensionId} \
--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": "<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>"
}