Cloner API

How to export or import the Bot structure, including various kinds of information, such as: Basic Bot Data, Intentions, Entity, Registered Flows, Channels and etc

This feature is solely intended for Syntphony CAI Server Clients without access to the Cockpit.

If your deployment contains Cockpit, you may import and export the virtual agents through the UI instead.

The Syntphony CAI platform provides an external endpoint capable of exporting or importing the virtual agent structure, this includes various kinds of information, such as: Basic Data, Intentions, Entity, Registered Flows, Channels, etc. These endpoints are extremely useful during environment migration or even for backing up a specific "Bot".

For the following methods, this is the base url:

https://{installationURL}/eva-cloner/org/{orgUUID}/env/{envUUID}/cloner

The installationURL is the URL provided to you by your Syntphony CAI installation administrator. If you lost it, you may request it again.

Export service

Method:

GET

URL:

/export

Type:

application/json

The request responsible to extracting all information. It will return you a zip file, and requires your token's user to at least have access to the Editor role in your virtual agent.

URL Parameters

Name

Type

Required

Description

orgUUID

String

Yes

Your organization's UUID.

envUUID

String

Yes

UUID of the environment your bot is located.

Query parameters

Name

Data Type

Required

Description

botName

String

Yes

The Bot name, who intends to extract information

Headers

NameData TypeRequiredDescription

Name

Data Type

Required

Description

AUTHORIZATION

String

Yes

A Bearer Token. For more details, see the Authentication section on 'Conversation API'. Required when calling the ‘Authenticated conversation service’ endpoint.

Response

This service has an Application/ZIP return type. The returned Zip may be sent, as is, to the import virtual agent service.

Import service

Method:

POST

URL:

/import

Type:

application/json

This service receives a zip file in a specific format, obtained in the 'export bot service', and re-creates the virtual agent in the desired environment. The environment doesn't need to be the same as the original one, and you may also import virtual agents from 3.x versions into 4.x versions.

The token's user permissions must be at least as high as 'Editor' to the whole chosen environment.

URL Parameters

Name

Type

Required

Description

orgUUID

String

Yes

Your organization's UUID.

envUUID

String

Yes

UUID of the environment your bot is located.

Query parameters

Name

Data Type

Required

Description

botName

String

Yes

After import, this will be the bot final name.

file

Form Data FILE

Yes

The zip file containing all bot information. This is the same zip obtained in the export method.

Headers

NameData TypeRequiredDescription

Name

Data Type

Required

Description

AUTHORIZATION

String

Yes

A Bearer Token. For more details, see the Authentication section on 'Conversation API'. Required when calling the ‘Authenticated conversation service’ endpoint.

Response

HTTP Status

Description

201

Created, the Import operation was successful

Last updated