Google Dialogflow · Schema
GoogleCloudDialogflowCxV3Playbook
AgentsArtificial IntelligenceChatbotsConversational AIGoogle CloudMachine LearningNatural Language ProcessingSpeech RecognitionVirtual AgentsVoice Assistant
Properties
| Name | Type | Description |
|---|---|---|
| inputParameterDefinitions | array | |
| codeBlock | object | |
| referencedPlaybooks | array | |
| playbookType | string | |
| handlers | array | |
| referencedFlows | array | |
| referencedTools | array | |
| displayName | string | |
| goal | string | |
| name | string | |
| llmModelSettings | object | |
| createTime | string | |
| instruction | object | |
| inlineActions | array | |
| tokenCount | string | |
| updateTime | string | |
| outputParameterDefinitions | array |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/google-dialogflow/json-schema/google-dialogflow-google-cloud-dialogflow-cx-v3-playbook-schema.json",
"title": "GoogleCloudDialogflowCxV3Playbook",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/google-dialogflow-playbooks-api-openapi.yml#/components/schemas/GoogleCloudDialogflowCxV3Playbook",
"type": "object",
"properties": {
"inputParameterDefinitions": {
"type": "array",
"items": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3ParameterDefinition"
}
},
"codeBlock": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3CodeBlock"
},
"referencedPlaybooks": {
"type": "array",
"readOnly": true,
"items": {
"type": "string"
}
},
"playbookType": {
"type": "string",
"enum": [
"PLAYBOOK_TYPE_UNSPECIFIED",
"TASK",
"ROUTINE"
],
"x-enumDescriptions": [
"",
"",
""
]
},
"handlers": {
"type": "array",
"items": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3Handler"
}
},
"referencedFlows": {
"type": "array",
"readOnly": true,
"items": {
"type": "string"
}
},
"referencedTools": {
"type": "array",
"items": {
"type": "string"
}
},
"displayName": {
"type": "string"
},
"goal": {
"type": "string"
},
"name": {
"type": "string"
},
"llmModelSettings": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3LlmModelSettings"
},
"createTime": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"instruction": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3PlaybookInstruction"
},
"inlineActions": {
"type": "array",
"readOnly": true,
"items": {
"type": "string"
}
},
"tokenCount": {
"type": "string",
"format": "int64",
"readOnly": true
},
"updateTime": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"outputParameterDefinitions": {
"type": "array",
"items": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3ParameterDefinition"
}
}
},
"$defs": {
"GoogleCloudDialogflowCxV3AdvancedSettings": {
"type": "object",
"properties": {
"speechSettings": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings"
},
"audioExportGcsDestination": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3GcsDestination"
},
"loggingSettings": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings"
},
"dtmfSettings": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings"
}
}
},
"GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"finishDigit": {
"type": "string"
},
"interdigitTimeoutDuration": {
"type": "string"
},
"maxDigits": {
"type": "integer",
"format": "int32"
},
"endpointingTimeoutDuration": {
"type": "string"
}
}
},
"GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings": {
"type": "object",
"properties": {
"enableConsentBasedRedaction": {
"type": "boolean"
},
"enableStackdriverLogging": {
"type": "boolean"
},
"enableInteractionLogging": {
"type": "boolean"
}
}
},
"GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings": {
"type": "object",
"properties": {
"noSpeechTimeout": {
"type": "string"
},
"models": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"useTimeoutBasedEndpointing": {
"type": "boolean"
},
"endpointerSensitivity": {
"type": "integer",
"format": "int32"
}
}
},
"GoogleCloudDialogflowCxV3CodeBlock": {
"type": "object",
"properties": {
"code": {
"type": "string"
}
}
},
"GoogleCloudDialogflowCxV3Fulfillment": {
"type": "object",
"properties": {
"setParameterActions": {
"type": "array",
"items": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3FulfillmentSetParameterAction"
}
},
"tag": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3ResponseMessage"
}
},
"conditionalCases": {
"type": "array",
"items": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3FulfillmentConditionalCases"
}
},
"returnPartialResponses": {
"type": "boolean"
},
"advancedSettings": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3AdvancedSettings"
},
"generators": {
"type": "array",
"items": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3FulfillmentGeneratorSettings"
}
},
"enableGenerativeFallback": {
"type": "boolean"
},
"webhook": {
"type": "string"
},
"codeBlockFunction": {
"type": "string"
}
}
},
"GoogleCloudDialogflowCxV3FulfillmentConditionalCases": {
"type": "object",
"properties": {
"cases": {
"type": "array",
"items": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCase"
}
}
}
},
"GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCase": {
"type": "object",
"properties": {
"caseContent": {
"type": "array",
"items": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCaseCaseContent"
}
},
"condition": {
"type": "string"
}
}
},
"GoogleCloudDialogflowCxV3FulfillmentConditionalCasesCaseCaseContent": {
"type": "object",
"properties": {
"additionalCases": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3FulfillmentConditionalCases"
},
"message": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3ResponseMessage"
}
}
},
"GoogleCloudDialogflowCxV3FulfillmentGeneratorSettings": {
"type": "object",
"properties": {
"generator": {
"type": "string"
},
"outputParameter": {
"type": "string"
},
"inputParameters": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"GoogleCloudDialogflowCxV3FulfillmentSetParameterAction": {
"type": "object",
"properties": {
"parameter": {
"type": "string"
},
"value": {}
}
},
"GoogleCloudDialogflowCxV3GcsDestination": {
"type": "object",
"properties": {
"uri": {
"type": "string"
}
}
},
"GoogleCloudDialogflowCxV3Handler": {
"type": "object",
"properties": {
"eventHandler": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3HandlerEventHandler"
},
"lifecycleHandler": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3HandlerLifecycleHandler"
}
}
},
"GoogleCloudDialogflowCxV3HandlerEventHandler": {
"type": "object",
"properties": {
"condition": {
"type": "string"
},
"event": {
"type": "string"
},
"fulfillment": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3Fulfillment"
}
}
},
"GoogleCloudDialogflowCxV3HandlerLifecycleHandler": {
"type": "object",
"properties": {
"condition": {
"type": "string"
},
"fulfillment": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3Fulfillment"
},
"lifecycleStage": {
"type": "string"
}
}
},
"GoogleCloudDialogflowCxV3InlineSchema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"DATA_TYPE_UNSPECIFIED",
"STRING",
"NUMBER",
"BOOLEAN",
"ARRAY"
],
"x-enumDescriptions": [
"",
"",
"",
"",
""
]
},
"items": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3TypeSchema"
}
}
},
"GoogleCloudDialogflowCxV3LlmModelSettings": {
"type": "object",
"properties": {
"model": {
"type": "string"
},
"promptText": {
"type": "string"
}
}
},
"GoogleCloudDialogflowCxV3ParameterDefinition": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PARAMETER_TYPE_UNSPECIFIED",
"STRING",
"NUMBER",
"BOOLEAN",
"NULL",
"OBJECT",
"LIST"
],
"x-enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
]
},
"description": {
"type": "string"
},
"typeSchema": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3TypeSchema"
},
"name": {
"type": "string"
}
}
},
"GoogleCloudDialogflowCxV3PlaybookInstruction": {
"type": "object",
"properties": {
"guidelines": {
"type": "string"
},
"steps": {
"type": "array",
"items": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3PlaybookStep"
}
}
}
},
"GoogleCloudDialogflowCxV3PlaybookStep": {
"type": "object",
"properties": {
"steps": {
"type": "array",
"items": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3PlaybookStep"
}
},
"text": {
"type": "string"
}
}
},
"GoogleCloudDialogflowCxV3ResponseMessage": {
"type": "object",
"properties": {
"outputAudioText": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText"
},
"endInteraction": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3ResponseMessageEndInteraction"
},
"toolCall": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3ToolCall"
},
"responseType": {
"type": "string",
"enum": [
"RESPONSE_TYPE_UNSPECIFIED",
"ENTRY_PROMPT",
"PARAMETER_PROMPT",
"HANDLER_PROMPT"
],
"x-enumDescriptions": [
"",
"",
"",
""
]
},
"text": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3ResponseMessageText"
},
"channel": {
"type": "string"
},
"payload": {
"type": "object",
"additionalProperties": {
"description": "Properties of the object."
}
},
"telephonyTransferCall": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall"
},
"mixedAudio": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3ResponseMessageMixedAudio"
},
"playAudio": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3ResponseMessagePlayAudio"
},
"conversationSuccess": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess"
},
"knowledgeInfoCard": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3ResponseMessageKnowledgeInfoCard"
},
"liveAgentHandoff": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff"
}
}
},
"GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess": {
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": {
"description": "Properties of the object."
}
}
}
},
"GoogleCloudDialogflowCxV3ResponseMessageEndInteraction": {
"type": "object"
},
"GoogleCloudDialogflowCxV3ResponseMessageKnowledgeInfoCard": {
"type": "object"
},
"GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff": {
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": {
"description": "Properties of the object."
}
}
}
},
"GoogleCloudDialogflowCxV3ResponseMessageMixedAudio": {
"type": "object",
"properties": {
"segments": {
"type": "array",
"items": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment"
}
}
}
},
"GoogleCloudDialogflowCxV3ResponseMessageMixedAudioSegment": {
"type": "object",
"properties": {
"audio": {
"type": "string",
"format": "byte"
},
"allowPlaybackInterruption": {
"type": "boolean",
"readOnly": true
},
"uri": {
"type": "string"
}
}
},
"GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText": {
"type": "object",
"properties": {
"allowPlaybackInterruption": {
"type": "boolean",
"readOnly": true
},
"ssml": {
"type": "string"
},
"text": {
"type": "string"
}
}
},
"GoogleCloudDialogflowCxV3ResponseMessagePlayAudio": {
"type": "object",
"properties": {
"allowPlaybackInterruption": {
"type": "boolean",
"readOnly": true
},
"audioUri": {
"type": "string"
}
}
},
"GoogleCloudDialogflowCxV3ResponseMessageTelephonyTransferCall": {
"type": "object",
"properties": {
"phoneNumber": {
"type": "string"
}
}
},
"GoogleCloudDialogflowCxV3ResponseMessageText": {
"type": "object",
"properties": {
"allowPlaybackInterruption": {
"type": "boolean",
"readOnly": true
},
"text": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"GoogleCloudDialogflowCxV3ToolCall": {
"type": "object",
"properties": {
"inputParameters": {
"type": "object",
"additionalProperties": {
"description": "Properties of the object."
}
},
"action": {
"type": "string"
},
"tool": {
"type": "string"
}
}
},
"GoogleCloudDialogflowCxV3TypeSchema": {
"type": "object",
"properties": {
"inlineSchema": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3InlineSchema"
},
"schemaReference": {
"$ref": "#/$defs/GoogleCloudDialogflowCxV3TypeSchemaSchemaReference"
}
}
},
"GoogleCloudDialogflowCxV3TypeSchemaSchemaReference": {
"type": "object",
"properties": {
"schema": {
"type": "string"
},
"tool": {
"type": "string"
}
}
}
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/google-dialogflow-google-cloud-dialogflow-cx-v3-playbook"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.