API - Corsair

Every googledocs.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Documents

copyDocument

documents.copyDocument Copy an existing Google Doc Risk: write

await corsair.googledocs.api.documents.copyDocument({});

Input

Name	Type	Required	Description
`fileId`	`string`	Yes	—
`name`	`string`	No	—
`parents`	`string[]`	No	—

Output

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`mimeType`	`string`	No	—
`parents`	`string[]`	No	—
`trashed`	`boolean`	No	—
`createdTime`	`string`	No	—
`modifiedTime`	`string`	No	—
`webViewLink`	`string`	No	—
`size`	`string`	No	—
`owners`	`any[]`	No	—

createBlankDocument

documents.createBlankDocument Create a blank Google Doc [DEPRECATED: prefer documents.createDocument] Risk: write

await corsair.googledocs.api.documents.createBlankDocument({});

Input

Name	Type	Required	Description
`title`	`string`	Yes	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`title`	`string`	No	—
`revisionId`	`string`	No	—
`body`	`any`	No	—
`headers`	`any`	No	—
`footers`	`any`	No	—
`footnotes`	`any`	No	—
`inlineObjects`	`any`	No	—
`positionedObjects`	`any`	No	—
`namedRanges`	`any`	No	—
`lists`	`any`	No	—
`documentStyle`	`any`	No	—
`suggestionsViewMode`	`string`	No	—

createDocument

documents.createDocument Create a Google Doc with an optional title and initial text Risk: write

await corsair.googledocs.api.documents.createDocument({});

Input

Name	Type	Required	Description
`title`	`string`	Yes	—
`text`	`string`	No	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`title`	`string`	No	—
`revisionId`	`string`	No	—
`body`	`any`	No	—
`headers`	`any`	No	—
`footers`	`any`	No	—
`footnotes`	`any`	No	—
`inlineObjects`	`any`	No	—
`positionedObjects`	`any`	No	—
`namedRanges`	`any`	No	—
`lists`	`any`	No	—
`documentStyle`	`any`	No	—
`suggestionsViewMode`	`string`	No	—

createDocumentMarkdown

documents.createDocumentMarkdown Create a Google Doc initialized from Markdown text Risk: write

await corsair.googledocs.api.documents.createDocumentMarkdown({});

Input

Name	Type	Required	Description
`title`	`string`	No	—
`markdown`	`string`	Yes	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`title`	`string`	No	—
`revisionId`	`string`	No	—
`body`	`any`	No	—
`headers`	`any`	No	—
`footers`	`any`	No	—
`footnotes`	`any`	No	—
`inlineObjects`	`any`	No	—
`positionedObjects`	`any`	No	—
`namedRanges`	`any`	No	—
`lists`	`any`	No	—
`documentStyle`	`any`	No	—
`suggestionsViewMode`	`string`	No	—

exportDocumentAsPdf

documents.exportDocumentAsPdf Export a Google Doc as PDF (Drive enforces a 10MB limit) Risk: read

await corsair.googledocs.api.documents.exportDocumentAsPdf({});

Input

Name	Type	Required	Description
`fileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`fileId`	`string`	Yes	—
`mimeType`	`string`	Yes	—
`data`	`string`	Yes	—

getDocument

documents.getDocument Retrieve a Google Doc by id Risk: read

await corsair.googledocs.api.documents.getDocument({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`title`	`string`	No	—
`revisionId`	`string`	No	—
`body`	`any`	No	—
`headers`	`any`	No	—
`footers`	`any`	No	—
`footnotes`	`any`	No	—
`inlineObjects`	`any`	No	—
`positionedObjects`	`any`	No	—
`namedRanges`	`any`	No	—
`lists`	`any`	No	—
`documentStyle`	`any`	No	—
`suggestionsViewMode`	`string`	No	—

getDocumentPlaintext

documents.getDocumentPlaintext Retrieve a Google Doc as best-effort plain text Risk: read

await corsair.googledocs.api.documents.getDocumentPlaintext({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—

Output

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`title`	`string`	No	—
`text`	`string`	Yes	—
`wordCount`	`number`	Yes	—

listSpreadsheetCharts

documents.listSpreadsheetCharts List charts in a Google Sheets spreadsheet for embedding Risk: read

await corsair.googledocs.api.documents.listSpreadsheetCharts({});

Input

Name	Type	Required	Description
`spreadsheetId`	`string`	Yes	—

Output

Name	Type	Required	Description
`spreadsheetId`	`string`	No	—
`sheets`	`any[]`	No	—

searchDocuments

documents.searchDocuments Search Google Docs by name, content, or date filters Risk: read

await corsair.googledocs.api.documents.searchDocuments({});

Input

Name	Type	Required	Description
`q`	`string`	No	—
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`orderBy`	`string`	No	—

Output

Name	Type	Required	Description
`kind`	`string`	No	—
`nextPageToken`	`string`	No	—
`incompleteSearch`	`boolean`	No	—
`files`	`object[]`	No	—

files full type

{
  id?: string,
  name?: string,
  mimeType?: string,
  parents?: string[],
  trashed?: boolean,
  createdTime?: string,
  modifiedTime?: string,
  webViewLink?: string,
  size?: string,
  owners?: any[]
}[]

updateDocumentBatch

documents.updateDocumentBatch Apply batchUpdate edits [DEPRECATED: prefer documents.updateExistingDocument] Risk: write

await corsair.googledocs.api.documents.updateDocumentBatch({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`requests`	`object[]`	Yes	—
`writeControl`	`object`	No	—

requests full type

{
}[]

writeControl full type

{
}

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

updateDocumentMarkdown

documents.updateDocumentMarkdown Replace a Google Doc content with Markdown text Risk: write

await corsair.googledocs.api.documents.updateDocumentMarkdown({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`markdown`	`string`	Yes	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

updateDocumentSectionMarkdown

documents.updateDocumentSectionMarkdown Replace a section of a Google Doc with Markdown text Risk: write

await corsair.googledocs.api.documents.updateDocumentSectionMarkdown({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`markdown`	`string`	Yes	—
`startIndex`	`number`	Yes	—
`endIndex`	`number`	No	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

updateDocumentStyle

documents.updateDocumentStyle Update the page size, margins, and global document style Risk: write

await corsair.googledocs.api.documents.updateDocumentStyle({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`documentStyle`	`object`	Yes	—
`fields`	`string`	Yes	—

documentStyle full type

{
}

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

updateExistingDocument

documents.updateExistingDocument Apply batchUpdate edits (insert/delete/format) to a Google Doc Risk: write

await corsair.googledocs.api.documents.updateExistingDocument({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`requests`	`object[]`	Yes	—
`writeControl`	`object`	No	—

requests full type

{
}[]

writeControl full type

{
}

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

Structure

createFooter

structure.createFooter Create a footer Risk: write

await corsair.googledocs.api.structure.createFooter({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`type`	`DEFAULT \| FIRST_PAGE \| EVEN_PAGE`	No	—
`sectionBreakLocation`	`object`	No	—

sectionBreakLocation full type

{
  index: number,
  segmentId?: string,
  tabId?: string
}

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

createFootnote

structure.createFootnote Create a footnote Risk: write

await corsair.googledocs.api.structure.createFootnote({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`location`	`object`	No	—
`endOfSegmentLocation`	`object`	No	—

location full type

{
  index: number,
  segmentId?: string,
  tabId?: string
}

endOfSegmentLocation full type

{
  segmentId?: string,
  tabId?: string
}

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

createHeader

structure.createHeader Create a header Risk: write

await corsair.googledocs.api.structure.createHeader({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`type`	`DEFAULT \| FIRST_PAGE \| EVEN_PAGE`	No	—
`sectionBreakLocation`	`object`	No	—

sectionBreakLocation full type

{
  index: number,
  segmentId?: string,
  tabId?: string
}

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

createNamedRange

structure.createNamedRange Create a named range Risk: write

await corsair.googledocs.api.structure.createNamedRange({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`name`	`string`	Yes	—
`startIndex`	`number`	Yes	—
`endIndex`	`number`	Yes	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

createParagraphBullets

structure.createParagraphBullets Add bullets to a range of paragraphs Risk: write

await corsair.googledocs.api.structure.createParagraphBullets({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`startIndex`	`number`	Yes	—
`endIndex`	`number`	Yes	—
`bulletPreset`	`string`	No	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

deleteFooter

structure.deleteFooter Delete a footer Risk: destructive

await corsair.googledocs.api.structure.deleteFooter({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`footerId`	`string`	Yes	—
`type`	`DEFAULT \| FIRST_PAGE \| EVEN_PAGE`	No	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

deleteHeader

structure.deleteHeader Delete a header Risk: destructive

await corsair.googledocs.api.structure.deleteHeader({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`headerId`	`string`	Yes	—
`type`	`DEFAULT \| FIRST_PAGE \| EVEN_PAGE`	No	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

deleteNamedRange

structure.deleteNamedRange Delete a named range by id or name Risk: destructive

await corsair.googledocs.api.structure.deleteNamedRange({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`namedRangeId`	`string`	No	—
`name`	`string`	No	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

deleteParagraphBullets

structure.deleteParagraphBullets Remove bullets from a range of paragraphs Risk: write

await corsair.googledocs.api.structure.deleteParagraphBullets({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`startIndex`	`number`	Yes	—
`endIndex`	`number`	Yes	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

Tables

deleteTableColumn

tables.deleteTableColumn Delete a column from a table Risk: destructive

await corsair.googledocs.api.tables.deleteTableColumn({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`tableCellLocation`	`object`	Yes	—

tableCellLocation full type

{
  tableStartLocation: {
    index: number,
    segmentId?: string,
    tabId?: string
  },
  rowIndex: number,
  columnIndex: number
}

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

deleteTableRow

tables.deleteTableRow Delete a row from a table Risk: destructive

await corsair.googledocs.api.tables.deleteTableRow({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`tableCellLocation`	`object`	Yes	—

tableCellLocation full type

{
  tableStartLocation: {
    index: number,
    segmentId?: string,
    tabId?: string
  },
  rowIndex: number,
  columnIndex: number
}

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

insertTable

tables.insertTable Insert a table into a Google Doc Risk: write

await corsair.googledocs.api.tables.insertTable({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`rows`	`number`	Yes	—
`columns`	`number`	Yes	—
`insertionIndex`	`number`	No	—
`appendToEnd`	`boolean`	No	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

insertTableColumn

tables.insertTableColumn Insert a column into a table Risk: write

await corsair.googledocs.api.tables.insertTableColumn({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`tableCellLocation`	`object`	Yes	—
`insertRight`	`boolean`	No	—

tableCellLocation full type

{
  tableStartLocation: {
    index: number,
    segmentId?: string,
    tabId?: string
  },
  rowIndex: number,
  columnIndex: number
}

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

unmergeTableCells

tables.unmergeTableCells Unmerge previously merged table cells Risk: write

await corsair.googledocs.api.tables.unmergeTableCells({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`tableRange`	`object`	Yes	—

tableRange full type

{
  tableCellLocation: {
    tableStartLocation: {
      index: number,
      segmentId?: string,
      tabId?: string
    },
    rowIndex: number,
    columnIndex: number
  },
  rowSpan: number,
  columnSpan: number
}

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

updateTableRowStyle

tables.updateTableRowStyle Update the style of table rows Risk: write

await corsair.googledocs.api.tables.updateTableRowStyle({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`tableStartLocation`	`object`	Yes	—
`rowIndices`	`number[]`	Yes	—
`tableRowStyle`	`object`	No	—
`fields`	`string`	No	—

tableStartLocation full type

{
  index: number,
  segmentId?: string,
  tabId?: string
}

tableRowStyle full type

{
  minRowHeight?: {
    magnitude?: number,
    unit?: string
  },
  tableHeader?: boolean,
  preventOverflow?: boolean
}

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

Text

deleteContentRange

text.deleteContentRange Delete a content range from a Google Doc Risk: destructive

await corsair.googledocs.api.text.deleteContentRange({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`startIndex`	`number`	Yes	—
`endIndex`	`number`	Yes	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

insertInlineImage

text.insertInlineImage Insert an inline image from a URI into a Google Doc Risk: write

await corsair.googledocs.api.text.insertInlineImage({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`uri`	`string`	Yes	—
`insertionIndex`	`number`	No	—
`appendToEnd`	`boolean`	No	—
`size`	`object`	No	—

size full type

{
  height?: {
    magnitude?: number,
    unit?: string
  },
  width?: {
    magnitude?: number,
    unit?: string
  }
}

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

insertPageBreak

text.insertPageBreak Start a new page at a location in a Google Doc Risk: write

await corsair.googledocs.api.text.insertPageBreak({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`insertionIndex`	`number`	No	—
`appendToEnd`	`boolean`	No	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

insertText

text.insertText Insert text at a location or append to the end of a Google Doc Risk: write

await corsair.googledocs.api.text.insertText({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`text`	`string`	Yes	—
`insertionIndex`	`number`	No	—
`appendToEnd`	`boolean`	No	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

replaceAllText

text.replaceAllText Replace all occurrences of a string in a Google Doc Risk: write

await corsair.googledocs.api.text.replaceAllText({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`find`	`string`	Yes	—
`replace`	`string`	Yes	—
`matchCase`	`boolean`	No	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

replaceImage

text.replaceImage Replace an existing image in a Google Doc Risk: write

await corsair.googledocs.api.text.replaceImage({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`imageObjectId`	`string`	Yes	—
`uri`	`string`	Yes	—
`imageReplaceMethod`	`CENTER_CROP`	No	—

Output

Name	Type	Required	Description
`documentId`	`string`	No	—
`replies`	`object[]`	No	—
`writeControl`	`object`	No	—

replies full type

{
}[]

writeControl full type

{
  requiredRevisionId?: string,
  targetRevisionId?: string
}

​Documents

​copyDocument

​createBlankDocument

​createDocument

​createDocumentMarkdown

​exportDocumentAsPdf

​getDocument

​getDocumentPlaintext

​listSpreadsheetCharts

​searchDocuments

​updateDocumentBatch

​updateDocumentMarkdown

​updateDocumentSectionMarkdown

​updateDocumentStyle

​updateExistingDocument

​Structure

​createFooter

​createFootnote

​createHeader

​createNamedRange

​createParagraphBullets

​deleteFooter

​deleteHeader

​deleteNamedRange

​deleteParagraphBullets

​Tables

​deleteTableColumn

​deleteTableRow

​insertTable

​insertTableColumn

​unmergeTableCells

​updateTableRowStyle

​Text

​deleteContentRange

​insertInlineImage

​insertPageBreak

​insertText

​replaceAllText

​replaceImage

Documents

copyDocument

createBlankDocument

createDocument

createDocumentMarkdown

exportDocumentAsPdf

getDocument

getDocumentPlaintext

listSpreadsheetCharts

searchDocuments

updateDocumentBatch

updateDocumentMarkdown

updateDocumentSectionMarkdown

updateDocumentStyle

updateExistingDocument

Structure

createFooter

createFootnote

createHeader

createNamedRange

createParagraphBullets

deleteFooter

deleteHeader

deleteNamedRange

deleteParagraphBullets

Tables

deleteTableColumn

deleteTableRow

insertTable

insertTableColumn

unmergeTableCells

updateTableRowStyle

Text

deleteContentRange

insertInlineImage

insertPageBreak

insertText

replaceAllText

replaceImage