Clone an existing Flow - Cognigy Documentation

POST

v2.0

flows

{flowId}

clone

Clone an existing Flow

curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/clone \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "intentTrainGroupReference": "<string>",
  "feedbackReport": {
    "findings": [
      {
        "type": "poorAccuracy"
      }
    ],
    "info": {
      "fScore": 123
    }
  },
  "isTrainingOutOfDate": true,
  "name": "<string>",
  "description": "<string>",
  "context": {},
  "attachedFlows": [
    "<string>"
  ],
  "attachedLexicons": [
    "<string>"
  ],
  "img": "<string>",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

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

Response

Returns the cloned flow 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.

referenceId

string<uuid>

intentTrainGroupReference

string

Required string length: 24

feedbackReport

object

Show child attributes

isTrainingOutOfDate

boolean

name

string

description

string

context

object

attachedFlows

string[]

attachedLexicons

string[]

img

string

_id

string

Required string length: 24

createdAt

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

lastChanged

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

createdBy

string

Required string length: 24

lastChangedBy

string

Required string length: 24

Removes a localization for a flowRemove a localization for a [Flow](doc:flow).

⌘I

Clone an existing Flow

curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/clone \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "intentTrainGroupReference": "<string>",
  "feedbackReport": {
    "findings": [
      {
        "type": "poorAccuracy"
      }
    ],
    "info": {
      "fScore": 123
    }
  },
  "isTrainingOutOfDate": true,
  "name": "<string>",
  "description": "<string>",
  "context": {},
  "attachedFlows": [
    "<string>"
  ],
  "attachedLexicons": [
    "<string>"
  ],
  "img": "<string>",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}