Generate Output for a node using generative AI.

POST

v2.0

flows

{flowId}

chart

nodes

output

generate

Generate Output for a node using generative AI.

curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/chart/nodes/output/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "localeId": "<string>",
  "userText": "greetings",
  "outputType": "text",
  "lastOutput": "{\"$schema\":\"http://adaptivecards.io/schemas/adaptive-card.json\", ...}",
  "generateContentLimit": 3
}'

{
  "output": {
    "type": "AdaptiveCard",
    "body": [
      {}
    ],
    "actions": [
      {}
    ],
    "version": 1,
    "speak": "create a poll for playing football on saturday at 3pm with the following options: yes, no, maybe"
  },
  "outputType": "adaptiveCard"
}

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

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

flowId

string

required

The Id of the Flow

Required string length: 24

Body

application/json

localeId

string

Required string length: 24

userText

string

Example:

"greetings"

outputType

enum<string>

Available options:

text,

adaptiveCard

Example:

"text"

lastOutput

string

Last adaptive card output

Example:

"{\"$schema\":\"http://adaptivecards.io/schemas/adaptive-card.json\", ...}"

generateContentLimit

number

The number of sentences to be generated

Example:

3

Response

Returns output

Option 1
Option 2

output

object

Show child attributes

outputType

string

Example:

"adaptiveCard"

Search chart nodesSeach all [Node Nodes](doc:chart) of a Chart for a particular keyword

⌘I

Generate Output for a node using generative AI.

curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/chart/nodes/output/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "localeId": "<string>",
  "userText": "greetings",
  "outputType": "text",
  "lastOutput": "{\"$schema\":\"http://adaptivecards.io/schemas/adaptive-card.json\", ...}",
  "generateContentLimit": 3
}'

{
  "output": {
    "type": "AdaptiveCard",
    "body": [
      {}
    ],
    "actions": [
      {}
    ],
    "version": 1,
    "speak": "create a poll for playing football on saturday at 3pm with the following options: yes, no, maybe"
  },
  "outputType": "adaptiveCard"
}