Skip to content

Export a Tool API

This API exports a tool's configuration and associated data, including its flow for backup, sharing, or reuse. It allows users to generate an export of a specific tool along with its deployed call flow.

When an export request is initiated, the API triggers the export process and returns a dockStatusId, which can be used with the Get Dock Status API to track the export progress. The API response also includes an exportJobId for tracking the specific export job.

Additionally, the response provides a download URL. Copy and paste this URL into a browser or API client to download the exported tool file.

Method POST
Endpoint https://{host}/api/public/tools/:{toolId}/export?flowId={callflowId}
Content Type application/json
Authorization X-api-key - The API key used for authentication.

Where can I find the API key? Learn more.

How to obtain toolId or callflowId for the API?

  1. Follow the steps mentioned here to export an agent.
  2. Open developer tools.
  3. Select the Network tab. developer tools
  4. Monitor the Export API to capture toolId and callflowId.

Query Parameters

PARAMETER DESCRIPTION TYPE REQUIRED/OPTIONAL
host The environment URL. For example, https://gale.kore.ai. String Required
toolId The tool ID of the tool being exported. String Required
callflowId The callflow ID for the deployed agent. String Required

Sample Request

curl --location --request POST 'https://dev-axxxt-plxxxxxm.kore.ai/api/public/tools/a-3xxxxxxxxxxxxxxxxxx3/export' \
--header 'x-api-key: kg-axxxxxxx-5xx3-5xx8-bxxb-9xxxxxxxxxx-ebxxxxxx-5xxb-4xxxxxxx3' \
--header 'Content-Type: application/json'

Body Parameters

No parameters are passed.

Sample Response

{
   "dock-statusId": "ds-cxxxxxxf-8xx7-5xx9-8xxd-c2xxxxxxxxxd",
   "toolId": "a-4xxxxxx9-fxx9-5xx7-axx7-9xxxxxxxxxxb",
   "jobType": "TOOLS",
   "action": "EXPORT",
   "status": "IN_PROGRESS",
   "exportJobId": "agent-ej-25xxxxx2-bxx3-5xxc-8xx4-edxxxxxxxxxf"
"response": {
       "downloadUrl": "https://gale.kore.ai/api/v1/account/xxxxxx"
  }
}

Response Parameters

PARAMETER DESCRIPTION TYPE
dockStatusId The unique identifier to track the status of the tool export process. String
toolId The unique identifier for the tool. String
jobType The type of job being performed. String
action The action that is performed on the tool. String
status The current status of the job. String
exportJobId The unique Identifier to track the specific export job. String
downloadURL The url to download the exported tool file. String