2026-02-05
▼ ▲ ces.projects.locations.operations.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
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`.
Scopes :
Parameters :
name
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be deleted.
Type : string
Parameter Order : name
HTTP Method : DELETE
▼ ▲ ces.projects.locations.operations.list
Path : v1/{+name}/operations
HTTP Method : GET
Parameter Order : name
Scopes :
Parameters :
name
Required : Yes
Description : The name of the operation's parent resource.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
returnPartialSuccess
Type : boolean
Location : query
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.
pageToken
Location : query
Type : string
Description : The standard list page token.
filter
Type : string
Location : query
Description : The standard list filter.
pageSize
Description : The standard list page size.
Location : query
Format : int32
Type : integer
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations
▼ ▲ ces.projects.locations.operations.cancel
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: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`.
Path : v1/{+name}:cancel
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type : string
Required : Yes
Location : path
Scopes :
HTTP Method : POST
▼ ▲ ces.projects.locations.operations.get
HTTP Method : GET
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.
Path : v1/{+name}
Parameter Order : name
Scopes :
Parameters :
name
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Description : The name of the operation resource.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ ces.projects.locations.apps.changelogs.list
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Required : Yes
Location : path
Type : string
Description : Required. The resource name of the app to list changelogs from.
orderBy
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Type : string
Location : query
filter
Type : string
Location : query
Description : Optional. Filter to be applied when listing the changelogs. See https://google.aip.dev/160 for more details. The filter string can be used to filter by `action`, `resource_type`, `resource_name`, `author`, and `create_time`. The `:` comparator can be used for case-insensitive partial matching on string fields, while `=` performs an exact case-sensitive match. Examples: * `action:update` (case-insensitive partial match) * `action="Create"` (case-sensitive exact match) * `resource_type:agent` * `resource_name:my-agent` * `author:me@example.com` * `create_time > "2025-01-01T00:00:00Z"` * `create_time <= "2025-01-01T00:00:00Z" AND resource_type:tool`
pageSize
Format : int32
Location : query
Type : integer
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken
Location : query
Type : string
Description : Optional. The next_page_token value returned from a previous list AgentService.ListChangelogs call.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/changelogs
Scopes :
Description : Lists the changelogs of the specified app.
HTTP Method : GET
Parameter Order : parent
Path : v1/{+parent}/changelogs
▼ ▲ ces.projects.locations.apps.changelogs.get
HTTP Method : GET
Description : Gets the specified changelog.
Parameters :
name
Location : path
Type : string
Description : Required. The resource name of the changelog to retrieve.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/changelogs/[^/]+$
Required : Yes
Parameter Order : name
Path : v1/{+name}
Scopes :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/changelogs/{changelogsId}
▼ ▲ ces.projects.locations.apps.examples.get
Parameters :
name
Description : Required. The resource name of the example to retrieve.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$
Type : string
Location : path
Required : Yes
Description : Gets details of the specified example.
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}
HTTP Method : GET
Parameter Order : name
Scopes :
▼ ▲ ces.projects.locations.apps.examples.delete
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}
Scopes :
HTTP Method : DELETE
Parameters :
etag
Location : query
Description : Optional. The current etag of the example. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the example, deletion will be blocked and an ABORTED error will be returned.
Type : string
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$
Location : path
Required : Yes
Type : string
Description : Required. The resource name of the example to delete.
Path : v1/{+name}
Description : Deletes the specified example.
▼ ▲ ces.projects.locations.apps.examples.create
Path : v1/{+parent}/examples
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples
HTTP Method : POST
Description : Creates a new example in the given app.
Scopes :
Parameter Order : parent
Parameters :
exampleId
Location : query
Description : Optional. The ID to use for the example, which will become the final component of the example's resource name. If not provided, a unique ID will be automatically assigned for the example.
Type : string
parent
Type : string
Description : Required. The resource name of the app to create an example in.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
Required : Yes
▼ ▲ ces.projects.locations.apps.examples.list
Scopes :
Path : v1/{+parent}/examples
Description : Lists examples in the given app.
Parameters :
pageSize
Type : integer
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
Format : int32
parent
Required : Yes
Description : Required. The resource name of the app to list examples from.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
pageToken
Location : query
Description : Optional. The next_page_token value returned from a previous list AgentService.ListExamples call.
Type : string
orderBy
Type : string
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Location : query
filter
Type : string
Description : Optional. Filter to be applied when listing the examples. See https://google.aip.dev/160 for more details.
Location : query
HTTP Method : GET
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples
▼ ▲ ces.projects.locations.apps.examples.patch
Description : Updates the specified example.
HTTP Method : PATCH
Scopes :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/examples/{examplesId}
Parameter Order : name
Path : v1/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/examples/[^/]+$
Type : string
Required : Yes
Description : Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}`
Location : path
updateMask
Location : query
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
Format : google-fieldmask
Type : string
▼ ▲ ces.projects.locations.apps.versions.get
Parameters :
name
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$
Type : string
Description : Required. The resource name of the app version to retrieve.
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}
Scopes :
Parameter Order : name
Description : Gets details of the specified app version.
Path : v1/{+name}
▼ ▲ ces.projects.locations.apps.versions.create
Path : v1/{+parent}/versions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions
Scopes :
HTTP Method : POST
Description : Creates a new app version in the given app.
Parameter Order : parent
Parameters :
parent
Description : Required. The resource name of the app to create an app version in.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
Required : Yes
Type : string
appVersionId
Description : Optional. The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version.
Type : string
Location : query
▼ ▲ ces.projects.locations.apps.versions.delete
Parameter Order : name
Parameters :
etag
Type : string
Location : query
Description : Optional. The current etag of the app version. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app version, deletion will be blocked and an ABORTED error will be returned.
name
Type : string
Location : path
Description : Required. The resource name of the app version to delete.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}
Path : v1/{+name}
Scopes :
Description : Deletes the specified app version.
HTTP Method : DELETE
▼ ▲ ces.projects.locations.apps.versions.list
Parameter Order : parent
Scopes :
Description : Lists all app versions in the given app.
Path : v1/{+parent}/versions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions
Parameters :
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
Type : integer
Format : int32
orderBy
Location : query
Type : string
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
parent
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Type : string
Location : path
Required : Yes
Description : Required. The resource name of the app to list app versions from.
filter
Description : Optional. Filter to be applied when listing the app versions. See https://google.aip.dev/160 for more details.
Location : query
Type : string
pageToken
Location : query
Type : string
Description : Optional. The next_page_token value returned from a previous list AgentService.ListAppVersions call.
HTTP Method : GET
▼ ▲ ces.projects.locations.apps.versions.restore
Path : v1/{+name}:restore
Parameter Order : name
Description : Restores the specified app version. This will create a new app version from the current draft app and overwrite the current draft with the specified app version.
HTTP Method : POST
Scopes :
Parameters :
name
Required : Yes
Description : Required. The resource name of the app version to restore.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}:restore
▼ ▲ ces.projects.locations.apps.deployments.delete
Parameter Order : name
HTTP Method : DELETE
Path : v1/{+name}
Parameters :
etag
Type : string
Description : Optional. The etag of the deployment. If an etag is provided and does not match the current etag of the deployment, deletion will be blocked and an ABORTED error will be returned.
Location : query
name
Required : Yes
Description : Required. The name of the deployment to delete. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$
Description : Deletes the specified deployment.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}
Scopes :
▼ ▲ ces.projects.locations.apps.deployments.list
Path : v1/{+parent}/deployments
Scopes :
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments
Parameters :
pageToken
Type : string
Description : Optional. A page token, received from a previous `ListDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeployments` must match the call that provided the page token.
Location : query
parent
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Description : Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}`
pageSize
Description : Optional. The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location : query
Type : integer
Format : int32
orderBy
Location : query
Type : string
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
HTTP Method : GET
Description : Lists deployments in the given app.
▼ ▲ ces.projects.locations.apps.deployments.create
Parameters :
parent
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Description : Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}`
Required : Yes
deploymentId
Description : Optional. The ID to use for the deployment, which will become the final component of the deployment's resource name. If not provided, a unique ID will be automatically assigned for the deployment.
Location : query
Type : string
Scopes :
Description : Creates a new deployment in the given app.
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments
Parameter Order : parent
Path : v1/{+parent}/deployments
▼ ▲ ces.projects.locations.apps.deployments.patch
Parameter Order : name
Scopes :
Parameters :
name
Type : string
Description : Identifier. The resource name of the deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$
Required : Yes
updateMask
Description : Optional. The list of fields to update.
Location : query
Type : string
Format : google-fieldmask
Path : v1/{+name}
Description : Updates the specified deployment.
HTTP Method : PATCH
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}
▼ ▲ ces.projects.locations.apps.deployments.get
Parameters :
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$
Description : Required. The name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`
Required : Yes
Parameter Order : name
Path : v1/{+name}
Scopes :
Description : Gets details of the specified deployment.
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}
▼ ▲ ces.projects.locations.apps.agents.create
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents
HTTP Method : POST
Description : Creates a new agent in the given app.
Parameter Order : parent
Path : v1/{+parent}/agents
Scopes :
Parameters :
parent
Description : Required. The resource name of the app to create an agent in.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
agentId
Type : string
Location : query
Description : Optional. The ID to use for the agent, which will become the final component of the agent's resource name. If not provided, a unique ID will be automatically assigned for the agent.
▼ ▲ ces.projects.locations.apps.agents.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}
HTTP Method : DELETE
Description : Deletes the specified agent.
Path : v1/{+name}
Scopes :
Parameters :
force
Location : query
Description : Optional. Indicates whether to forcefully delete the agent, even if it is still referenced by other app/agents/examples. * If `force = false`, the deletion fails if other agents/examples reference it. * If `force = true`, delete the agent and remove it from all referencing apps/agents/examples.
Type : boolean
etag
Type : string
Description : Optional. The current etag of the agent. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the agent, deletion will be blocked and an ABORTED error will be returned.
Location : query
name
Description : Required. The resource name of the agent to delete.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$
Required : Yes
Parameter Order : name
▼ ▲ ces.projects.locations.apps.agents.patch
Scopes :
Description : Updates the specified agent.
Parameters :
name
Location : path
Type : string
Required : Yes
Description : Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}`
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$
updateMask
Type : string
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
Location : query
Format : google-fieldmask
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}
HTTP Method : PATCH
Parameter Order : name
▼ ▲ ces.projects.locations.apps.agents.list
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents
Path : v1/{+parent}/agents
Parameters :
filter
Location : query
Description : Optional. Filter to be applied when listing the agents. See https://google.aip.dev/160 for more details.
Type : string
pageToken
Type : string
Location : query
Description : Optional. The next_page_token value returned from a previous list AgentService.ListAgents call.
orderBy
Location : query
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Type : string
parent
Type : string
Description : Required. The resource name of the app to list agents from.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
pageSize
Format : int32
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
Type : integer
Scopes :
Parameter Order : parent
Description : Lists agents in the given app.
▼ ▲ ces.projects.locations.apps.agents.get
Description : Gets details of the specified agent.
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/agents/[^/]+$
Location : path
Description : Required. The resource name of the agent to retrieve.
Type : string
Required : Yes
Path : v1/{+name}
HTTP Method : GET
Scopes :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/agents/{agentsId}
Parameter Order : name
▼ ▲ ces.projects.locations.apps.tools.delete
Scopes :
Description : Deletes the specified tool.
Parameters :
name
Location : path
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$
Description : Required. The resource name of the tool to delete.
etag
Type : string
Description : Optional. The current etag of the tool. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the tool, deletion will be blocked and an ABORTED error will be returned.
Location : query
force
Location : query
Type : boolean
Description : Optional. Indicates whether to forcefully delete the tool, even if it is still referenced by agents/examples. * If `force = false`, the deletion will fail if any agents still reference the tool. * If `force = true`, all existing references from agents will be removed and the tool will be deleted.
HTTP Method : DELETE
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}
Path : v1/{+name}
▼ ▲ ces.projects.locations.apps.tools.get
HTTP Method : GET
Description : Gets details of the specified tool.
Scopes :
Parameters :
name
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$
Type : string
Description : Required. The resource name of the tool to retrieve.
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}
Parameter Order : name
▼ ▲ ces.projects.locations.apps.tools.create
Scopes :
HTTP Method : POST
Parameters :
parent
Required : Yes
Location : path
Description : Required. The resource name of the app to create a tool in.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Type : string
toolId
Description : Optional. The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool.
Type : string
Location : query
Path : v1/{+parent}/tools
Description : Creates a new tool in the given app.
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools
▼ ▲ ces.projects.locations.apps.tools.patch
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools/{toolsId}
Path : v1/{+name}
HTTP Method : PATCH
Scopes :
Parameters :
updateMask
Location : query
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
Format : google-fieldmask
Type : string
name
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/tools/[^/]+$
Description : Identifier. The unique identifier of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for ## standalone tools. `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only, they cannot be referenced directly where a tool is expected.
Type : string
Parameter Order : name
Description : Updates the specified tool.
▼ ▲ ces.projects.locations.apps.tools.list
Parameters :
filter
Type : string
Location : query
Description : Optional. Filter to be applied when listing the tools. Use "include_system_tools=true" to include system tools in the response. See https://google.aip.dev/160 for more details.
pageToken
Location : query
Description : Optional. The next_page_token value returned from a previous list AgentService.ListTools call.
Type : string
parent
Location : path
Description : Required. The resource name of the app to list tools from.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
pageSize
Location : query
Format : int32
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type : integer
orderBy
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Location : query
Type : string
Parameter Order : parent
HTTP Method : GET
Path : v1/{+parent}/tools
Description : Lists tools in the given app.
Scopes :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/tools
▼ ▲ ces.projects.locations.apps.sessions.runSession
Description : Initiates a single turn interaction with the CES agent within a session.
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:runSession
Parameters :
session
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$
Location : path
Description : Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}`
Path : v1/{+session}:runSession
Parameter Order : session
Scopes :
▼ ▲ ces.projects.locations.apps.sessions.generateChatToken
Parameters :
name
Location : path
Description : Required. The session name to generate the chat token for. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/sessions/[^/]+$
Type : string
Required : Yes
HTTP Method : POST
Scopes :
Path : v1/{+name}:generateChatToken
Parameter Order : name
Description : Generates a session scoped token for chat widget to authenticate with Session APIs.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/sessions/{sessionsId}:generateChatToken
▼ ▲ ces.projects.locations.apps.guardrails.patch
Scopes :
Path : v1/{+name}
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}
Parameters :
updateMask
Location : query
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
Type : string
Format : google-fieldmask
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$
Description : Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}`
Type : string
Location : path
Required : Yes
Description : Updates the specified guardrail.
HTTP Method : PATCH
▼ ▲ ces.projects.locations.apps.guardrails.create
Parameter Order : parent
Path : v1/{+parent}/guardrails
Description : Creates a new guardrail in the given app.
Scopes :
Parameters :
guardrailId
Description : Optional. The ID to use for the guardrail, which will become the final component of the guardrail's resource name. If not provided, a unique ID will be automatically assigned for the guardrail.
Type : string
Location : query
parent
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
Type : string
Description : Required. The resource name of the app to create a guardrail in.
Required : Yes
HTTP Method : POST
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails
▼ ▲ ces.projects.locations.apps.guardrails.delete
Parameters :
etag
Description : Optional. The current etag of the guardrail. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the guardrail, deletion will be blocked and an ABORTED error will be returned.
Location : query
Type : string
force
Type : boolean
Location : query
Description : Optional. Indicates whether to forcefully delete the guardrail, even if it is still referenced by app/agents. * If `force = false`, the deletion fails if any apps/agents still reference the guardrail. * If `force = true`, all existing references from apps/agents will be removed and the guardrail will be deleted.
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$
Description : Required. The resource name of the guardrail to delete.
Type : string
Required : Yes
Scopes :
Description : Deletes the specified guardrail.
Path : v1/{+name}
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}
HTTP Method : DELETE
▼ ▲ ces.projects.locations.apps.guardrails.get
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails/{guardrailsId}
HTTP Method : GET
Parameter Order : name
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/guardrails/[^/]+$
Required : Yes
Type : string
Description : Required. The resource name of the guardrail to retrieve.
Description : Gets details of the specified guardrail.
Path : v1/{+name}
Scopes :
▼ ▲ ces.projects.locations.apps.guardrails.list
HTTP Method : GET
Parameter Order : parent
Path : v1/{+parent}/guardrails
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/guardrails
Parameters :
pageToken
Description : Optional. The next_page_token value returned from a previous list AgentService.ListGuardrails call.
Location : query
Type : string
orderBy
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Location : query
Type : string
filter
Description : Optional. Filter to be applied when listing the guardrails. See https://google.aip.dev/160 for more details.
Location : query
Type : string
parent
Required : Yes
Type : string
Location : path
Description : Required. The resource name of the app to list guardrails from.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
pageSize
Type : integer
Format : int32
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
Scopes :
Description : Lists guardrails in the given app.
▼ ▲ ces.projects.locations.apps.toolsets.create
Description : Creates a new toolset in the given app.
Parameter Order : parent
Parameters :
toolsetId
Location : query
Description : Optional. The ID to use for the toolset, which will become the final component of the toolset's resource name. If not provided, a unique ID will be automatically assigned for the toolset.
Type : string
parent
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Description : Required. The resource name of the app to create a toolset in.
Location : path
Type : string
Required : Yes
HTTP Method : POST
Scopes :
Path : v1/{+parent}/toolsets
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets
▼ ▲ ces.projects.locations.apps.toolsets.delete
Description : Deletes the specified toolset.
Scopes :
Path : v1/{+name}
Parameter Order : name
Parameters :
force
Description : Optional. Indicates whether to forcefully delete the toolset, even if it is still referenced by app/agents. * If `force = false`, the deletion fails if any agents still reference the toolset. * If `force = true`, all existing references from agents will be removed and the toolset will be deleted.
Location : query
Type : boolean
name
Description : Required. The resource name of the toolset to delete.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$
Type : string
Location : path
Required : Yes
etag
Type : string
Description : Optional. The current etag of the toolset. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the toolset, deletion will be blocked and an ABORTED error will be returned.
Location : query
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}
HTTP Method : DELETE
▼ ▲ ces.projects.locations.apps.toolsets.list
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets
HTTP Method : GET
Parameter Order : parent
Parameters :
orderBy
Type : string
Location : query
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
pageToken
Location : query
Description : Optional. The next_page_token value returned from a previous list AgentService.ListToolsets call.
Type : string
filter
Location : query
Description : Optional. Filter to be applied when listing the toolsets. See https://google.aip.dev/160 for more details.
Type : string
pageSize
Location : query
Format : int32
Type : integer
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Description : Required. The resource name of the app to list toolsets from.
Location : path
Required : Yes
Description : Lists toolsets in the given app.
Path : v1/{+parent}/toolsets
Scopes :
▼ ▲ ces.projects.locations.apps.toolsets.get
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}
Scopes :
Parameters :
name
Description : Required. The resource name of the toolset to retrieve.
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$
Type : string
Required : Yes
Location : path
Parameter Order : name
Path : v1/{+name}
HTTP Method : GET
Description : Gets details of the specified toolset.
▼ ▲ ces.projects.locations.apps.toolsets.retrieveTools
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}:retrieveTools
Path : v1/{+toolset}:retrieveTools
Description : Retrieve the list of tools included in the specified toolset.
HTTP Method : POST
Parameter Order : toolset
Parameters :
toolset
Location : path
Required : Yes
Type : string
Description : Required. The name of the toolset to retrieve the tools for. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$
Scopes :
▼ ▲ ces.projects.locations.apps.toolsets.patch
HTTP Method : PATCH
Description : Updates the specified toolset.
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/toolsets/{toolsetsId}
Parameters :
updateMask
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
Format : google-fieldmask
Type : string
Location : query
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/toolsets/[^/]+$
Location : path
Required : Yes
Description : Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
Type : string
Parameter Order : name
Scopes :
▼ ▲ ces.projects.locations.apps.conversations.get
Path : v1/{+name}
Scopes :
Description : Gets details of the specified conversation.
HTTP Method : GET
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$
Required : Yes
Description : Required. The resource name of the conversation to retrieve.
source
Enum :
Enum Descriptions :
Location : query
Deprecated : Yes
Type : string
Description : Optional. Indicate the source of the conversation. If not set, all source will be searched.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}
Parameter Order : name
▼ ▲ ces.projects.locations.apps.conversations.list
Parameters :
source
Description : Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default.
Enum Descriptions :
Type : string
Enum :
Location : query
pageSize
Format : int32
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
Type : integer
parent
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
Description : Required. The resource name of the app to list conversations from.
Type : string
Required : Yes
filter
Type : string
Description : Optional. Filter to be applied when listing the conversations. See https://google.aip.dev/160 for more details.
Location : query
pageToken
Description : Optional. The next_page_token value returned from a previous list AgentService.ListConversations call.
Type : string
Location : query
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations
Description : Lists conversations in the given app.
Parameter Order : parent
Path : v1/{+parent}/conversations
Scopes :
▼ ▲ ces.projects.locations.apps.conversations.batchDelete
Description : Batch deletes the specified conversations.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations:batchDelete
Path : v1/{+parent}/conversations:batchDelete
Parameters :
parent
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Description : Required. The resource name of the app to delete conversations from. Format: `projects/{project}/locations/{location}/apps/{app}`
Parameter Order : parent
HTTP Method : POST
Scopes :
▼ ▲ ces.projects.locations.apps.conversations.delete
Parameter Order : name
Description : Deletes the specified conversation.
HTTP Method : DELETE
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/conversations/{conversationsId}
Path : v1/{+name}
Scopes :
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+/conversations/[^/]+$
Required : Yes
Description : Required. The resource name of the conversation to delete.
Type : string
source
Enum :
Deprecated : Yes
Enum Descriptions :
Description : Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default.
Location : query
Type : string
▼ ▲ ces.projects.locations.apps.retrieveToolSchema
Path : v1/{+parent}:retrieveToolSchema
Parameter Order : parent
Parameters :
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Location : path
Description : Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}`
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:retrieveToolSchema
Description : Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool.
HTTP Method : POST
Scopes :
▼ ▲ ces.projects.locations.apps.get
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Required : Yes
Description : Required. The resource name of the app to retrieve.
Type : string
Scopes :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}
Description : Gets details of the specified app.
Path : v1/{+name}
HTTP Method : GET
Parameter Order : name
▼ ▲ ces.projects.locations.apps.list
Parameters :
pageSize
Type : integer
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Format : int32
Location : query
parent
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Description : Required. The resource name of the location to list apps from.
filter
Type : string
Location : query
Description : Optional. Filter to be applied when listing the apps. See https://google.aip.dev/160 for more details.
pageToken
Type : string
Location : query
Description : Optional. The next_page_token value returned from a previous list AgentService.ListApps call.
orderBy
Description : Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details.
Location : query
Type : string
Scopes :
Path : v1/{+parent}/apps
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps
Description : Lists apps in the given project and location.
Parameter Order : parent
▼ ▲ ces.projects.locations.apps.patch
HTTP Method : PATCH
Description : Updates the specified app.
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}
Parameters :
updateMask
Location : query
Type : string
Format : google-fieldmask
Description : Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Description : Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}`
Location : path
Parameter Order : name
Scopes :
▼ ▲ ces.projects.locations.apps.importApp
Description : Imports the specified app.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps:importApp
Parameters :
parent
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The parent resource name with the location of the app to import.
Location : path
Required : Yes
HTTP Method : POST
Path : v1/{+parent}/apps:importApp
Parameter Order : parent
Scopes :
▼ ▲ ces.projects.locations.apps.executeTool
HTTP Method : POST
Path : v1/{+parent}:executeTool
Scopes :
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:executeTool
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Description : Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}`
Required : Yes
Location : path
Type : string
Description : Executes the given tool with the given arguments.
▼ ▲ ces.projects.locations.apps.delete
Path : v1/{+name}
HTTP Method : DELETE
Scopes :
Parameters :
name
Description : Required. The resource name of the app to delete.
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
etag
Description : Optional. The current etag of the app. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app, deletion will be blocked and an ABORTED error will be returned.
Type : string
Location : query
Parameter Order : name
Description : Deletes the specified app.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}
▼ ▲ ces.projects.locations.apps.exportApp
Description : Exports the specified app.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}:exportApp
Parameter Order : name
Path : v1/{+name}:exportApp
HTTP Method : POST
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/apps/[^/]+$
Required : Yes
Description : Required. The resource name of the app to export.
Location : path
Type : string
Scopes :
▼ ▲ ces.projects.locations.apps.create
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/apps
HTTP Method : POST
Path : v1/{+parent}/apps
Scopes :
Description : Creates a new app in the given project and location.
Parameter Order : parent
Parameters :
parent
Description : Required. The resource name of the location to create an app in.
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
appId
Location : query
Type : string
Description : Optional. The ID to use for the app, which will become the final component of the app's resource name. If not provided, a unique ID will be automatically assigned for the app.
▼ ▲ ces.projects.locations.list
Flat Path : v1/projects/{projectsId}/locations
Scopes :
Parameter Order : name
Parameters :
extraLocationTypes
Repeated : Yes
Type : string
Location : query
Description : Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
name
Location : path
Description : The resource that owns the locations collection, if applicable.
Required : Yes
Type : string
Pattern : ^projects/[^/]+$
pageSize
Location : query
Type : integer
Description : The maximum number of results to return. If not set, the service selects a default.
Format : int32
pageToken
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Type : string
Location : query
filter
Location : query
Type : string
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Path : v1/{+name}/locations
Description : Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
HTTP Method : GET
▼ ▲ ces.projects.locations.get
Scopes :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}
Parameters :
name
Description : Resource name for the location.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Path : v1/{+name}
HTTP Method : GET
Parameter Order : name
Description : Gets information about a location.