Long-running operations

Some methods of the Dialogflow API return a long-running operation. These methods are asynchronous, and the operation may not be completed when the method returns a response. You can check on the status of an operation.

Get an operation status

The following shows how to poll an operation's status.

REST & CMD LINE

Call the get method for the Operations type.

Before using any of the request data below, make the following replacements:

• project-id: your GCP project ID
• operation-id: your operation ID
• api-version: either v2 or v2beta1

HTTP method and URL:

GET https://dialogflow.googleapis.com/api-version/projects/my-gcp-project/operations/operation-id

To send your request, expand one of these options:

curl (Linux, macOS, or Cloud Shell)

Note: If you are not executing the command below from Cloud Shell or Compute Engine, ensure you have set the GOOGLE_APPLICATION_CREDENTIALS environment variable to your service account private key file path.

Execute the following command:

curl -X GET \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
https://dialogflow.googleapis.com/api-version/projects/my-gcp-project/operations/operation-id

PowerShell (Windows)

Note: If you are not executing the command below from Cloud Shell or Compute Engine, ensure you have set the GOOGLE_APPLICATION_CREDENTIALS environment variable to your service account private key file path.

Execute the following command:

$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
  -Method GET `
  -Headers $headers `
  -Uri "https://dialogflow.googleapis.com/api-version/projects/my-gcp-project/operations/operation-id" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{
  "name": "projects/project-id/operations/some-operation-name-operation-id",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.dialogflow.api-version.SomeOperationType",
    "state": "DONE"
  },
  "done": true,
  ...
}

When the operation has completed, a state value of SUCCESSFUL is returned.