Agent Platform API (aiplatform:v1)

▼ ▲ aiplatform.projects.locations.publishers.models.batchEmbedContents

HTTP Method : POST

Scopes :

• https://www.googleapis.com/auth/aiplatform
• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/cloud-platform.read-only

Path : v1/{+model}:batchEmbedContents

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:batchEmbedContents

Parameter Order : model

Description : Generates embeddings directly from multiple contents.

Parameters :

model

Pattern : ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$

Description : Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`

Location : path

Required : Yes

Type : string

▼ ▲ aiplatform.projects.locations.publishers.files.download

Scopes : https://www.googleapis.com/auth/cloud-platform

Usemediadownloadservice : Yes

Description : Downloads the contents of the given file. Only files marked `downloadable` can be retrieved this way; user-uploaded files are not downloadable.

Path : v1/{+name}/content

HTTP Method : GET

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/files/{filesId}/content

Parameter Order : name

Parameters :

name

Description : Required. The name of the file to download. Format: `projects/{project}/locations/{location}/publishers/{publisher}/files/{file}`

Required : Yes

Type : string

Pattern : ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/files/[^/]+$

Location : path

Supportsmediadownload : Yes

▼ ▲ aiplatform.projects.locations.publishers.files.list

Path : v1/{+parent}/publishers/{publishersId}/files

HTTP Method : GET

Description : Lists the files owned by the requesting project and location. Supports two mutually exclusive modes: paginated listing via an opaque `page` cursor, or batch fetch by `ids`. See `ListFilesRequest`.

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/files

Parameter Order :

• parent
• publishersId

Scopes : https://www.googleapis.com/auth/cloud-platform

Parameters :

ids

Location : query

Type : string

Repeated : Yes

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.

publishersId

Location : path

Type : string

Required : Yes

parent

Pattern : ^projects/[^/]+/locations/[^/]+$

Description : Required. The location to list files under. Format: `projects/{project}/locations/{location}`

Location : path

Type : string

Required : Yes

page

Type : string

Location : query

Description : Optional. Opaque pagination cursor. Pass the previous response's `next_page` to fetch the next page. Mutually exclusive with `ids`.

limit

Location : query

Format : int32

Description : Optional. The number of files to return per page. Defaults to 20 if unset, maximum 1000. Mutually exclusive with `ids`.

Type : integer

▼ ▲ aiplatform.projects.locations.publishers.files.get

HTTP Method : GET

Scopes : https://www.googleapis.com/auth/cloud-platform

Description : Gets the metadata for the given file.

Path : v1/{+name}

Parameters :

name

Type : string

Required : Yes

Description : Required. The name of the file to get. Format: `projects/{project}/locations/{location}/publishers/{publisher}/files/{file}`

Pattern : ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/files/[^/]+$

Location : path

Parameter Order : name

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/files/{filesId}

▼ ▲ aiplatform.projects.locations.publishers.files.upload

Description : Uploads a file that can be referenced by ID from subsequent Claude model requests.

Scopes : https://www.googleapis.com/auth/cloud-platform

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/files

HTTP Method : POST

Parameter Order :

• parent
• publishersId

Path : v1/{+parent}/publishers/{publishersId}/files

Mediaupload :

Protocols :

Simple :

Multipart : Yes

Path : /upload/v1/{+parent}/publishers/{publishersId}/files

Accept : */*

Maxsize : 524288000

Supportsmediaupload : Yes

Parameters :

parent

Description : Required. The location to create the file under. Format: `projects/{project}/locations/{location}`

Type : string

Pattern : ^projects/[^/]+/locations/[^/]+$

Location : path

Required : Yes

publishersId

Required : Yes

Location : path

Type : string

▼ ▲ aiplatform.projects.locations.publishers.files.delete

Parameters :

name

Pattern : ^projects/[^/]+/locations/[^/]+/publishers/[^/]+/files/[^/]+$

Description : Required. The name of the file to delete. Format: `projects/{project}/locations/{location}/publishers/{publisher}/files/{file}`

Required : Yes

Type : string

Location : path

Description : Deletes the given file. Returns the deleted file's ID rather than an empty body. See `DeleteFileResponse`.

Flat Path : v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/files/{filesId}

HTTP Method : DELETE

Path : v1/{+name}

Parameter Order : name

Scopes : https://www.googleapis.com/auth/cloud-platform

▼ ▲ aiplatform.projects.locations.agents.create

Parameters :

idpNonce

Description : Optional. Optional. One-time cryptographic nonce issued by the trusted IdP provisioning iframe for session and device non-repudiation.

Location : query

Type : string