Import to an Existing Tool API¶
This API enables users to import configurations, datasets, or updates into an existing tool, allowing modifications without creating a new one. It ensures seamless integration by updating the tool with the provided tool data, flow data, and environment variables files.
After triggering the import, the response returns a dockStatusId. Use this ID to call the Get Dock Status API and verify the status of the tool import process.
| Method | POST |
| Endpoint | https://{host}/api/public/tools/:{toolId}/import
|
| Content Type | application/json |
| Authorization | X-api-key - The API key used for authentication.
|
Where can I find the API key? Learn more.
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 imported | String | Required |
Sample Request¶
curl --location 'https://staging-agent-platform.kore.ai/api/public/tools/a-fbxxxxxf4-20x5-58xb-8b94-00xxxxxxxx5/import' \
--header 'x-api-key: kg-90xxxxx5-9xxe-5xxf-9xx7-9f4xxxxxxxx4-55xxxxx4-axx9-4xx2-axx2-fbcxxxxxxxxa' \
--header 'Content-Type: application/json' \
--data '{
"toolDataFileId": "67xxxxxxxxxxxxxxxxxxxxxc",
"flowDataFileId": "67xxxxxxxxxxxxxxxxxxxxxx2",
"envVariablesFileId": "67xxxxxxxxxxxxxxxxxxxxx2"
}'
Body Parameters¶
| PARAMETER | DESCRIPTION | TYPE | REQUIRED/OPTIONAL |
| toolDataFileId | The identifier for the tool data file being imported. | String | Required |
| flowDataFileId | The identifier for the flow data file. | String | Required |
| envVariablesFileId | The identifier for the environment variables file. | String | Required |
Sample Response¶
{
"dockStatusId": "{dockStatusId}",
"toolId": "{toolId}",
"jobType": "TOOLS",
"action": "IMPORT",
"status": "SUCCESS"
}
Response Parameters¶
| PARAMETER | DESCRIPTION | TYPE | SAMPLE VALUE |
| dockStatusId | The unique identifier to track the status of action. E.g. import, export, deploy, etc. | String | e.g., ds-c6xxxxx5-dxxd-5xxf-9xxd-0xxxxx6xxxx8 |
| toolId | The unique identifier for the tool. | String | e.g., a-8xxxxxbe-6xxe-5xx1-8xxc-bxxxxxx80xx6 |
| jobType | The type of job being performed. | String | TOOLS |
| action | The action being performed on the tool/model. | String | IMPORT |
| status | The current status of the job. | String | IN_PROGRESS, SUCCESS, FAILED |