Google

Google Docs API

Reads and writes Google Docs documents.

Productivity & workspace#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Reads and writes Google Docs documents.

Endpoints 3

documents

  • POSTApplies one or more updates to the document/v1/documents/:documentId:batchUpdateApplies one or more updates to the document. Each request is validated before being applied. If any request is not valid, then the entire request will fail…
  • POSTCreates a blank document using the title given in the request/v1/documentsCreates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored. Returns the created…
  • GETGets the latest version of the specified document./v1/documents/:documentId?commentsViewMode=COMMENTS_VIEW_MODE_UNSPECIFIED&includeTabsContent=true&suggestionsViewMode=DEFAULT_FOR_CURRENT_ACCESSGets the latest version of the specified document.

API details

Base URL
https://docs.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 5 scopes
An API key in the key query parameter
Operations
3 operations on 3 pathsPOST 2GET 1
Main resources
documents 3
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Google Docs API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Google Docs API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 5 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Applies one or more updates to the document” (POST /v1/documents/:documentId:batchUpdate), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Google Docs API?

Reads and writes Google Docs documents. It is listed under Productivity & workspace and has 3 endpoints.

Who publishes the Google Docs API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Google Docs API?

Requests go to https://docs.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Google Docs API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 5 scopes; an API key in the key query parameter.

How many endpoints does the Google Docs API have?

3 operations on 3 paths (2 POST, 1 GET). The largest groups are documents.

Is forking the Google Docs API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.