Actions API
Stay organized with collections
Save and categorize content based on your preferences.
A RESTful service for the Actions API.
Service: actions.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
https://actions.googleapis.com
REST Resource: v2
| Methods |
decryptSecret |
POST /v2:decryptSecret
Decrypts the OAuth client secret used in account linking flows. |
encryptSecret |
POST /v2:encryptSecret
Encrypts the OAuth client secret used in account linking flows. |
setWebAndAppActivityControl |
POST /v2:setWebAndAppActivityControl
Sets the Web & App Activity control on a service account. |
| Methods |
matchIntents |
POST /v2/{project=projects/*}:matchIntents
Finds the intents that match a given query. |
sendInteraction |
POST /v2/{project=projects/*}:sendInteraction
Plays one round of the conversation. |
| Methods |
read |
POST /v2/{name=projects/*/draft}:read
Reads the entire content of the project draft. |
write |
POST /v2/{parent=projects/*}/draft:write
Updates the project draft based on the model. |
| Methods |
write |
POST /v2/{parent=projects/*}/preview:write
Updates the user's project preview based on the model. |
| Methods |
list |
GET /v2/{parent=projects/*}/releaseChannels
Lists all release channels and corresponding versions, if any. |
| Methods |
create |
POST /v2/{parent=projects/*}/versions:create
Creates a project version based on the model and triggers deployment to the specified release channel, if specified. |
list |
GET /v2/{parent=projects/*}/versions
Lists all versions and their current states. |
read |
POST /v2/{name=projects/*/versions/*}:read
Reads the entire content of a project version. |
| Methods |
list |
GET /v2/sampleProjects
Lists all the sample projects supported by the gactions CLI. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eThis is a RESTful API service for Google Actions, allowing developers to build and manage conversational experiences.\u003c/p\u003e\n"],["\u003cp\u003eIt provides access to various resources for tasks like intent matching, conversation interactions, project draft management, and version control.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can leverage Google-provided client libraries or utilize the provided discovery document and service endpoint for custom integrations.\u003c/p\u003e\n"],["\u003cp\u003eThe service offers functionalities for encrypting/decrypting secrets, managing web and app activity control, and working with sample projects.\u003c/p\u003e\n"],["\u003cp\u003eAll API requests are relative to the service endpoint: \u003ccode\u003ehttps://actions.googleapis.com\u003c/code\u003e.\u003c/p\u003e\n"]]],["The Actions API offers a RESTful service with resources for managing projects, drafts, previews, release channels, and versions. Key actions include: decrypting/encrypting OAuth secrets, managing web and app activity controls, matching intents to queries, and simulating conversations. Project drafts can be read and updated. Project previews can be updated. Release channels and project versions can be listed, and project versions can be created and read. The service also provides a list of available sample projects.\n"],null,["# Actions API\n\nA RESTful service for the Actions API.\n\n- [REST Resource: v2](#v2)\n- [REST Resource: v2.projects](#v2.projects)\n- [REST Resource: v2.projects.draft](#v2.projects.draft)\n- [REST Resource: v2.projects.preview](#v2.projects.preview)\n- [REST Resource: v2.projects.releaseChannels](#v2.projects.releaseChannels)\n- [REST Resource: v2.projects.versions](#v2.projects.versions)\n- [REST Resource: v2.sampleProjects](#v2.sampleProjects)\n\nService: actions.googleapis.com\n-------------------------------\n\nTo call this service, we recommend that you use the Google-provided [client libraries](https://cloud.google.com/apis/docs/client-libraries-explained). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:\n\n- \u003chttps://actions.googleapis.com/$discovery/rest?version=v2\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_service_endpoint) is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:\n\n- `https://actions.googleapis.com`\n\nREST Resource: [v2](/assistant/actions/api/reference/rest/v2/TopLevel)\n----------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|\n| [decryptSecret](/assistant/actions/api/reference/rest/v2/TopLevel/decryptSecret) | `POST /v2:decryptSecret` Decrypts the OAuth client secret used in account linking flows. |\n| [encryptSecret](/assistant/actions/api/reference/rest/v2/TopLevel/encryptSecret) | `POST /v2:encryptSecret` Encrypts the OAuth client secret used in account linking flows. |\n| [setWebAndAppActivityControl](/assistant/actions/api/reference/rest/v2/TopLevel/setWebAndAppActivityControl) | `POST /v2:setWebAndAppActivityControl` Sets the Web \\& App Activity control on a service account. |\n\nREST Resource: [v2.projects](/assistant/actions/api/reference/rest/v2/projects)\n-------------------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|\n| [matchIntents](/assistant/actions/api/reference/rest/v2/projects/matchIntents) | `POST /v2/{project=projects/*}:matchIntents` Finds the intents that match a given query. |\n| [sendInteraction](/assistant/actions/api/reference/rest/v2/projects/sendInteraction) | `POST /v2/{project=projects/*}:sendInteraction` Plays one round of the conversation. |\n\nREST Resource: [v2.projects.draft](/assistant/actions/api/reference/rest/v2/projects.draft)\n-------------------------------------------------------------------------------------------\n\n| Methods ||\n|------------------------------------------------------------------------|------------------------------------------------------------------------------------------|\n| [read](/assistant/actions/api/reference/rest/v2/projects.draft/read) | `POST /v2/{name=projects/*/draft}:read` Reads the entire content of the project draft. |\n| [write](/assistant/actions/api/reference/rest/v2/projects.draft/write) | `POST /v2/{parent=projects/*}/draft:write` Updates the project draft based on the model. |\n\nREST Resource: [v2.projects.preview](/assistant/actions/api/reference/rest/v2/projects.preview)\n-----------------------------------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|\n| [write](/assistant/actions/api/reference/rest/v2/projects.preview/write) | `POST /v2/{parent=projects/*}/preview:write` Updates the user's project preview based on the model. |\n\nREST Resource: [v2.projects.releaseChannels](/assistant/actions/api/reference/rest/v2/projects.releaseChannels)\n---------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|\n| [list](/assistant/actions/api/reference/rest/v2/projects.releaseChannels/list) | `GET /v2/{parent=projects/*}/releaseChannels` Lists all release channels and corresponding versions, if any. |\n\nREST Resource: [v2.projects.versions](/assistant/actions/api/reference/rest/v2/projects.versions)\n-------------------------------------------------------------------------------------------------\n\n| Methods ||\n|-----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [create](/assistant/actions/api/reference/rest/v2/projects.versions/create) | `POST /v2/{parent=projects/*}/versions:create` Creates a project version based on the model and triggers deployment to the specified release channel, if specified. |\n| [list](/assistant/actions/api/reference/rest/v2/projects.versions/list) | `GET /v2/{parent=projects/*}/versions` Lists all versions and their current states. |\n| [read](/assistant/actions/api/reference/rest/v2/projects.versions/read) | `POST /v2/{name=projects/*/versions/*}:read` Reads the entire content of a project version. |\n\nREST Resource: [v2.sampleProjects](/assistant/actions/api/reference/rest/v2/sampleProjects)\n-------------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------|---------------------------------------------------------------------------------------|\n| [list](/assistant/actions/api/reference/rest/v2/sampleProjects/list) | `GET /v2/sampleProjects` Lists all the sample projects supported by the gactions CLI. |"]]
