REST Resource: projects.locations.instances.labsExperiments

Resource: LabsExperiment

The LabsExperiment resource, contains the metadata of an experiment.

JSON representation 
{
  "name": string,
  "description": string,
  "category": enum (Category),
  "createTime": string,
  "updateTime": string,
  "expiryTime": string,
  "metadata": {
    object
  },
  "timeout": string,
  "uiSchema": {
    object
  },
  "enabled": boolean,
  "type": enum (ExperimentType),
  "agenticConfig": {
    object (AgenticConfig)
  }
}
Fields
name

string

Identifier. The unique name of the Experiment.
description

string

Output only. The description of the Experiment.
category

enum (Category)

Output only. The category of the experiment. (e.g. Detections, Search)
createTime

string (Timestamp format)

Output only. The time the experiment was created, also used as a Release Date.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The time the experiment was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
expiryTime

string (Timestamp format)

Output only. The time the experiment expires, UI representation only.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
metadata

object (Struct format)

Output only. Metadata for the experiment, such as image.
timeout

string (Duration format)

Output only. Timeout for the entire experiment execution

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
uiSchema

object (Struct format)

Output only. The UI schema of the experiment defining the experiment page. This is used when type is STANDARD.
enabled

boolean

Optional. Whether the experiment is enabled.
type

enum (ExperimentType)

Output only. The type of the experiment. This determines which configuration (e.g., uiSchema or agenticConfig) is relevant.
agenticConfig

object (AgenticConfig)

Output only. Configuration for Agentic experiments. This is used when type is AGENTIC.

Category

The category in the product the experiment is in. e.g. "Detections", "Search", "Response", "Data Management"

Enums
CATEGORY_UNSPECIFIED The category is unspecified.
DETECTIONS Detection category.
SEARCH Search category.
RESPONSE Response category.
DATA_MANAGEMENT Data Management category.

ExperimentType

Defines the execution mode of the experiment. No new types are expected to be added to this enum.

Enums
EXPERIMENT_TYPE_UNSPECIFIED Type unspecified.
STANDARD The traditional multi-stage flow (Form/Chat stages) driven by uiSchema.
AGENTIC The ADK-based, single-session flow driven by agenticConfig.

AgenticConfig

Configuration for an Agentic Experiment.

JSON representation 
{
  "agentId": string,
  "welcomeMessage": string,
  "initialPrompt": string
}
Fields
agentId

string

Output only. The ID of the Agent in the Agent Hub (for routing)
welcomeMessage

string

Output only. A simple text message shown immediately to the user upon opening the experiment.
initialPrompt

string

Output only. A prompt sent to the agent automatically when the session starts.

Methods

execute

 Executes a LabsExperiment.

get

 Gets a LabExperiment.

list

 Lists LabsExperiments.

patch

 Update a LabsExperiment.