Deep Review API (deepreview:v1)

2026-10-20

12 new methods | New API

Additions

    Methods
  • ▼ ▲ deepreview.documents.reviews.list

      Parameter Order : parent

      Description : Lists all review execution runs for a document.

      Path : v1/{+parent}/reviews

      Flat Path : v1/documents/{documentsId}/reviews

      Scopes : https://www.googleapis.com/auth/drive.file

      HTTP Method : GET

      Parameters :

        pageToken

          Type : string

          Description : Optional. A page token received from a previous `ListReviews` call.

          Location : query

        orderBy

          Type : string

          Location : query

          Description : Optional. Supported AIP-132 order_by field.

        pageSize

          Location : query

          Format : int32

          Description : Optional. The maximum number of reviews to return in a single page. The server may return fewer than this value. If unspecified, at most 50 reviews will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Type : integer

        parent

          Description : Required. The parent Document resource name. Format: `documents/{document}`

          Type : string

          Pattern : ^documents/[^/]+$

          Location : path

          Required : Yes

        filter

          Description : Optional. Supported AIP-160 filter expressions.

          Location : query

          Type : string

  • ▼ ▲ deepreview.documents.reviews.get

      Scopes : https://www.googleapis.com/auth/drive.file

      Parameter Order : name

      Description : Retrieves a specific review execution result.

      Path : v1/{+name}

      HTTP Method : GET

      Parameters :

        name

          Pattern : ^documents/[^/]+/reviews/[^/]+$

          Type : string

          Location : path

          Required : Yes

          Description : Required. The resource name of the review to retrieve. Format: `documents/{document}/reviews/{review}`

      Flat Path : v1/documents/{documentsId}/reviews/{reviewsId}

  • ▼ ▲ deepreview.documents.reviews.create

      Path : v1/{+parent}/reviews

      Flat Path : v1/documents/{documentsId}/reviews

      Description : Creates and initiates an asynchronous multi-agent review for a document.

      HTTP Method : POST

      Parameters :

        reviewId

          Location : query

          Description : Optional. The ID to use for the review, which will become the final component of the review's resource name. If not provided, a unique server-generated UUID will be assigned.

          Type : string

        requestId

          Description : Optional. Idempotency identifier for network retry safety (AIP-155). Must be a valid UUID4 string.

          Location : query

          Type : string

        parent

          Description : Required. The parent Document resource name where this review will be created. Format: `documents/{document}`

          Location : path

          Required : Yes

          Type : string

          Pattern : ^documents/[^/]+$

      Scopes : https://www.googleapis.com/auth/drive.file

      Parameter Order : parent

  • ▼ ▲ deepreview.documents.delete

      Path : v1/{+name}

      Parameter Order : name

      Flat Path : v1/documents/{documentsId}

      HTTP Method : DELETE

      Parameters :

        allowMissing

          Description : Optional. If set to true, and the document is not found, the request succeeds.

          Type : boolean

          Location : query

        force

          Description : Optional. If set to true, any child resources (e.g. review resources) are also deleted.

          Location : query

          Type : boolean

        name

          Type : string

          Description : Required. The resource name of the document to delete. Format: `documents/{document}`

          Pattern : ^documents/[^/]+$

          Location : path

          Required : Yes

      Scopes : https://www.googleapis.com/auth/drive.file

      Description : Deletes a document and all associated reviews and stored blobs.

  • ▼ ▲ deepreview.documents.get

      Description : Retrieves document metadata and review history.

      Flat Path : v1/documents/{documentsId}

      Parameter Order : name

      Path : v1/{+name}

      Scopes : https://www.googleapis.com/auth/drive.file

      HTTP Method : GET

      Parameters :

        name

          Location : path

          Required : Yes

          Pattern : ^documents/[^/]+$

          Type : string

          Description : Required. The resource name of the document to retrieve. Format: `documents/{document}`

  • ▼ ▲ deepreview.documents.list

      HTTP Method : GET

      Parameters :

        filter

          Location : query

          Description : Optional. Supported AIP-160 filter expressions (e.g., `display_name = "..."`).

          Type : string

        orderBy

          Description : Optional. Supported AIP-132 order_by field.

          Location : query

          Type : string

        pageToken

          Description : Optional. A page token received from a previous `ListDocuments` call.

          Location : query

          Type : string

        pageSize

          Description : Optional. The maximum number of documents to return in a single page. The server may return fewer than this value. If unspecified, at most 50 documents will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

          Location : query

          Format : int32

          Type : integer

      Flat Path : v1/documents

      Path : v1/documents

      Description : Lists documents for the authenticated caller with cursor pagination.

      Scopes : https://www.googleapis.com/auth/drive.file

  • ▼ ▲ deepreview.media.download

      HTTP Method : GET

      Parameters :

        name

          Pattern : ^documents/[^/]+$

          Type : string

          Description : Required. The resource name of the document to download. Format: `documents/{document}`

          Location : path

          Required : Yes

      Description : Downloads the original document content (PDF binary) via Scotty media streaming (AIP-136 custom method).

      Path : v1/{+name}:download

      Scopes : https://www.googleapis.com/auth/drive.file

      Flat Path : v1/documents/{documentsId}:download

      Supportsmediadownload : Yes

      Usemediadownloadservice : Yes

      Parameter Order : name

  • ▼ ▲ deepreview.media.upload

      HTTP Method : POST

      Parameters :

        requestId

          Type : string

          Description : Optional. Idempotency identifier for network retry safety (AIP-155). Must be a valid UUID4 string.

          Location : query

        documentId

          Description : Optional. The ID to use for the document, which will become the final component of the document's resource name. If not provided, a unique server-generated UUID will be assigned.

          Location : query

          Type : string

      Flat Path : v1/documents

      Description : Creates a new Document resource and ingests the manuscript via Scotty or Google Drive.

      Scopes : https://www.googleapis.com/auth/drive.file

      Supportsmediaupload : Yes

      Mediaupload :

        Accept : */*

        Protocols :

          Resumable :

            Multipart : Yes

            Path : /resumable/upload/v1/documents

          Simple :

            Path : /upload/v1/documents

            Multipart : Yes

        Maxsize : 20971520

      Path : v1/documents

  • ▼ ▲ deepreview.operations.documents.reviews.get

      Path : v1/{+name}

      Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

      Scopes : https://www.googleapis.com/auth/drive.file

      Flat Path : v1/operations/documents/{documentsId}/reviews/{reviewsId}

      Parameter Order : name

      HTTP Method : GET

      Parameters :

        name

          Type : string

          Location : path

          Required : Yes

          Description : The name of the operation resource.

          Pattern : ^operations/documents/[^/]+/reviews/[^/]+$

  • ▼ ▲ deepreview.operations.list

      Path : v1/{+name}

      Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

      HTTP Method : GET

      Parameters :

        pageSize

          Type : integer

          Description : The standard list page size.

          Location : query

          Format : int32

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

        filter

          Location : query

          Type : string

          Description : The standard list filter.

        name

          Location : path

          Required : Yes

          Pattern : ^operations$

          Description : The name of the operation's parent resource.

          Type : string

        returnPartialSuccess

          Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

          Type : boolean

          Location : query

      Flat Path : v1/operations

      Scopes : https://www.googleapis.com/auth/drive.file

      Parameter Order : name

  • ▼ ▲ deepreview.operations.delete

      Scopes : https://www.googleapis.com/auth/drive.file

      Parameter Order : name

      Flat Path : v1/operations/{operationsId}

      Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

      Path : v1/{+name}

      HTTP Method : DELETE

      Parameters :

        name

          Description : The name of the operation resource to be deleted.

          Type : string

          Location : path

          Required : Yes

          Pattern : ^operations/.*$

  • ▼ ▲ deepreview.operations.cancel

      HTTP Method : POST

      Parameters :

        name

          Description : The name of the operation resource to be cancelled.

          Type : string

          Location : path

          Required : Yes

          Pattern : ^operations/.*$

      Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

      Parameter Order : name

      Path : v1/{+name}:cancel

      Scopes : https://www.googleapis.com/auth/drive.file

      Flat Path : v1/operations/{operationsId}:cancel