Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.models.export
Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format.
Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported.
Request body
The request body contains data with the following structure:
Required. The desired output location and configuration.
Response body
If successful, the response body contains an instance of Operation.
OutputConfig
Output configuration for the Model export.
Fields
exportFormatId
string
The id of the format in which the Model must be exported. Each Model lists the export formats it supports. If no value is provided here, then the first from the list of the Model's supported formats is used by default.
The Cloud Storage location where the Model artifact is to be written to. Under the directory given as the destination a new one with name "model-export-<model-display-name>-<timestamp-of-export-call>", where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format, will be created. Inside, the Model and any of its supporting files will be written. This field should only be set when the exportableContent field of the [Model.supported_export_formats] object contains ARTIFACT.
The Google Artifact Registry uri where the Model container image will be copied to. This field should only be set when the exportableContent field of the [Model.supported_export_formats] object contains IMAGE.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-02 UTC."],[],[],null,["# Method: models.export\n\n**Full name**: projects.locations.models.export\n\nExports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one [supported export format](/vertex-ai/docs/reference/rest/v1/projects.locations.models#Model.FIELDS.supported_export_formats). \n\n### Endpoint\n\npost `https:``/``/{service-endpoint}``/v1``/{name}:export` \nWhere `{service-endpoint}` is one of the [supported service endpoints](/vertex-ai/docs/reference/rest#rest_endpoints).\n\n### Path parameters\n\n`name` `string` \nRequired. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported.\n\n### Request body\n\nThe request body contains data with the following structure:\nFields `outputConfig` `object (`[OutputConfig](/vertex-ai/docs/reference/rest/v1/projects.locations.models/export#OutputConfig)`)` \nRequired. The desired output location and configuration. \n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/vertex-ai/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\nOutputConfig\n------------\n\nOutput configuration for the Model export.\nFields `exportFormatId` `string` \nThe id of the format in which the Model must be exported. Each Model lists the [export formats it supports](/vertex-ai/docs/reference/rest/v1/projects.locations.models#Model.FIELDS.supported_export_formats). If no value is provided here, then the first from the list of the Model's supported formats is used by default.\n`artifactDestination` `object (`[GcsDestination](/vertex-ai/docs/reference/rest/v1/GcsDestination)`)` \nThe Cloud Storage location where the Model artifact is to be written to. Under the directory given as the destination a new one with name \"`model-export-\u003cmodel-display-name\u003e-\u003ctimestamp-of-export-call\u003e`\", where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format, will be created. Inside, the Model and any of its supporting files will be written. This field should only be set when the `exportableContent` field of the \\[Model.supported_export_formats\\] object contains `ARTIFACT`.\n`imageDestination` `object (`[ContainerRegistryDestination](/vertex-ai/docs/reference/rest/v1/projects.locations.models/export#ContainerRegistryDestination)`)` \nThe Google Artifact Registry uri where the Model container image will be copied to. This field should only be set when the `exportableContent` field of the \\[Model.supported_export_formats\\] object contains `IMAGE`. \n\nContainerRegistryDestination\n----------------------------\n\nThe Artifact Registry location for the container image.\nFields `outputUri` `string` \nRequired. Artifact Registry URI of a container image. Only Google Artifact Registry are supported now. Accepted forms:\n\n- Google Artifact Registry path. For example: `gcr.io/projectId/imageName:tag`.\n\n- Artifact Registry path. For example: `us-central1-docker.pkg.dev/projectId/repoName/imageName:tag`.\n\nIf a tag is not specified, \"latest\" will be used as the default tag."]]