Export a Model API¶
This API exports a trained AI model from the system. Once initiated, the export process runs in the background. Use the dockStatusId from the API response to call the Get Dock Status API and track the export status.
Additionally, the response provides a download URL. Copy and paste this URL into a browser or API client to download the exported model’s file.
| Method | POST |
| Endpoint | https://{host}/api/public/models/:{modelId}/export
|
| Content Type | application/json |
| Authorization | X-api-key - The API key used for authentication.
|
Where can I find the API key? Learn more.
Path Parameters¶
| PARAMETER | DESCRIPTION | TYPE | REQUIRED/OPTIONAL |
| host | The environment URL. For example, https://gale.kore.ai
|
String | Required |
| modelId | The unique identifier of the model you want to export. | String | Required |
Sample Request¶
curl --location --request POST 'https://dev-axxxt-plxxxxrm.kore.ai/api/public/models/cm-9xxxxxxxxxxxxxxxxxx2/export' \
--header 'x-api-key: kg-axxxxxxx-5xx3-5xx8-xxx-9xxxxxxxxxx-ebxxxxxx-5xxb-4xxb-9xx5-cxxxxxxxxx3'
Body Parameters¶
No parameters are passed.
Sample Response¶
{
"_id": "ds-fxxxxxx0-6xxf-5xxb-9xxf-ebxxxxxxxxx0",
"modelId": "cm-ddxxxxxb-0xxb-5xxe-bxx2-51xxxxxxxxx6",
"jobType": "MODELS",
"action": "EXPORT",
"status": "SUCCESS",
"percentageComplete": 100,
"response": {
"downloadUrl": "https://gale.kore.ai/api/v1/account/xxxxxx"
}
}
Response Parameters¶
| PARAMETER | DESCRIPTION | TYPE |
| dockStatusId | The unique identifier to track the status of action. For example: import, export, deploy, etc. | String |
| modelId | The unique identifier for the model. | String |
| jobType | Type of job being performed. | String |
| action | The action that is performed on the model. | String |
| status | The current status of the job (IN_PROGRESS, SUCCESS, or FAILED). | String |
| percentageComplete | The percentage of the model export process that is complete. | Number |
| downloadURL | The URL to download the exported model file. | String |