Google Docs website screenshot

Google Docs

API for creating, reading, and editing Google Docs documents.

1 APIs 6 Features
CollaborationDocumentsGoogle WorkspaceProductivityWord Processing

APIs

Google Docs API

The Google Docs API lets you create and modify documents.

Collections

Google Docs API

OPEN

Pricing Plans

Google Docs Plans Pricing

3 plans

PLANS

Rate Limits

Google Docs Rate Limits

5 limits

RATE LIMITS

FinOps

Google Docs Finops

FINOPS

Features

Document Creation

Programmatically create new Google Docs documents with titles and initial content.

Content Manipulation

Insert, replace, and delete text, images, tables, and other content elements using batch updates.

Rich Formatting

Apply text styles, paragraph styles, named styles, headers, footers, and document-level styling.

Table Management

Create, modify, merge, and unmerge table cells with fine-grained style control.

Collaborative Editing

Work with suggestions, comments, and revision history in shared documents.

Template Automation

Use named ranges and text replacement to merge data into document templates at scale.

Use Cases

Document Generation

Generate reports, invoices, contracts, and other documents from templates with dynamic data insertion.

Mail Merge

Perform bulk document personalization by replacing placeholders with recipient-specific data.

Content Migration

Import and convert content from other formats into Google Docs for collaboration.

Workflow Automation

Automate document creation and updates as part of business workflows triggered by events.

Compliance Documentation

Generate standardized compliance reports and audit documentation from structured data.

Integrations

Google Drive

Store and organize documents in Google Drive with sharing and permission controls.

Google Sheets

Embed linked charts from Google Sheets that update automatically in documents.

Google Apps Script

Extend document functionality with custom menus, sidebars, and automation scripts.

Google Workspace Add-ons

Build add-ons that enhance the Docs editing experience with custom UI panels.

Zapier

Connect Google Docs to thousands of apps for automated document workflows.

Semantic Vocabularies

Google Docs Context

0 classes · 36 properties

JSON-LD

Google Docs V1 Context

0 classes · 0 properties

JSON-LD

API Governance Rules

Google Docs API Rules

7 rules · 7 errors

SPECTRAL

JSON Structure

Google Docs V1 Auto Text Structure

4 properties

JSON STRUCTURE

Google Docs V1 Background Structure

0 properties

JSON STRUCTURE

Google Docs V1 Batch Update Document Request Structure

1 properties

JSON STRUCTURE

Google Docs V1 Batch Update Document Response Structure

2 properties

JSON STRUCTURE

Google Docs V1 Body Structure

1 properties

JSON STRUCTURE

Google Docs V1 Bullet Structure

2 properties

JSON STRUCTURE

Google Docs V1 Color Structure

0 properties

JSON STRUCTURE

Google Docs V1 Column Break Structure

3 properties

JSON STRUCTURE

Google Docs V1 Create Document Request Structure

1 properties

JSON STRUCTURE

Google Docs V1 Create Footer Request Structure

1 properties

JSON STRUCTURE

Google Docs V1 Create Footer Response Structure

1 properties

JSON STRUCTURE

Google Docs V1 Create Footnote Request Structure

0 properties

JSON STRUCTURE

Google Docs V1 Create Footnote Response Structure

1 properties

JSON STRUCTURE

Google Docs V1 Create Header Request Structure

1 properties

JSON STRUCTURE

Google Docs V1 Create Header Response Structure

1 properties

JSON STRUCTURE

Google Docs V1 Create Named Range Request Structure

1 properties

JSON STRUCTURE

Google Docs V1 Create Named Range Response Structure

1 properties

JSON STRUCTURE

Google Docs V1 Create Paragraph Bullets Request Structure

1 properties

JSON STRUCTURE

Google Docs V1 Crop Properties Structure

5 properties

JSON STRUCTURE

Google Docs V1 Delete Content Range Request Structure

0 properties

JSON STRUCTURE

Google Docs V1 Delete Footer Request Structure

2 properties

JSON STRUCTURE

Google Docs V1 Delete Header Request Structure

2 properties

JSON STRUCTURE

Google Docs V1 Delete Named Range Request Structure

2 properties

JSON STRUCTURE

Google Docs V1 Delete Paragraph Bullets Request Structure

0 properties

JSON STRUCTURE

Google Docs V1 Delete Positioned Object Request Structure

2 properties

JSON STRUCTURE

Google Docs V1 Delete Table Column Request Structure

0 properties

JSON STRUCTURE

Google Docs V1 Delete Table Row Request Structure

0 properties

JSON STRUCTURE

Google Docs V1 Dimension Structure

2 properties

JSON STRUCTURE

Google Docs V1 Document Structure

13 properties

JSON STRUCTURE

Google Docs V1 Document Style Structure

11 properties

JSON STRUCTURE

Google Docs V1 Document Tab Structure

7 properties

JSON STRUCTURE

Google Docs V1 Embedded Object Border Structure

2 properties

JSON STRUCTURE

Google Docs V1 Embedded Object Structure

3 properties

JSON STRUCTURE

Google Docs V1 End Of Segment Location Structure

2 properties

JSON STRUCTURE

Google Docs V1 Equation Structure

2 properties

JSON STRUCTURE

Google Docs V1 Error Structure

1 properties

JSON STRUCTURE

Google Docs V1 Footer Structure

2 properties

JSON STRUCTURE

Google Docs V1 Footnote Reference Structure

5 properties

JSON STRUCTURE

Google Docs V1 Footnote Structure

2 properties

JSON STRUCTURE

Google Docs V1 Header Structure

2 properties

JSON STRUCTURE

Google Docs V1 Horizontal Rule Structure

3 properties

JSON STRUCTURE

Google Docs V1 Image Properties Structure

6 properties

JSON STRUCTURE

Google Docs V1 Inline Object Element Structure

4 properties

JSON STRUCTURE

Google Docs V1 Inline Object Properties Structure

0 properties

JSON STRUCTURE

Google Docs V1 Inline Object Structure

4 properties

JSON STRUCTURE

Google Docs V1 Insert Inline Image Request Structure

1 properties

JSON STRUCTURE

Google Docs V1 Insert Inline Image Response Structure

1 properties

JSON STRUCTURE

Google Docs V1 Insert Inline Sheets Chart Response Structure

1 properties

JSON STRUCTURE

Google Docs V1 Insert Page Break Request Structure

0 properties

JSON STRUCTURE

Google Docs V1 Insert Section Break Request Structure

1 properties

JSON STRUCTURE

Google Docs V1 Insert Table Column Request Structure

1 properties

JSON STRUCTURE

Google Docs V1 Insert Table Request Structure

2 properties

JSON STRUCTURE

Google Docs V1 Insert Table Row Request Structure

1 properties

JSON STRUCTURE

Google Docs V1 Insert Text Request Structure

1 properties

JSON STRUCTURE

Google Docs V1 Link Structure

4 properties

JSON STRUCTURE

Google Docs V1 Linked Content Reference Structure

0 properties

JSON STRUCTURE

Google Docs V1 List Properties Structure

1 properties

JSON STRUCTURE

Google Docs V1 List Structure

3 properties

JSON STRUCTURE

Google Docs V1 Location Structure

3 properties

JSON STRUCTURE

Google Docs V1 Merge Table Cells Request Structure

0 properties

JSON STRUCTURE

Google Docs V1 Named Range Structure

3 properties

JSON STRUCTURE

Google Docs V1 Named Ranges Structure

2 properties

JSON STRUCTURE

Google Docs V1 Named Style Structure

1 properties

JSON STRUCTURE

Google Docs V1 Named Styles Structure

1 properties

JSON STRUCTURE

Google Docs V1 Nesting Level Structure

5 properties

JSON STRUCTURE

Google Docs V1 Optional Color Structure

0 properties

JSON STRUCTURE

Google Docs V1 Page Break Structure

3 properties

JSON STRUCTURE

Google Docs V1 Paragraph Border Structure

1 properties

JSON STRUCTURE

Google Docs V1 Paragraph Element Structure

2 properties

JSON STRUCTURE

Google Docs V1 Paragraph Structure

4 properties

JSON STRUCTURE

Google Docs V1 Paragraph Style Structure

11 properties

JSON STRUCTURE

Google Docs V1 Person Properties Structure

2 properties

JSON STRUCTURE

Google Docs V1 Person Structure

4 properties

JSON STRUCTURE

Google Docs V1 Pin Table Header Rows Request Structure

1 properties

JSON STRUCTURE

Google Docs V1 Positioned Object Positioning Structure

1 properties

JSON STRUCTURE

Google Docs V1 Positioned Object Properties Structure

0 properties

JSON STRUCTURE

Google Docs V1 Positioned Object Structure

4 properties

JSON STRUCTURE

Google Docs V1 Range Structure

4 properties

JSON STRUCTURE

Google Docs V1 Replace All Text Request Structure

1 properties

JSON STRUCTURE

Google Docs V1 Replace All Text Response Structure

1 properties

JSON STRUCTURE

Google Docs V1 Replace Image Request Structure

4 properties

JSON STRUCTURE

Google Docs V1 Replace Named Range Content Request Structure

3 properties

JSON STRUCTURE

Google Docs V1 Request Structure

0 properties

JSON STRUCTURE

Google Docs V1 Response Structure

0 properties

JSON STRUCTURE

Google Docs V1 Rgb Color Structure

3 properties

JSON STRUCTURE

Google Docs V1 Rich Link Properties Structure

3 properties

JSON STRUCTURE

Google Docs V1 Rich Link Structure

4 properties

JSON STRUCTURE

Google Docs V1 Section Break Structure

2 properties

JSON STRUCTURE

Google Docs V1 Section Column Properties Structure

0 properties

JSON STRUCTURE

Google Docs V1 Section Style Structure

13 properties

JSON STRUCTURE

Google Docs V1 Shading Structure

0 properties

JSON STRUCTURE

Google Docs V1 Sheets Chart Reference Structure

2 properties

JSON STRUCTURE

Google Docs V1 Size Structure

0 properties

JSON STRUCTURE

Google Docs V1 Structural Element Structure

2 properties

JSON STRUCTURE

Google Docs V1 Substring Match Criteria Structure

2 properties

JSON STRUCTURE

Google Docs V1 Suggestions View Mode Structure

0 properties

JSON STRUCTURE

Google Docs V1 Tab Properties Structure

4 properties

JSON STRUCTURE

Google Docs V1 Tab Stop Structure

1 properties

JSON STRUCTURE

Google Docs V1 Tab Structure

1 properties

JSON STRUCTURE

Google Docs V1 Table Cell Border Structure

1 properties

JSON STRUCTURE

Google Docs V1 Table Cell Location Structure

2 properties

JSON STRUCTURE

Google Docs V1 Table Cell Structure

6 properties

JSON STRUCTURE

Google Docs V1 Table Cell Style Structure

3 properties

JSON STRUCTURE

Google Docs V1 Table Column Properties Structure

1 properties

JSON STRUCTURE

Google Docs V1 Table Of Contents Structure

3 properties

JSON STRUCTURE

Google Docs V1 Table Range Structure

2 properties

JSON STRUCTURE

Google Docs V1 Table Row Structure

6 properties

JSON STRUCTURE

Google Docs V1 Table Row Style Structure

2 properties

JSON STRUCTURE

Google Docs V1 Table Structure

5 properties

JSON STRUCTURE

Google Docs V1 Table Style Structure

1 properties

JSON STRUCTURE

Google Docs V1 Tabs Criteria Structure

1 properties

JSON STRUCTURE

Google Docs V1 Text Run Structure

4 properties

JSON STRUCTURE

Google Docs V1 Text Style Structure

6 properties

JSON STRUCTURE

Google Docs V1 Unmerge Table Cells Request Structure

0 properties

JSON STRUCTURE

Google Docs V1 Update Document Style Request Structure

2 properties

JSON STRUCTURE

Google Docs V1 Update Paragraph Style Request Structure

1 properties

JSON STRUCTURE

Google Docs V1 Update Section Style Request Structure

1 properties

JSON STRUCTURE

Google Docs V1 Update Table Cell Style Request Structure

1 properties

JSON STRUCTURE

Google Docs V1 Update Table Column Properties Request Structure

2 properties

JSON STRUCTURE

Google Docs V1 Update Table Row Style Request Structure

2 properties

JSON STRUCTURE

Google Docs V1 Update Text Style Request Structure

1 properties

JSON STRUCTURE

Google Docs V1 Weighted Font Family Structure

2 properties

JSON STRUCTURE

Google Docs V1 Write Control Structure

2 properties

JSON STRUCTURE

Example Payloads

Google Docs V1 Auto Text Example

4 fields

EXAMPLE

Google Docs V1 Background Example

EXAMPLE

Google Docs V1 Batch Update Document Request Example

1 fields

EXAMPLE

Google Docs V1 Batch Update Document Response Example

2 fields

EXAMPLE

Google Docs V1 Body Example

1 fields

EXAMPLE

Google Docs V1 Bullet Example

2 fields

EXAMPLE

Google Docs V1 Color Example

EXAMPLE

Google Docs V1 Column Break Example

3 fields

EXAMPLE

Google Docs V1 Create Document Request Example

1 fields

EXAMPLE

Google Docs V1 Create Footer Request Example

1 fields

EXAMPLE

Google Docs V1 Create Footer Response Example

1 fields

EXAMPLE

Google Docs V1 Create Footnote Request Example

EXAMPLE

Google Docs V1 Create Footnote Response Example

1 fields

EXAMPLE

Google Docs V1 Create Header Request Example

1 fields

EXAMPLE

Google Docs V1 Create Header Response Example

1 fields

EXAMPLE

Google Docs V1 Create Named Range Request Example

1 fields

EXAMPLE

Google Docs V1 Create Named Range Response Example

1 fields

EXAMPLE

Google Docs V1 Create Paragraph Bullets Request Example

1 fields

EXAMPLE

Google Docs V1 Crop Properties Example

5 fields

EXAMPLE

Google Docs V1 Delete Content Range Request Example

EXAMPLE

Google Docs V1 Delete Footer Request Example

2 fields

EXAMPLE

Google Docs V1 Delete Header Request Example

2 fields

EXAMPLE

Google Docs V1 Delete Named Range Request Example

2 fields

EXAMPLE

Google Docs V1 Delete Paragraph Bullets Request Example

EXAMPLE

Google Docs V1 Delete Positioned Object Request Example

2 fields

EXAMPLE

Google Docs V1 Delete Table Column Request Example

EXAMPLE

Google Docs V1 Delete Table Row Request Example

EXAMPLE

Google Docs V1 Dimension Example

2 fields

EXAMPLE

Google Docs V1 Document Example

13 fields

EXAMPLE

Google Docs V1 Document Style Example

11 fields

EXAMPLE

Google Docs V1 Document Tab Example

7 fields

EXAMPLE

Google Docs V1 Embedded Object Border Example

2 fields

EXAMPLE

Google Docs V1 Embedded Object Example

3 fields

EXAMPLE

Google Docs V1 End Of Segment Location Example

2 fields

EXAMPLE

Google Docs V1 Equation Example

2 fields

EXAMPLE

Google Docs V1 Error Example

1 fields

EXAMPLE

Google Docs V1 Footer Example

2 fields

EXAMPLE

Google Docs V1 Footnote Example

2 fields

EXAMPLE

Google Docs V1 Footnote Reference Example

5 fields

EXAMPLE

Google Docs V1 Header Example

2 fields

EXAMPLE

Google Docs V1 Horizontal Rule Example

3 fields

EXAMPLE

Google Docs V1 Image Properties Example

6 fields

EXAMPLE

Google Docs V1 Inline Object Element Example

4 fields

EXAMPLE

Google Docs V1 Inline Object Example

4 fields

EXAMPLE

Google Docs V1 Inline Object Properties Example

EXAMPLE

Google Docs V1 Insert Inline Image Request Example

1 fields

EXAMPLE

Google Docs V1 Insert Inline Image Response Example

1 fields

EXAMPLE

Google Docs V1 Insert Inline Sheets Chart Response Example

1 fields

EXAMPLE

Google Docs V1 Insert Page Break Request Example

EXAMPLE

Google Docs V1 Insert Section Break Request Example

1 fields

EXAMPLE

Google Docs V1 Insert Table Column Request Example

1 fields

EXAMPLE

Google Docs V1 Insert Table Request Example

2 fields

EXAMPLE

Google Docs V1 Insert Table Row Request Example

1 fields

EXAMPLE

Google Docs V1 Insert Text Request Example

1 fields

EXAMPLE

Google Docs V1 Link Example

4 fields

EXAMPLE

Google Docs V1 Linked Content Reference Example

EXAMPLE

Google Docs V1 List Example

3 fields

EXAMPLE

Google Docs V1 List Properties Example

1 fields

EXAMPLE

Google Docs V1 Location Example

3 fields

EXAMPLE

Google Docs V1 Merge Table Cells Request Example

EXAMPLE

Google Docs V1 Named Range Example

3 fields

EXAMPLE

Google Docs V1 Named Ranges Example

2 fields

EXAMPLE

Google Docs V1 Named Style Example

1 fields

EXAMPLE

Google Docs V1 Named Styles Example

1 fields

EXAMPLE

Google Docs V1 Nesting Level Example

5 fields

EXAMPLE

Google Docs V1 Optional Color Example

EXAMPLE

Google Docs V1 Page Break Example

3 fields

EXAMPLE

Google Docs V1 Paragraph Border Example

1 fields

EXAMPLE

Google Docs V1 Paragraph Element Example

2 fields

EXAMPLE

Google Docs V1 Paragraph Example

4 fields

EXAMPLE

Google Docs V1 Paragraph Style Example

11 fields

EXAMPLE

Google Docs V1 Person Example

4 fields

EXAMPLE

Google Docs V1 Person Properties Example

2 fields

EXAMPLE

Google Docs V1 Pin Table Header Rows Request Example

1 fields

EXAMPLE

Google Docs V1 Positioned Object Example

4 fields

EXAMPLE

Google Docs V1 Positioned Object Positioning Example

1 fields

EXAMPLE

Google Docs V1 Positioned Object Properties Example

EXAMPLE

Google Docs V1 Range Example

4 fields

EXAMPLE

Google Docs V1 Replace All Text Request Example

1 fields

EXAMPLE

Google Docs V1 Replace All Text Response Example

1 fields

EXAMPLE

Google Docs V1 Replace Image Request Example

4 fields

EXAMPLE

Google Docs V1 Replace Named Range Content Request Example

3 fields

EXAMPLE

Google Docs V1 Request Example

EXAMPLE

Google Docs V1 Response Example

EXAMPLE

Google Docs V1 Rgb Color Example

3 fields

EXAMPLE

Google Docs V1 Rich Link Example

4 fields

EXAMPLE

Google Docs V1 Rich Link Properties Example

3 fields

EXAMPLE

Google Docs V1 Section Break Example

2 fields

EXAMPLE

Google Docs V1 Section Column Properties Example

EXAMPLE

Google Docs V1 Section Style Example

13 fields

EXAMPLE

Google Docs V1 Shading Example

EXAMPLE

Google Docs V1 Sheets Chart Reference Example

2 fields

EXAMPLE

Google Docs V1 Size Example

EXAMPLE

Google Docs V1 Structural Element Example

2 fields

EXAMPLE

Google Docs V1 Substring Match Criteria Example

2 fields

EXAMPLE

Google Docs V1 Suggestions View Mode Example

EXAMPLE

Google Docs V1 Tab Example

1 fields

EXAMPLE

Google Docs V1 Tab Properties Example

4 fields

EXAMPLE

Google Docs V1 Tab Stop Example

1 fields

EXAMPLE

Google Docs V1 Table Cell Border Example

1 fields

EXAMPLE

Google Docs V1 Table Cell Example

6 fields

EXAMPLE

Google Docs V1 Table Cell Location Example

2 fields

EXAMPLE

Google Docs V1 Table Cell Style Example

3 fields

EXAMPLE

Google Docs V1 Table Column Properties Example

1 fields

EXAMPLE

Google Docs V1 Table Example

5 fields

EXAMPLE

Google Docs V1 Table Of Contents Example

3 fields

EXAMPLE

Google Docs V1 Table Range Example

2 fields

EXAMPLE

Google Docs V1 Table Row Example

6 fields

EXAMPLE

Google Docs V1 Table Row Style Example

2 fields

EXAMPLE

Google Docs V1 Table Style Example

1 fields

EXAMPLE

Google Docs V1 Tabs Criteria Example

1 fields

EXAMPLE

Google Docs V1 Text Run Example

4 fields

EXAMPLE

Google Docs V1 Text Style Example

6 fields

EXAMPLE

Google Docs V1 Unmerge Table Cells Request Example

EXAMPLE

Google Docs V1 Update Document Style Request Example

2 fields

EXAMPLE

Google Docs V1 Update Paragraph Style Request Example

1 fields

EXAMPLE

Google Docs V1 Update Section Style Request Example

1 fields

EXAMPLE

Google Docs V1 Update Table Cell Style Request Example

1 fields

EXAMPLE

Google Docs V1 Update Table Column Properties Request Example

2 fields

EXAMPLE

Google Docs V1 Update Table Row Style Request Example

2 fields

EXAMPLE

Google Docs V1 Update Text Style Request Example

1 fields

EXAMPLE

Google Docs V1 Weighted Font Family Example

2 fields

EXAMPLE

Google Docs V1 Write Control Example

2 fields

EXAMPLE

Resources

🌐
Portal
Portal
🚀
GettingStarted
GettingStarted
🔑
Authentication
Authentication
📰
Blog
Blog
📜
TermsOfService
TermsOfService
📜
PrivacyPolicy
PrivacyPolicy
🟢
StatusPage
StatusPage
👥
GitHubOrganization
GitHubOrganization
🔗
SpectralRules
SpectralRules
🔗
Vocabulary
Vocabulary

Sources

Raw ↑ 
opencollection: 1.0.0
info:
  name: Google Docs API
  version: v1
request:
  auth:
    type: oauth2
    flow: authorization_code
    authorizationUrl: https://accounts.google.com/o/oauth2/auth
    accessTokenUrl: https://oauth2.googleapis.com/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: Documents
    type: folder
  items:
  - info:
      name: Google Docs Create a Document
      type: http
    http:
      method: POST
      url: https://docs.googleapis.com/v1/documents
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://accounts.google.com/o/oauth2/auth
        accessTokenUrl: https://oauth2.googleapis.com/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Creates a blank document using the title given in the request. Other fields in the request, including any provided
      content, are ignored.
  - info:
      name: Google Docs Get a Document
      type: http
    http:
      method: GET
      url: https://docs.googleapis.com/v1/documents/:documentId
      params:
      - name: documentId
        value: '500123'
        type: path
        description: The ID of the document to retrieve.
      - name: suggestionsViewMode
        value: example_value
        type: query
        description: The suggestions view mode to apply to the document. This allows viewing the document with all suggestions
          inline, collapsed, or only previewing suggestions accepted or rejected. If not specified, defaults to DEFAULT_FOR_CURRENT_ACCESS.
      - name: includeTabsContent
        value: 'true'
        type: query
        description: Whether to populate the Document.tabs field instead of the text content fields like body, documentStyle,
          headers, etc. When true, content is returned in Document.tabs. When false, content from the first tab populates
          the legacy content fields.
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://accounts.google.com/o/oauth2/auth
        accessTokenUrl: https://oauth2.googleapis.com/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Gets the latest version of the specified document. Returns the full document resource including content, styling,
      and metadata.
  - info:
      name: Google Docs Batch Update a Document
      type: http
    http:
      method: POST
      url: https://docs.googleapis.com/v1/documents/:documentId:batchUpdate
      params:
      - name: documentId
        value: '500123'
        type: path
        description: The ID of the document to update.
      body:
        type: json
        data: '{}'
      auth:
        type: oauth2
        flow: authorization_code
        authorizationUrl: https://accounts.google.com/o/oauth2/auth
        accessTokenUrl: https://oauth2.googleapis.com/token
        credentials:
          clientId: '{{clientId}}'
          clientSecret: '{{clientSecret}}'
    docs: Applies one or more updates to the document. Each request is validated before being applied. If any request is not
      valid, the entire request will fail and nothing will be applied. Some requests have replies to give you some information
      about how they are applied. Other requests do not need to return information; these each return an empty reply. The
      order of replies matches the order of requests.
bundled: true