Nodes
Generate Output for a Node
Generates content for a Node using generative AI. The generated output, either text or an adaptive card, is returned in the response and can be copied into the Node for testing or development. No node ID is required.
post/v2.0/flows/{flowId}/chart/nodes/output/generate
Request
- Base URLhttps://api-trial.cognigy.ai/testing
- Auth
- API key in header X-API-Key
- or API key in query parameter api_key
- or API key in header x-cxone-authorization
- or OAuth 2Authorization code/auth/oauth2/authorizePasswordToken URL/auth/oauth2/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
flowIdstring required
The unique identifier for the Flow.
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.
Request body
Example request
{
"userText": "greetings",
"outputType": "text",
"lastOutput": "{\"$schema\":\"http://adaptivecards.io/schemas/adaptive-card.json\", ...}",
"generateContentLimit": 3
}Response
Returns output
Example response
{
"output": {
"type": "AdaptiveCard",
"speak": "create a poll for playing football on saturday at 3pm with the following options: yes, no, maybe"
},
"outputType": "adaptiveCard"
}Changes
No recorded changes to this operation across all 1 revision of this API.