2026-11-07
▼ ▲ aiplatform.reasoningEngines.sandboxEnvironmentTemplates.patch
Path : v1beta1/{+name}
Description : Updates the specific SandboxEnvironmentTemplate. Only the container image and the warm pool size can be updated.
Parameters :
name
Type : string
Required : Yes
Pattern : ^reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$
Location : path
Description : Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
updateMask
Location : query
Format : google-fieldmask
Description : Optional. The fields to update. Only these paths are supported: * `custom_container_environment.custom_container_spec.image_uri` * `warm_pool_config.target_instance_count` * `warm_pool_config.update_strategy`
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}
Parameter Order : name
HTTP Method : PATCH
▼ ▲ aiplatform.projects.locations.evaluationSets.revisions.create
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/revisions
Parameters :
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$
Description : Required. The resource name of the EvaluationSet to create a revision of. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`
Type : string
Required : Yes
Description : Creates an Evaluation Set Revision: an immutable snapshot of the Evaluation Set and its Evaluation Items. Each entry in the set's `evaluation_items` is replaced by an Evaluation Item Revision of that item. Every Evaluation Item in the set must be of type `HARBOR_TASK`. It must not contain duplicate items. Currently this always creates a new Evaluation Item Revision for every item. Clients must not rely on this: a future version may reuse an item's latest Evaluation Item Revision when the item has not changed since that revision was created.
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+parent}/revisions
HTTP Method : POST
▼ ▲ aiplatform.projects.locations.evaluationSets.revisions.delete
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+/revisions/[^/]+$
Type : string
Required : Yes
Location : path
Description : Required. The name of the EvaluationSetRevision resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}/revisions/{revision}`
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/revisions/{revisionsId}
Description : Deletes an Evaluation Set Revision, then deletes each of its Evaluation Item Revisions that no other Evaluation Set Revision references. Evaluation Runs on the revision and their results are not deleted.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
HTTP Method : DELETE
Path : v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.evaluationSets.revisions.list
Description : Lists the revisions of an Evaluation Set, newest first.
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
parent
Type : string
Required : Yes
Location : path
Description : Required. The resource name of the EvaluationSet whose revisions to list. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`
Pattern : ^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$
pageSize
Description : Optional. The maximum number of EvaluationSetRevisions to return.
Type : integer
Format : int32
Location : query
pageToken
Description : Optional. A page token, received from a previous `ListEvaluationSetRevisions` call. Provide this to retrieve the subsequent page.
Type : string
Location : query
Path : v1beta1/{+parent}/revisions
Parameter Order : parent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/revisions
HTTP Method : GET
▼ ▲ aiplatform.projects.locations.evaluationSets.revisions.get
Parameters :
name
Description : Required. The name of the EvaluationSetRevision resource. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}/revisions/{revision}`
Pattern : ^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+/revisions/[^/]+$
Location : path
Required : Yes
Type : string
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/revisions/{revisionsId}
Parameter Order : name
Description : Gets an Evaluation Set Revision.
HTTP Method : GET
Path : v1beta1/{+name}
▼ ▲ aiplatform.projects.locations.detectors.disable
Description : Disables a specific detector, so that it stops scanning. Disabling an already-DISABLED detector succeeds and changes nothing. The detector's config and history survive; only DeleteDetector removes a detector.
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/detectors/{detectorsId}:disable
HTTP Method : POST
Path : v1beta1/{+name}:disable
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/detectors/[^/]+$
Required : Yes
Description : Required. The name of the detector to disable. Format: `projects/{project}/locations/{location}/detectors/{detector}`
Type : string
Parameter Order : name
▼ ▲ aiplatform.projects.locations.detectors.patch
Parameter Order : name
Parameters :
name
Description : Identifier. The resource name of the detector. Format: `projects/{project}/locations/{location}/detectors/{detector}`
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/detectors/[^/]+$
Required : Yes
updateMask
Type : string
Location : query
Description : Optional. The list of fields to update. Supported paths are `display_name`, `description` and `custom_detector_config`. `name` and `state` are ignored if named; any other path is rejected with INVALID_ARGUMENT.
Format : google-fieldmask
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Updates an existing detector. A mask covering `custom_detector_config` replaces the whole config; `state` cannot be changed here, use EnableDetector or DisableDetector.
HTTP Method : PATCH
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/detectors/{detectorsId}
▼ ▲ aiplatform.projects.locations.detectors.enable
HTTP Method : POST
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+name}:enable
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/detectors/[^/]+$
Description : Required. The name of the detector to enable. Format: `projects/{project}/locations/{location}/detectors/{detector}`
Required : Yes
Type : string
Location : path
Description : Enables a specific detector, so that it starts scanning. Enabling an already-ACTIVE detector succeeds and changes nothing.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/detectors/{detectorsId}:enable
▼ ▲ aiplatform.projects.locations.detectors.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets the details of a specific detector, including its current configuration.
Parameter Order : name
HTTP Method : GET
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/detectors/{detectorsId}
Parameters :
revisionId
Location : query
Type : string
Description : Optional. Return the detector as configured at this revision. Unset returns the latest revision.
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/detectors/[^/]+$
Description : Required. The resource name of the detector. Format: `projects/{project}/locations/{location}/detectors/{detector}`
Required : Yes
▼ ▲ aiplatform.projects.locations.detectors.listRevisions
Path : v1beta1/{+name}:listRevisions
HTTP Method : GET
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/detectors/{detectorsId}:listRevisions
Description : Lists the revisions of a detector, newest first. Each entry is the detector as configured at one revision, with `revision_id` and `revision_create_time` set. `state` and `selected_revision_id` are unset: neither is a property of a revision, and GetDetector returns both.
Parameters :
pageSize
Description : Optional. The maximum number of revisions to return. The maximum value is 100; values above 100 will be coerced to 100. If unspecified, at most 10 revisions will be returned.
Format : int32
Type : integer
Location : query
name
Description : Required. The detector whose revisions to list. Format: `projects/{project}/locations/{location}/detectors/{detector}`
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/detectors/[^/]+$
Location : path
pageToken
Description : Optional. A page token, received from a previous `ListDetectorRevisions` call. Provide this to retrieve the subsequent page. When paginating, `name` must match the call that provided the page token.
Location : query
Type : string
▼ ▲ aiplatform.projects.locations.detectors.list
Description : Lists the detectors in a Location.
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Type : string
Location : path
Description : Required. The resource name of the Location to list the detectors from. Format: `projects/{project}/locations/{location}`
pageToken
Description : Optional. A page token, received from a previous `ListDetectors` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDetectors` must match the call that provided the page token.
Type : string
Location : query
pageSize
Description : Optional. The maximum number of detectors to return. The maximum value is 100; values above 100 will be coerced to 100. If unspecified, at most 10 detectors will be returned.
Location : query
Format : int32
Type : integer
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/detectors
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+parent}/detectors
HTTP Method : GET
▼ ▲ aiplatform.projects.locations.detectors.create
Parameters :
detectorId
Description : Optional. The ID to use for the Detector, which becomes the final component of its resource name. Must match `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. If omitted, the server generates one.
Location : query
Type : string
parent
Type : string
Required : Yes
Location : path
Description : Required. The resource name of the Location to create the Detector in. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Parameter Order : parent
HTTP Method : POST
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new customer-defined Detector. The detector is always created DISABLED; EnableDetector starts it scanning.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/detectors
Path : v1beta1/{+parent}/detectors
▼ ▲ aiplatform.projects.locations.detectors.delete
Path : v1beta1/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes a specific detector. Hard and irreversible: the detector is gone from every read path at once.
Parameter Order : name
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/detectors/[^/]+$
Description : Required. The name of the detector to delete. Format: `projects/{project}/locations/{location}/detectors/{detector}`
Required : Yes
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/detectors/{detectorsId}
HTTP Method : DELETE
▼ ▲ aiplatform.projects.locations.notebookRuntimeTemplates.setDefault
Path : v1beta1/{+parent}/notebookRuntimeTemplates:setDefault
Scopes : https://www.googleapis.com/auth/cloud-platform
HTTP Method : POST
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates:setDefault
Parameter Order : parent
Description : Sets the default NotebookRuntimeTemplate for a Location.
Parameters :
parent
Location : path
Type : string
Description : Required. The resource name of the Location to set the default NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
▼ ▲ aiplatform.projects.locations.learningSets.operations.list
HTTP Method : GET
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Parameters :
pageToken
Location : query
Type : string
Description : The standard list page token.
pageSize
Location : query
Type : integer
Description : The standard list page size.
Format : int32
name
Pattern : ^projects/[^/]+/locations/[^/]+/learningSets/[^/]+$
Location : path
Type : string
Description : The name of the operation's parent resource.
Required : Yes
returnPartialSuccess
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
Location : query
filter
Description : The standard list filter.
Type : string
Location : query
Parameter Order : name
Path : v1beta1/{+name}/operations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/learningSets/{learningSetsId}/operations
Scopes :
▼ ▲ aiplatform.projects.locations.learningSets.operations.delete
HTTP Method : DELETE
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/learningSets/{learningSetsId}/operations/{operationsId}
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1beta1/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/learningSets/[^/]+/operations/[^/]+$
Required : Yes
Type : string
Description : The name of the operation resource to be deleted.
Location : path
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Parameter Order : name
▼ ▲ aiplatform.projects.locations.learningSets.operations.wait
Parameters :
timeout
Description : The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Type : string
Format : google-duration
Location : query
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/learningSets/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource to wait on.
Required : Yes
Parameter Order : name
Path : v1beta1/{+name}:wait
Scopes :
HTTP Method : POST
Description : Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/learningSets/{learningSetsId}/operations/{operationsId}:wait
▼ ▲ aiplatform.projects.locations.learningSets.operations.get
Parameters :
name
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/learningSets/[^/]+/operations/[^/]+$
Location : path
Description : The name of the operation resource.
Path : v1beta1/{+name}
Scopes :
HTTP Method : GET
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/learningSets/{learningSetsId}/operations/{operationsId}
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameter Order : name
▼ ▲ aiplatform.projects.locations.learningSets.operations.cancel
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Scopes :
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/learningSets/{learningSetsId}/operations/{operationsId}:cancel
HTTP Method : POST
Path : v1beta1/{+name}:cancel
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/learningSets/[^/]+/operations/[^/]+$
Type : string
Location : path
Description : The name of the operation resource to be cancelled.
Parameter Order : name
▼ ▲ aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.patch
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
name
Location : path
Description : Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}`
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironmentTemplates/[^/]+$
updateMask
Type : string
Format : google-fieldmask
Location : query
Description : Optional. The fields to update. Only these paths are supported: * `custom_container_environment.custom_container_spec.image_uri` * `warm_pool_config.target_instance_count` * `warm_pool_config.update_strategy`
Parameter Order : name
Path : v1beta1/{+name}
HTTP Method : PATCH
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironmentTemplates/{sandboxEnvironmentTemplatesId}
Description : Updates the specific SandboxEnvironmentTemplate. Only the container image and the warm pool size can be updated.
▼ ▲ aiplatform.projects.locations.evaluationItems.revisions.get
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/revisions/{revisionsId}
Path : v1beta1/{+name}
Parameters :
name
Description : Required. The name of the EvaluationItemRevision resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}/revisions/{revision}`
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/revisions/[^/]+$
Location : path
Parameter Order : name
Description : Gets an Evaluation Item Revision.
▼ ▲ aiplatform.projects.locations.collaborativeProjects.list
Parameter Order : parent
Scopes :
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Description : Required. The location to list projects from. Format: `projects/{project}/locations/global`.
Type : string
pageToken
Description : Optional. A page token from a previous call.
Type : string
Location : query
pageSize
Type : integer
Description : Optional. The maximum number of projects to return. The maximum is 100; larger values are coerced to 100. If not set, the default is 50.
Location : query
Format : int32
Path : v1beta1/{+parent}/collaborativeProjects
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/collaborativeProjects
Description : Lists the caller's projects in a location, most recently created first.
HTTP Method : GET
▼ ▲ aiplatform.projects.locations.collaborativeProjects.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/collaborativeProjects/{collaborativeProjectsId}
Parameters :
updateMask
Type : string
Location : query
Format : google-fieldmask
Description : Required. The fields to update: `display_name`, `trusted_participants`, or `*` for both.
name
Description : Identifier. The resource name of the project. The service assigns the final ID segment. Format: `projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project}`.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/collaborativeProjects/[^/]+$
Location : path
Scopes :
Parameter Order : name
Description : Updates a project's display name or trusted participants.
HTTP Method : PATCH
▼ ▲ aiplatform.projects.locations.collaborativeProjects.create
Parameter Order : parent
Description : Creates a project owned by the caller.
Parameters :
parent
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. The location to create the project in. Only `global` is supported. Format: `projects/{project}/locations/global`.
Scopes :
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/collaborativeProjects
Path : v1beta1/{+parent}/collaborativeProjects
HTTP Method : POST
▼ ▲ aiplatform.projects.locations.collaborativeProjects.delete
Scopes :
Description : Deletes a project.
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/collaborativeProjects/[^/]+$
Description : Required. The name of the project to delete.
Type : string
Required : Yes
Path : v1beta1/{+name}
HTTP Method : DELETE
Parameter Order : name
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/collaborativeProjects/{collaborativeProjectsId}
▼ ▲ aiplatform.projects.locations.collaborativeProjects.get
Parameter Order : name
Scopes :
HTTP Method : GET
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/collaborativeProjects/{collaborativeProjectsId}
Description : Gets a project.
Parameters :
name
Location : path
Description : Required. The name of the project.
Pattern : ^projects/[^/]+/locations/[^/]+/collaborativeProjects/[^/]+$
Required : Yes
Type : string
▼ ▲ aiplatform.projects.locations.collaborativeProjects.artifacts.remove
Path : v1beta1/{+parent}/artifacts:remove
Parameters :
parent
Location : path
Description : Required. The task or collaborative project whose workspace holds the file. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} or projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project}
Pattern : ^projects/[^/]+/locations/[^/]+/collaborativeProjects/[^/]+$
Required : Yes
Type : string
Parameter Order : parent
Description : Deletes a file from a task's workspace. `path` must be an absolute path to a file in the task's workspace, under `/workspace/`, e.g. `/workspace/userdata/input.csv`. A path outside `/workspace/`, including a relative path, or a path with a `..` segment fails with `INVALID_ARGUMENT`. A directory path, or a task in a terminal state, fails with `FAILED_PRECONDITION`. A missing file fails with `NOT_FOUND` unless `allow_missing` is `true`, in which case the call succeeds and changes nothing.
HTTP Method : POST
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/collaborativeProjects/{collaborativeProjectsId}/artifacts:remove
Scopes :
▼ ▲ aiplatform.projects.locations.collaborativeProjects.artifacts.list
Parameters :
parent
Description : Required. The task or collaborative project whose workspace to list. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} or projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project}
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/collaborativeProjects/[^/]+$
Required : Yes
Type : string
path
Type : string
Location : query
Description : Optional. Absolute path of the directory to list, e.g. `/workspace/userdata`. Must be `/workspace` or under it, at most 1024 characters, and not contain a `..` segment. Defaults to `/workspace`.
pageToken
Type : string
Description : Optional. A page token, received from a previous ListWorkspaceArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other fields of the request except `page_size` must match the call that provided the page token. The workspace is live: the agent can write between pages, so a paged listing is not a snapshot. An entry added during the walk may or may not appear, and one removed may still be listed and then fail to download.
Location : query
pageSize
Location : query
Format : int32
Description : Optional. The maximum number of entries to return. The service may return fewer than this value, including none on a page that is not the last. If unspecified or 0, at most 100 are returned. The maximum is 1000; values above 1000 are coerced to 1000. A negative value is rejected with `INVALID_ARGUMENT`.
Type : integer
filter
Description : Optional. An AIP-160 filter expression that entries must match, e.g. `type = FILE AND mime_type = "image/*"`. Empty matches every entry. Supported fields: * `type` -- `FILE` or `DIRECTORY` (see `TaskArtifactFile.Type`), case-sensitive. * `mime_type` -- a media type in double quotes, e.g. `"text/csv"`. `*` is a wildcard, so `"image/*"` matches every image type. Directories have an empty `mime_type`. Comparisons use `=` or `!=` and combine with `AND`, `OR`, `NOT` (or `-`) and parentheses. A filter that is not valid AIP-160, or that uses another field or operator, is rejected with `INVALID_ARGUMENT`. The filter selects which entries are returned, not which directories are walked: with `recursive`, `type = FILE` still returns the files in subdirectories.
Location : query
Type : string
recursive
Type : boolean
Location : query
Description : Optional. If `true`, descends into subdirectories. Results are breadth-first.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/collaborativeProjects/{collaborativeProjectsId}/artifacts
Scopes :
HTTP Method : GET
Description : Lists the files and directories in a task's workspace. By default only the immediate children of `path` are returned; set `recursive` to descend into subdirectories. Entries that match `filter` are returned in breadth-first order. While the task's sandbox is running, paths it writes locally are read from the sandbox so the listing reflects files not yet synced to storage; otherwise they are read from storage. Which one served a request is not visible to the caller.
Path : v1beta1/{+parent}/artifacts
Parameter Order : parent
▼ ▲ aiplatform.projects.locations.collaborativeProjects.artifacts.add
Description : Adds a file, folder or site stored in Google Drive, OneDrive, SharePoint or another third-party store as an artifact. The service persists `link_json_metadata` to Cloud Storage as a JSON metadata reference (a `.link.json` file), and links it to a parent resource: a task, named by `task`, or a collaborative project, named by `collaborative_project`. This method is idempotent with respect to the linked entity, identified by `link_json_metadata.provider` and `link_json_metadata.source_artifact_id`, or `link_json_metadata.uri` when `source_artifact_id` is unset: adding an entity that the parent already has does not add another artifact, and returns the same `artifact_id`.
Parameter Order : collaborativeProject
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/collaborativeProjects/{collaborativeProjectsId}/artifacts:add
HTTP Method : POST
Scopes :
Path : v1beta1/{+collaborativeProject}/artifacts:add
Parameters :
collaborativeProject
Location : path
Description : Optional. The collaborative project to link the file to. Format: projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project} Exactly one of `task` and `collaborative_project` must be set.
Pattern : ^projects/[^/]+/locations/[^/]+/collaborativeProjects/[^/]+$
Required : Yes
Type : string
▼ ▲ aiplatform.projects.locations.collaborativeProjects.artifacts.preview
Parameter Order : parent
Path : v1beta1/{+parent}/artifacts:preview
HTTP Method : GET
Description : Returns a file converted for a preview, such as a PDF of a .pptx. A server-streaming RPC. The response body is the converted file's bytes, with its media type as the `Content-Type`. The server converts the file as it is stored now, on every call, and stores nothing. A PDF asked for as a PDF is returned as stored. Fails with `INVALID_ARGUMENT` or `FAILED_PRECONDITION` when the file cannot be converted (an unsupported format, too large, or unreadable), with `DEADLINE_EXCEEDED` when the conversion takes too long, and with `UNAVAILABLE` when conversion is busy or not available; the last two may succeed on a retry.
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/collaborativeProjects/{collaborativeProjectsId}/artifacts:preview
Scopes :
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/collaborativeProjects/[^/]+$
Required : Yes
Description : Required. The task or collaborative project whose workspace holds the file. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} or projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project}
Type : string
Location : path
path
Type : string
Description : Required. Absolute path of a file in the task's workspace, e.g. `/workspace/report.pptx`, or, for a collaborative project, under `/workspace/project`, e.g. `/workspace/project/report.pptx`. Must be under `/workspace`, at most 1024 characters, and not contain a `..` segment. Accepts `TaskArtifactFile.path` as-is.
Location : query
outputMimeType
Description : Required. The media type to convert the file to: * `application/pdf`: the file as a PDF, e.g. of a .docx, .pptx or .xlsx. * `application/json`: a spreadsheet, e.g. a .xlsx or .csv, as JSON describing its sheets and cells, from which a client draws the workbook as a grid.
Location : query
Type : string
▼ ▲ aiplatform.projects.locations.agents.tasks.download
Description : Downloads a file. The response body is the file's bytes, with the file's own media type as the `Content-Type` and a `Content-Disposition` that names the file. Media is the default and only representation, so no `alt` parameter is needed. A preview sets `processing_config` and gets a rendition of the file in place of the file, such as a PDF of a .pptx: the response body is the rendition, with its own media type as the `Content-Type` and a `Content-Disposition` name that ends in its extension. Without `processing_config` the response is always the stored file.
Parameter Order : name
Path : v1beta1/{+name}:download
HTTP Method : GET
Scopes :
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}:download
Usemediadownloadservice : Yes
Supportsmediadownload : Yes
Parameters :
processingConfig.outputMimeType
Type : string
Description : Required. The media type of the rendition: * `application/pdf`: the file as a PDF, e.g. of a .docx, .pptx or .xlsx. * `application/json`: a spreadsheet, e.g. a .xlsx or .csv, as JSON describing its sheets and cells, from which a client draws the workbook as a grid. Any other value fails with `INVALID_ARGUMENT`.
Location : query
path
Description : Required. Absolute path of a file in the task's workspace, e.g. `/workspace/report.md`, or, for a collaborative project, under `/workspace/project`, e.g. `/workspace/project/report.md`. Must be under `/workspace`, at most 1024 characters, and not contain a `..` segment. Accepts `TaskArtifactFile.path` as-is.
Location : query
Type : string
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
Type : string
Description : Required. The task or collaborative project to download from. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} or projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project}
Location : path
▼ ▲ aiplatform.projects.locations.agents.tasks.upload
Mediaupload :
Accept : */*
Protocols :
Simple :
Path : /upload/v1beta1/{+name}:upload
Multipart : Yes
Maxsize : 10737418240
HTTP Method : POST
Supportsmediaupload : Yes
Description : Uploads a file. The file is sent as media: post it to this method's URL with an `/upload` prefix, e.g. `/upload/v1beta1/{name}:upload`, carrying `path` as request metadata and the file's bytes as the media content. The task must not be in a terminal state, and an existing file at `path` is replaced. At most 10 GiB.
Path : v1beta1/{+name}:upload
Scopes :
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}:upload
Parameter Order : name
Parameters :
name
Description : Required. The task or collaborative project to upload to. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} or projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project}
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
Type : string
Required : Yes
▼ ▲ aiplatform.projects.locations.agents.tasks.artifacts.add
Parameter Order : task
Parameters :
task
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
Required : Yes
Type : string
Description : Optional. The task to link the file to. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} Exactly one of `task` and `collaborative_project` must be set.
Location : path
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}/artifacts:add
Scopes :
Path : v1beta1/{+task}/artifacts:add
HTTP Method : POST
Description : Adds a file, folder or site stored in Google Drive, OneDrive, SharePoint or another third-party store as an artifact. The service persists `link_json_metadata` to Cloud Storage as a JSON metadata reference (a `.link.json` file), and links it to a parent resource: a task, named by `task`, or a collaborative project, named by `collaborative_project`. This method is idempotent with respect to the linked entity, identified by `link_json_metadata.provider` and `link_json_metadata.source_artifact_id`, or `link_json_metadata.uri` when `source_artifact_id` is unset: adding an entity that the parent already has does not add another artifact, and returns the same `artifact_id`.
▼ ▲ aiplatform.projects.locations.agents.tasks.artifacts.remove
HTTP Method : POST
Scopes :
Description : Deletes a file from a task's workspace. `path` must be an absolute path to a file in the task's workspace, under `/workspace/`, e.g. `/workspace/userdata/input.csv`. A path outside `/workspace/`, including a relative path, or a path with a `..` segment fails with `INVALID_ARGUMENT`. A directory path, or a task in a terminal state, fails with `FAILED_PRECONDITION`. A missing file fails with `NOT_FOUND` unless `allow_missing` is `true`, in which case the call succeeds and changes nothing.
Parameter Order : parent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}/artifacts:remove
Path : v1beta1/{+parent}/artifacts:remove
Parameters :
parent
Required : Yes
Description : Required. The task or collaborative project whose workspace holds the file. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} or projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project}
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
Location : path
Type : string
▼ ▲ aiplatform.projects.locations.agents.tasks.artifacts.preview
HTTP Method : GET
Scopes :
Path : v1beta1/{+parent}/artifacts:preview
Parameter Order : parent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}/artifacts:preview
Description : Returns a file converted for a preview, such as a PDF of a .pptx. A server-streaming RPC. The response body is the converted file's bytes, with its media type as the `Content-Type`. The server converts the file as it is stored now, on every call, and stores nothing. A PDF asked for as a PDF is returned as stored. Fails with `INVALID_ARGUMENT` or `FAILED_PRECONDITION` when the file cannot be converted (an unsupported format, too large, or unreadable), with `DEADLINE_EXCEEDED` when the conversion takes too long, and with `UNAVAILABLE` when conversion is busy or not available; the last two may succeed on a retry.
Parameters :
parent
Description : Required. The task or collaborative project whose workspace holds the file. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} or projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project}
Required : Yes
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
path
Location : query
Description : Required. Absolute path of a file in the task's workspace, e.g. `/workspace/report.pptx`, or, for a collaborative project, under `/workspace/project`, e.g. `/workspace/project/report.pptx`. Must be under `/workspace`, at most 1024 characters, and not contain a `..` segment. Accepts `TaskArtifactFile.path` as-is.
Type : string
outputMimeType
Type : string
Location : query
Description : Required. The media type to convert the file to: * `application/pdf`: the file as a PDF, e.g. of a .docx, .pptx or .xlsx. * `application/json`: a spreadsheet, e.g. a .xlsx or .csv, as JSON describing its sheets and cells, from which a client draws the workbook as a grid.
▼ ▲ aiplatform.projects.locations.agents.tasks.artifacts.list
HTTP Method : GET
Parameter Order : parent
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}/artifacts
Path : v1beta1/{+parent}/artifacts
Scopes :
Parameters :
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$
Type : string
Description : Required. The task or collaborative project whose workspace to list. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} or projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project}
Required : Yes
pageSize
Type : integer
Location : query
Format : int32
Description : Optional. The maximum number of entries to return. The service may return fewer than this value, including none on a page that is not the last. If unspecified or 0, at most 100 are returned. The maximum is 1000; values above 1000 are coerced to 1000. A negative value is rejected with `INVALID_ARGUMENT`.
pageToken
Description : Optional. A page token, received from a previous ListWorkspaceArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other fields of the request except `page_size` must match the call that provided the page token. The workspace is live: the agent can write between pages, so a paged listing is not a snapshot. An entry added during the walk may or may not appear, and one removed may still be listed and then fail to download.
Type : string
Location : query
filter
Type : string
Location : query
Description : Optional. An AIP-160 filter expression that entries must match, e.g. `type = FILE AND mime_type = "image/*"`. Empty matches every entry. Supported fields: * `type` -- `FILE` or `DIRECTORY` (see `TaskArtifactFile.Type`), case-sensitive. * `mime_type` -- a media type in double quotes, e.g. `"text/csv"`. `*` is a wildcard, so `"image/*"` matches every image type. Directories have an empty `mime_type`. Comparisons use `=` or `!=` and combine with `AND`, `OR`, `NOT` (or `-`) and parentheses. A filter that is not valid AIP-160, or that uses another field or operator, is rejected with `INVALID_ARGUMENT`. The filter selects which entries are returned, not which directories are walked: with `recursive`, `type = FILE` still returns the files in subdirectories.
path
Location : query
Description : Optional. Absolute path of the directory to list, e.g. `/workspace/userdata`. Must be `/workspace` or under it, at most 1024 characters, and not contain a `..` segment. Defaults to `/workspace`.
Type : string
recursive
Type : boolean
Description : Optional. If `true`, descends into subdirectories. Results are breadth-first.
Location : query
Description : Lists the files and directories in a task's workspace. By default only the immediate children of `path` are returned; set `recursive` to descend into subdirectories. Entries that match `filter` are returned in breadth-first order. While the task's sandbox is running, paths it writes locally are read from the sandbox so the listing reflects files not yet synced to storage; otherwise they are read from storage. Which one served a request is not visible to the caller.
▼ ▲ aiplatform.learningSets.operations.wait
Scopes :
Flat Path : v1beta1/learningSets/{learningSetsId}/operations/{operationsId}:wait
HTTP Method : POST
Parameter Order : name
Description : Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
Parameters :
name
Description : The name of the operation resource to wait on.
Type : string
Location : path
Pattern : ^learningSets/[^/]+/operations/[^/]+$
Required : Yes
timeout
Type : string
Description : The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
Format : google-duration
Location : query
Path : v1beta1/{+name}:wait
▼ ▲ aiplatform.learningSets.operations.get
Parameter Order : name
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Flat Path : v1beta1/learningSets/{learningSetsId}/operations/{operationsId}
HTTP Method : GET
Scopes :
Parameters :
name
Location : path
Description : The name of the operation resource.
Type : string
Required : Yes
Pattern : ^learningSets/[^/]+/operations/[^/]+$
Path : v1beta1/{+name}
▼ ▲ aiplatform.learningSets.operations.delete
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
HTTP Method : DELETE
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameter Order : name
Parameters :
name
Location : path
Pattern : ^learningSets/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource to be deleted.
Required : Yes
Path : v1beta1/{+name}
Flat Path : v1beta1/learningSets/{learningSetsId}/operations/{operationsId}
▼ ▲ aiplatform.learningSets.operations.list
Parameter Order : name
HTTP Method : GET
Flat Path : v1beta1/learningSets/{learningSetsId}/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Scopes :
Path : v1beta1/{+name}/operations
Parameters :
name
Location : path
Pattern : ^learningSets/[^/]+$
Required : Yes
Type : string
Description : The name of the operation's parent resource.
pageToken
Description : The standard list page token.
Location : query
Type : string
filter
Description : The standard list filter.
Type : string
Location : query
pageSize
Type : integer
Format : int32
Description : The standard list page size.
Location : query
returnPartialSuccess
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Type : boolean
Location : query
▼ ▲ aiplatform.learningSets.operations.cancel
HTTP Method : POST
Parameter Order : name
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Parameters :
name
Type : string
Required : Yes
Description : The name of the operation resource to be cancelled.
Pattern : ^learningSets/[^/]+/operations/[^/]+$
Location : path
Scopes :
Path : v1beta1/{+name}:cancel
Flat Path : v1beta1/learningSets/{learningSetsId}/operations/{operationsId}:cancel
▼ ▲ aiplatform.media.download
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/collaborativeProjects/{collaborativeProjectsId}:download
Description : Downloads a file. The response body is the file's bytes, with the file's own media type as the `Content-Type` and a `Content-Disposition` that names the file. Media is the default and only representation, so no `alt` parameter is needed. A preview sets `processing_config` and gets a rendition of the file in place of the file, such as a PDF of a .pptx: the response body is the rendition, with its own media type as the `Content-Type` and a `Content-Disposition` name that ends in its extension. Without `processing_config` the response is always the stored file.
HTTP Method : GET
Scopes :
Usemediadownloadservice : Yes
Supportsmediadownload : Yes
Parameter Order : name
Path : v1beta1/{+name}:download
Parameters :
path
Description : Required. Absolute path of a file in the task's workspace, e.g. `/workspace/report.md`, or, for a collaborative project, under `/workspace/project`, e.g. `/workspace/project/report.md`. Must be under `/workspace`, at most 1024 characters, and not contain a `..` segment. Accepts `TaskArtifactFile.path` as-is.
Type : string
Location : query
processingConfig.outputMimeType
Description : Required. The media type of the rendition: * `application/pdf`: the file as a PDF, e.g. of a .docx, .pptx or .xlsx. * `application/json`: a spreadsheet, e.g. a .xlsx or .csv, as JSON describing its sheets and cells, from which a client draws the workbook as a grid. Any other value fails with `INVALID_ARGUMENT`.
Type : string
Location : query
name
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/collaborativeProjects/[^/]+$
Description : Required. The task or collaborative project to download from. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} or projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project}
▼ ▲ aiplatform.projects.locations.evaluationSets.delete
Parameters :
force
Description : Optional. If set to true, all revisions of this EvaluationSet (and their unreferenced EvaluationItemRevisions) are deleted too. Otherwise the request fails with FAILED_PRECONDITION if the EvaluationSet has any revisions. Fails with FAILED_PRECONDITION even with force if a revision is being created.
Location : query
Type : boolean
▼ ▲ aiplatform.projects.locations.evaluationItems.delete
Parameters :
force
Type : boolean
Description : Optional. If set to true, all revisions of this EvaluationItem are deleted too. Otherwise the request fails with FAILED_PRECONDITION if the EvaluationItem has revisions. Even with force, fails with FAILED_PRECONDITION if any revision is referenced by an EvaluationSetRevision.
Location : query
▼ ▲ aiplatform.projects.locations.publishers.files.list
Parameters :
ids
Description : Optional. Batch fetch: return only these files, up to 100 IDs after de-duplication. Mutually exclusive with both `page` and `limit`. Serialised as a repeated `ids` query parameter, one occurrence per ID.
Type : string
Location : query
Repeated : Yes
▼ ▲ aiplatform.media.upload
Parameters :
parent
Required : Yes
Type : string
Location : path
Description : Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
Pattern : ^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$
Path : v1beta1/{+parent}/ragFiles:upload
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload
Mediaupload :
Accept : */*
Protocols :
Simple :
Path : /upload/v1beta1/{+parent}/ragFiles:upload
Multipart : Yes
HTTP Method : POST
Scopes :
Description : Upload a file into a RagCorpus.
Supportsmediaupload : Yes
Parameter Order : parent