Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1336218221.3 KB
projects

Creates a new app in the given project and location.

post/v1/{+parent}/apps

Path parameters

parentstring required

Required. The resource name of the location to create an app in.

Query parameters

appIdstring

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.

Request body

namestring

Identifier. The unique identifier of the app. Format: projects/{project}/locations/{location}/apps/{app}

descriptionstring

Optional. Human-readable description of the app.

createTimestring google-datetime

Output only. Timestamp when the app was created.

etagstring

Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

lockedboolean

Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected.

pinnedboolean

Optional. Whether the app is pinned in the app list.

deploymentCountinteger

Output only. Number of deployments in the app.

toolExecutionMode'TOOL_EXECUTION_MODE_UNSPECIFIED' | 'PARALLEL' | 'SEQUENTIAL'

Optional. The tool execution mode for the app. If not provided, will default to PARALLEL.

metadataobject

Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages.

globalInstructionstring

Optional. Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents.

updateTimestring google-datetime

Output only. Timestamp when the app was last updated.

rootAgentstring

Optional. The root agent is the entry point of the app. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

validationErrorsstring[]

Output only. Misconfigurations or warnings in the app.

displayNamestring

Required. Display name of the app.

guardrailsstring[]

Optional. List of guardrails for the app. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

Response

Successful response