Method: legacyPlaybooks.legacyAiGenerate

Full name: projects.locations.instances.legacyPlaybooks.legacyAiGenerate

Generates a playbook using AI based on the provided user prompt.

HTTP request


Path parameters

Parameters
instance

string

Required. The instance to generate the playbook for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "prompt": string,
  "playbook": {
    object (ApiWorkflowDefinitionDataModel)
  },
  "metadata": {
    object (PlaybooksAiServiceGenerationResponseMetadata)
  },
  "hashedUserId": string
}
Fields
prompt

string

Required. The user prompt to generate the playbook.
playbook

object (ApiWorkflowDefinitionDataModel)

Optional. The playbook to generate the playbook.
metadata

object (PlaybooksAiServiceGenerationResponseMetadata)

Optional. Metadata for the response.
hashedUserId

string

Optional. A hashed identifier of the user initiating the playbook generation request.

Response body

LegacyPlaybookAiGenerateResponse is a response for generating a playbook with AI.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "instance": string,
  "playbook": {
    object (ApiWorkflowDefinitionDataModel)
  },
  "correlationId": string
}
Fields
instance

string

Required. The instance to generate the playbook for. Format: projects/{project}/locations/{location}/instances/{instance}
playbook

object (ApiWorkflowDefinitionDataModel)

Optional. The generated playbook.
correlationId

string

Optional. The correlation id of the request.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.