Method: projects.locations.files.asyncBatchAnnotate

Run asynchronous image detection and annotation for a list of generic files, such as PDF files, which may contain multiple pages and multiple images per page. Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains OperationMetadata (metadata). Operation.response contains AsyncBatchAnnotateFilesResponse (results).

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Optional. Target project and location to make a call.

Format: projects/{project-id}/locations/{location-id}.

If no parent is specified, a region will be chosen automatically.

Supported location-ids: us: USA country only, asia: East asia areas, like Japan, Taiwan, eu: The European Union.

Example: projects/project-A/locations/eu.

Request body

The request body contains data with the following structure:

JSON representation
  "requests": [
      object (AsyncAnnotateFileRequest)

object (AsyncAnnotateFileRequest)

Required. Individual async file annotation requests for this batch.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.