Method: corpora.documents.get

Gets information about a specific Document.

HTTP request

GET https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the Document to retrieve. Example: corpora/my-corpus-123/documents/the-doc-abc

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/generative-language.retriever
  • https://www.googleapis.com/auth/generative-language.retriever.readonly

For more information, see the Authentication Overview.