Google Docs Documents API
Operations on Google Docs documents
Google Docs Documents API is published by Google Docs on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 124 JSON Schema definitions.
Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, authentication docs, a getting-started guide, pricing, and 124 JSON Schemas.
This API exposes 3 operations across 3 paths, and defines 123 schemas. It is described by OpenAPI 3.1.0, at version v1.
Requests are made against a single base URL, https://docs.googleapis.com.
3 operations
3 paths
123 schemas
1 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Google Docs Documents API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 5 scopes.
By default, every request must be authenticated.
oauth2— OAuth 2.0 authentication for Google APIs.
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Documents 3
Operations on Google Docs documents
POST
/v1/documents
Google Docs Create a Document
GET
/v1/documents/{documentId}
Google Docs Get a Document
POST
/v1/documents/{documentId}:batchUpdate
Google Docs Batch Update a Document
Schemas 123
The contract defines 123 schemas that model the data the API accepts and returns. The most detailed are Request (33 properties), ParagraphStyle (22 properties), SectionStyle (19 properties), DocumentStyle (19 properties). Each schema is shown below with its type and property counts.
Request
object
A single update to apply to a document. Exactly one field must be set.
33 properties
List
object
A List represents the list attributes for a group of paragraphs that all belong to the same list.
4 properties
PositionedObjectPositioning
object
The positioning of a PositionedObject.
3 properties
DeleteNamedRangeRequest
object
Deletes a NamedRange.
3 properties
ParagraphElement
object
A ParagraphElement describes content within a paragraph.
12 properties
ReplaceAllTextResponse
object
The result of replacing text.
1 property
SectionStyle
object
The style of a section, influencing the layout of the section's content.
19 properties
RichLink
object
A link to a Google resource such as a file in Drive, a YouTube video, or a Calendar event.
6 properties
TableCellBorder
object
A border around a table cell.
3 properties
TableOfContents
object
A StructuralElement representing a table of contents.
3 properties
SectionColumnProperties
object
Properties that apply to a section's column.
2 properties
CreateFootnoteRequest
object
Creates a Footnote segment and inserts a new FootnoteReference.
2 properties
DeleteTableRowRequest
object
Deletes a row from a table.
1 property
1 required
InsertPageBreakRequest
object
Inserts a page break at the given location.
2 properties
Header
object
A document header.
2 properties
Location
object
A particular location in the document.
3 properties
CreateNamedRangeRequest
object
Creates a NamedRange referencing the given range.
2 properties
2 required
WriteControl
object
Provides control over how write requests are executed. When set on a request, it provides a way to detect conflicts.
2 properties
TableColumnProperties
object
The properties of a column in a table.
2 properties
NamedRanges
object
A collection of all the NamedRanges in the document that share a given name.
2 properties
UpdateSectionStyleRequest
object
Updates the SectionStyle.
3 properties
3 required
TableCellLocation
object
Location of a single cell within a table.
3 properties
PageBreak
object
A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page.
4 properties
InsertInlineImageRequest
object
Inserts an InlineObject containing an image at the given location.
4 properties
1 required
StructuralElement
object
A StructuralElement describes content that provides structure to the document.
6 properties
InsertSectionBreakRequest
object
Inserts a section break at the given location.
3 properties
DocumentTab
object
The content of a tab in a document, containing the body and associated document-level properties.
10 properties
TableRange
object
A table range represents a reference to a subset of a table.
3 properties
NamedStyle
object
A named style that can be applied to paragraphs.
3 properties
SheetsChartReference
object
A reference to a linked chart embedded from Google Sheets.
2 properties
CreateNamedRangeResponse
object
The result of creating a named range.
1 property
InsertTableRequest
object
Inserts a table at the specified location.
4 properties
2 required
UpdateTableColumnPropertiesRequest
object
Updates the properties of columns in a table.
4 properties
4 required
UnmergeTableCellsRequest
object
Unmerges cells in a table.
1 property
1 required
WeightedFontFamily
object
Represents a font family and weight of text.
2 properties
TabStop
object
A tab stop within a paragraph.
2 properties
InlineObject
object
An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image.
5 properties
FootnoteReference
object
A ParagraphElement representing a footnote reference.
6 properties
Size
object
A width and height.
2 properties
ListProperties
object
The properties of a list which describe the look and feel of bullets.
1 property
CropProperties
object
The crop properties of an image.
5 properties
RgbColor
object
An RGB color.
3 properties
PinTableHeaderRowsRequest
object
Updates the number of pinned table header rows in a table.
2 properties
2 required
SectionBreak
object
A StructuralElement representing a section break. A section is a range of content that has the same section style.
3 properties
NamedStyles
object
The named styles defined in the document. Paragraphs in the document can inherit their text and paragraph styles from these named styles.
1 property
CreateHeaderRequest
object
Creates a Header.
2 properties
1 required
CreateFootnoteResponse
object
The result of creating a footnote.
1 property
NamedRange
object
A collection of Ranges that have the same named range ID.
3 properties
Range
object
Specifies a contiguous range of text.
4 properties
UpdateTableRowStyleRequest
object
Updates the style of a table row.
4 properties
4 required
DocumentStyle
object
The style of the document, influencing the look of the document and any defaults for new content.
19 properties
PositionedObjectProperties
object
Properties of a PositionedObject.
2 properties
DeleteFooterRequest
object
Deletes a Footer from the document.
2 properties
1 required
TableRow
object
The contents and style of a row in a table.
7 properties
TabsCriteria
object
A criteria that specifies in which tabs a request executes.
1 property
ReplaceAllTextRequest
object
Replaces all instances of text matching a criteria with replace text.
3 properties
2 required
CreateHeaderResponse
object
The result of creating a header.
1 property
TableRowStyle
object
Style properties for a table row.
3 properties
UpdateParagraphStyleRequest
object
Updates the styling of paragraphs in the document.
3 properties
3 required
TextRun
object
A ParagraphElement that represents a run of text that all has the same styling.
5 properties
Footnote
object
A document footnote.
2 properties
Dimension
object
A magnitude in a single direction in the specified units.
2 properties
Bullet
object
Describes the bullet of a paragraph.
3 properties
Link
object
A reference to another portion of a document or an external URL.
4 properties
DeleteContentRangeRequest
object
Deletes content from the document.
1 property
1 required
Tab
object
A tab within a document. Tabs can contain content and can be nested with child tabs.
3 properties
Shading
object
The shading of a paragraph.
1 property
SubstringMatchCriteria
object
A criteria that matches a specific string of text in the document.
2 properties
1 required
CreateParagraphBulletsRequest
object
Creates bullets for all of the paragraphs that overlap with the given range.
2 properties
2 required
CreateDocumentRequest
object
Request body for creating a new document. Only the title is used.
1 property
1 required
CreateFooterResponse
object
The result of creating a footer.
1 property
ImageProperties
object
The properties of an image.
7 properties
DeletePositionedObjectRequest
object
Deletes a PositionedObject from the document.
2 properties
1 required
PositionedObject
object
An object that is tethered to a paragraph and positioned relative to the beginning of the paragraph.
5 properties
Document
object
A Google Docs document. The Document resource represents the full content and metadata of a document.
17 properties
OptionalColor
object
A color that can either be fully opaque or fully transparent.
1 property
MergeTableCellsRequest
object
Merges cells in a table.
1 property
1 required
TableStyle
object
Style properties for a table.
1 property
UpdateDocumentStyleRequest
object
Updates the DocumentStyle.
3 properties
2 required
TableCell
object
The contents and style of a cell in a table.
7 properties
InlineObjectElement
object
A ParagraphElement that contains an InlineObject.
5 properties
InsertInlineSheetsChartResponse
object
The result of inserting an inline Sheets chart.
1 property
Background
object
Represents the background of a document.
1 property
InsertTableColumnRequest
object
Inserts an empty column into a table.
2 properties
2 required
BatchUpdateDocumentResponse
object
Response message for BatchUpdateDocument.
3 properties
Body
object
The document body. The body typically contains the full content of the document.
1 property
ParagraphStyle
object
Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields.
22 properties
AutoText
object
A ParagraphElement representing a spot in the text that is dynamically replaced with content that can change over time, like a page number.
5 properties
ReplaceImageRequest
object
Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image in order to mirror the behavior of the Docs…
4 properties
2 required
Error
object
Error response from the Google Docs API.
1 property
UpdateTextStyleRequest
object
Updates the styling of text in the document.
3 properties
3 required
InsertTableRowRequest
object
Inserts an empty row into a table.
2 properties
2 required
TextStyle
object
Represents the styling that can be applied to text. Inherited text styles are represented as unset fields. A text style's parent depends on where the text styl…
11 properties
RichLinkProperties
object
Properties specific to a RichLink.
3 properties
InsertTextRequest
object
Inserts text at the given location.
3 properties
1 required
InlineObjectProperties
object
Properties of an InlineObject.
1 property
DeleteHeaderRequest
object
Deletes a Header from the document.
2 properties
1 required
DeleteTableColumnRequest
object
Deletes a column from a table.
1 property
1 required
Person
object
A person or email address mentioned in a document.
6 properties
ColumnBreak
object
A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column.
4 properties
TableCellStyle
object
The style of a table cell.
12 properties
DeleteParagraphBulletsRequest
object
Deletes bullets from all of the paragraphs that overlap with the given range.
1 property
1 required
NestingLevel
object
Contains properties describing the look and feel of a list bullet at a given level of nesting.
8 properties
SuggestionsViewMode
string
The suggestions view mode applied to the document, determining how changes from suggestions are represented.
EmbeddedObject
object
An embedded object such as an image.
11 properties
EndOfSegmentLocation
object
Location at the end of a body, header, footer, or footnote.
2 properties
Response
object
A single response from an update. The result of applying each request in a batch update.
7 properties
TabProperties
object
Properties of a tab.
4 properties
UpdateTableCellStyleRequest
object
Updates the style of a range of table cells.
4 properties
2 required
InsertInlineImageResponse
object
The result of inserting an inline image.
1 property
Footer
object
A document footer.
2 properties
Color
object
A solid color.
1 property
Equation
object
A ParagraphElement representing an equation.
2 properties
Paragraph
object
A StructuralElement representing a paragraph. A paragraph is a range of content that is terminated with a newline character.
6 properties
LinkedContentReference
object
A reference to the external linked source content.
1 property
EmbeddedObjectBorder
object
A border around an EmbeddedObject.
4 properties
ParagraphBorder
object
A border around a paragraph.
4 properties
CreateFooterRequest
object
Creates a Footer.
2 properties
1 required
PersonProperties
object
Properties specific to a linked person.
2 properties
HorizontalRule
object
A ParagraphElement representing a horizontal line.
4 properties
Table
object
A StructuralElement representing a table.
6 properties
BatchUpdateDocumentRequest
object
Request message for BatchUpdateDocument.
2 properties
1 required
ReplaceNamedRangeContentRequest
object
Replaces the content of the specified NamedRange.
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Documents
Where this information came from
This is an independent, third-party profile of Google Docs Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.