User Guide
eva 3.4.1
eva 3.4.1
  • Home and Support
  • What's new
  • Changelog
  • Using eva
    • Overview
      • Virtual Agents
      • Main Concepts of eva
      • Glossary
    • Developing virtual agents
      • Quick Start with eva
      • Dialog Flows
      • Dialog Cells
        • Intent Cells
        • Entity Cells
        • Answer Cells
        • Service Cells
        • Input Cells
        • Jump Cells
        • End Cells
        • Code Cells
        • Rule Cells
      • Training task
      • Export and import agents
      • Create virtual agents from templates
      • Create and manage users
    • Channels
      • Integrating Existing Channels
    • Testing Virtual Agents
      • Test a virtual agent
      • Automated Test
    • Natural Language
      • eva NLP
      • Training with eva NLP
      • Training with eva Automated Learning
      • Using other NLP engines
    • Analytics
      • External analytics platforms
    • Experience
      • Context Management
    • Advanced Options
      • Parameters
      • Intent Navigator
      • PII Data masking
    • How Tos
      • Creating variable answers with Code and Rule cells
      • Videos
  • for technicians
    • eva server Installation guide
    • API Guidelines
      • Conversation API
      • Cloner API
      • Webhooks
    • Supported/verified third-party software
    • Appendices
    • Data Extraction
Powered by GitBook
On this page
  • Export service
  • Request
  • Response
  • Import service
  • Request
  • Response
  1. for technicians
  2. API Guidelines

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

PreviousConversation APINextWebhooks

Last updated 3 years ago

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

As it is an internal endpoint to the Kubernetes cluster, this API will only be accessible through the "kubectl forward" command.

$ kubectl port-forward <pod name > 8080: 8080 –n eva

For example:

$ kubectl port-forward eva-cloner v1-88d8ff59b-hgb4z 8080: 8080 –n eva

Now open your browser at this address:

http://localhost:8080/swagger-ui.htm

You’ll see a page similar to this:

Export service

Method:

GET

URL:

/api/v1/export

Type:

application/json

The API responsible for extract All Bot information.

Request

Name

Type

Data Type

Required

Description

namebot

Query Parameter

String

Yes

The Bot name, who intends to extract information

Response

This service has an Application/ZIP return type.

Import service

Method:

POST

URL:

/api/v1/import

Type:

application/json

The API responsible for insert All Bot from a zip file.

Request

Name

Type

Required

Description

file

formData

yes

The zip file containing all bot information.

nameBot

Query Patameter

Yes

After import, this will be the bot final name.

Response

HTTP Status

Description

201

Created, the Import operation was successful

​