---
title: "POST /v3/{+parent}/playbooks"
method: POST
path: "/v3/{+parent}/playbooks"
tags: ["projects"]
---

# POST /v3/{+parent}/playbooks

`POST /v3/{+parent}/playbooks`

## Path parameters

- `parent` string, required

## Request body

- GoogleCloudDialogflowCxV3Playbook
  - `codeBlock` GoogleCloudDialogflowCxV3CodeBlock
    - `code` string
  - `referencedFlows` string[]
  - `tokenCount` string, int64
  - `name` string
  - `referencedPlaybooks` string[]
  - `outputParameterDefinitions` GoogleCloudDialogflowCxV3ParameterDefinition[]
    - `name` string
    - `typeSchema` GoogleCloudDialogflowCxV3TypeSchema
      - `inlineSchema` GoogleCloudDialogflowCxV3InlineSchema
        - `type` 'DATA_TYPE_UNSPECIFIED' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'ARRAY'
        - `items` GoogleCloudDialogflowCxV3TypeSchema — recursive
      - `schemaReference` GoogleCloudDialogflowCxV3TypeSchemaSchemaReference
        - `tool` string
        - `schema` string
    - `type` 'PARAMETER_TYPE_UNSPECIFIED' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'NULL' | 'OBJECT' | 'LIST'
    - `description` string
  - `referencedTools` string[]
  - `inlineActions` string[]
  - `llmModelSettings` GoogleCloudDialogflowCxV3LlmModelSettings
    - `promptText` string
    - `model` string
  - `displayName` string
  - `playbookType` 'PLAYBOOK_TYPE_UNSPECIFIED' | 'TASK' | 'ROUTINE'
  - `handlers` GoogleCloudDialogflowCxV3Handler[]
    - `eventHandler` GoogleCloudDialogflowCxV3HandlerEventHandler
      - `condition` string
      - `event` string
      - `fulfillment` GoogleCloudDialogflowCxV3Fulfillment
        - `enableGenerativeFallback` boolean
        - `webhook` string
        - `tag` string
        - `advancedSettings` GoogleCloudDialogflowCxV3AdvancedSettings
          - `speechSettings` GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings
            - `models` object
            - `endpointerSensitivity` integer
            - `useTimeoutBasedEndpointing` boolean
            - `noSpeechTimeout` string, google-duration
          - `loggingSettings` GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings
            - `enableInteractionLogging` boolean
            - `enableConsentBasedRedaction` boolean
            - `enableStackdriverLogging` boolean
          - `dtmfSettings` GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings
            - `enabled` boolean
            - `maxDigits` integer
            - `finishDigit` string
            - `endpointingTimeoutDuration` string, google-duration
            - `interdigitTimeoutDuration` string, google-duration
          - `audioExportGcsDestination` GoogleCloudDialogflowCxV3GcsDestination
            - `uri` string
        - `setParameterActions` GoogleCloudDialogflowCxV3FulfillmentSetParameterAction[]
          - `value` unknown
          - `parameter` string
        - `returnPartialResponses` boolean
        - `generators` GoogleCloudDialogflowCxV3FulfillmentGeneratorSettings[]
          - `generator` string
          - `inputParameters` object
          - `outputParameter` string
        - `conditionalCases` GoogleCloudDialogflowCxV3FulfillmentConditionalCases[]
          - `cases` GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCase[]
            - `condition` string
            - `caseContent` GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCaseCaseContent[]
              - …
        - `messages` GoogleCloudDialogflowCxV3ResponseMessage[]
          - `payload` object
          - `endInteraction` GoogleCloudDialogflowCxV3ResponseMessageEndInteraction
          - `channel` string
          - `outputAudioText` GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText
            - `ssml` string
            - `allowPlaybackInterruption` boolean
            - `text` string
          - `playAudio` GoogleCloudDialogflowCxV3ResponseMessagePlayAudio
            - `allowPlaybackInterruption` boolean
            - `audioUri` string
          - `mixedAudio` GoogleCloudDialogflowCxV3ResponseMessageMixedAudio
            - `segments` GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment[]
              - …
          - `responseType` 'RESPONSE_TYPE_UNSPECIFIED' | 'ENTRY_PROMPT' | 'PARAMETER_PROMPT' | 'HANDLER_PROMPT'
          - `conversationSuccess` GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess
            - `metadata` object
          - `liveAgentHandoff` GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff
            - `metadata` object
          - `text` GoogleCloudDialogflowCxV3ResponseMessageText
            - `allowPlaybackInterruption` boolean
            - `text` string[]
          - `telephonyTransferCall` GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall
            - `phoneNumber` string
          - `knowledgeInfoCard` GoogleCloudDialogflowCxV3ResponseMessageKnowledgeInfoCard
          - `toolCall` GoogleCloudDialogflowCxV3ToolCall
            - `tool` string
            - `inputParameters` object
            - `action` string
    - `lifecycleHandler` GoogleCloudDialogflowCxV3HandlerLifecycleHandler
      - `lifecycleStage` string
      - `fulfillment` GoogleCloudDialogflowCxV3Fulfillment
        - `enableGenerativeFallback` boolean
        - `webhook` string
        - `tag` string
        - `advancedSettings` GoogleCloudDialogflowCxV3AdvancedSettings
          - `speechSettings` GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings
            - `models` object
            - `endpointerSensitivity` integer
            - `useTimeoutBasedEndpointing` boolean
            - `noSpeechTimeout` string, google-duration
          - `loggingSettings` GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings
            - `enableInteractionLogging` boolean
            - `enableConsentBasedRedaction` boolean
            - `enableStackdriverLogging` boolean
          - `dtmfSettings` GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings
            - `enabled` boolean
            - `maxDigits` integer
            - `finishDigit` string
            - `endpointingTimeoutDuration` string, google-duration
            - `interdigitTimeoutDuration` string, google-duration
          - `audioExportGcsDestination` GoogleCloudDialogflowCxV3GcsDestination
            - `uri` string
        - `setParameterActions` GoogleCloudDialogflowCxV3FulfillmentSetParameterAction[]
          - `value` unknown
          - `parameter` string
        - `returnPartialResponses` boolean
        - `generators` GoogleCloudDialogflowCxV3FulfillmentGeneratorSettings[]
          - `generator` string
          - `inputParameters` object
          - `outputParameter` string
        - `conditionalCases` GoogleCloudDialogflowCxV3FulfillmentConditionalCases[]
          - `cases` GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCase[]
            - `condition` string
            - `caseContent` GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCaseCaseContent[]
              - …
        - `messages` GoogleCloudDialogflowCxV3ResponseMessage[]
          - `payload` object
          - `endInteraction` GoogleCloudDialogflowCxV3ResponseMessageEndInteraction
          - `channel` string
          - `outputAudioText` GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText
            - `ssml` string
            - `allowPlaybackInterruption` boolean
            - `text` string
          - `playAudio` GoogleCloudDialogflowCxV3ResponseMessagePlayAudio
            - `allowPlaybackInterruption` boolean
            - `audioUri` string
          - `mixedAudio` GoogleCloudDialogflowCxV3ResponseMessageMixedAudio
            - `segments` GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment[]
              - …
          - `responseType` 'RESPONSE_TYPE_UNSPECIFIED' | 'ENTRY_PROMPT' | 'PARAMETER_PROMPT' | 'HANDLER_PROMPT'
          - `conversationSuccess` GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess
            - `metadata` object
          - `liveAgentHandoff` GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff
            - `metadata` object
          - `text` GoogleCloudDialogflowCxV3ResponseMessageText
            - `allowPlaybackInterruption` boolean
            - `text` string[]
          - `telephonyTransferCall` GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall
            - `phoneNumber` string
          - `knowledgeInfoCard` GoogleCloudDialogflowCxV3ResponseMessageKnowledgeInfoCard
          - `toolCall` GoogleCloudDialogflowCxV3ToolCall
            - `tool` string
            - `inputParameters` object
            - `action` string
      - `condition` string
  - `instruction` GoogleCloudDialogflowCxV3PlaybookInstruction
    - `guidelines` string
    - `steps` GoogleCloudDialogflowCxV3PlaybookStep[]
      - `text` string
      - `steps` GoogleCloudDialogflowCxV3PlaybookStep[]
  - `goal` string
  - `updateTime` string, google-datetime
  - `inputParameterDefinitions` GoogleCloudDialogflowCxV3ParameterDefinition[]
    - `name` string
    - `typeSchema` GoogleCloudDialogflowCxV3TypeSchema
      - `inlineSchema` GoogleCloudDialogflowCxV3InlineSchema
        - `type` 'DATA_TYPE_UNSPECIFIED' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'ARRAY'
        - `items` GoogleCloudDialogflowCxV3TypeSchema — recursive
      - `schemaReference` GoogleCloudDialogflowCxV3TypeSchemaSchemaReference
        - `tool` string
        - `schema` string
    - `type` 'PARAMETER_TYPE_UNSPECIFIED' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'NULL' | 'OBJECT' | 'LIST'
    - `description` string
  - `createTime` string, google-datetime

## Response `200`

Successful response

---

[API](https://skmtc.dev/google/apis/dialogflow.md) · [All operations](https://skmtc.dev/google/apis/dialogflow/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/dialogflow/revisions/9d65e7f14110/schema)