Get document with the Google Docs API

Gets a document with its title, revisionId and content. The text is in body.content: each paragraph has elements whose textRun.content holds the text, with the startIndex and endIndex that Update document uses as positions, counted in UTF-16 code units.

Identifier
google_docs_get_document

The request

POST https://connect.reportei.com/api/tools/google_docs_get_document/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "documentId": "<documentId>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
documentIdstringYesDocument id: the part of the URL of the document between /d/ and /edit, or the documentId from Create document.
includeTabsContentbooleanNotrue returns every tab of the document in tabs, each with its tabId and content. false, the default, returns only the first tab, in body.
suggestionsViewModestringNoHow pending suggestions show: inline, as if accepted, or as if rejected. Edits must be based on the document read with SUGGESTIONS_INLINE.Values: DEFAULT_FOR_CURRENT_ACCESS, SUGGESTIONS_INLINE, PREVIEW_SUGGESTIONS_ACCEPTED, PREVIEW_WITHOUT_SUGGESTIONS
fieldsstringNoFields to return, such as documentId,title,revisionId,body to leave out styles and lists.

Supported connections

Your customer connects their Google Docs account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/google_docs, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/google_docs_get_document. It becomes your agent's tool definition with no conversion.

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.